sss_prop_funs: Shape properties

In j-martineau/uj: Utilities by JAM

Shape properties

Description

Shape properties are defined as follows:

⁠'emp', 'EMP'⁠	empty	of length 0 (but not NULL)
⁠'pnt', 'PNT'⁠	point	of length 1^{(1)}
⁠'col', 'COL'⁠	column	⁠1 × 2+⁠ matrix/data.frame
⁠'row', 'ROW'⁠	row	⁠2+ × 1⁠ matrix/data.frame
⁠'lin', 'LIN'⁠	linear	⁠2+⁠ positions in 1 dimension^{(2)}
⁠'rct', 'RCT'⁠	rect	⁠2+⁠ positions in 2 dimensions
⁠'sqr', 'SQR'⁠	square	⁠N × N⁠ matrix where ⁠N ≥ 2⁠
⁠'sld', 'SLD'⁠	solid	⁠2+⁠ positions in ⁠3+⁠ dimensions

^{(1)} Includes ⁠1x1⁠ data.frames.

^{(2)} Length-⁠2+⁠ vectors, arrays of ⁠2+⁠ positions in 1 dimension, row/column data.frames.

Usage

sss_prop_funs()

sss(x)

sss_props()

sss_funs()

is_sss_spec(spec)

SSS(x, spec, ...)

COL(x, ...)

EMP(x, ...)

LIN(x, ...)

PNT(x, ...)

RCT(x, ...)

ROW(x, ...)

SLD(x, ...)

SQR(x, ...)

Arguments

x	An R object.
spec	Either NULL or a complete character vec containing one or more shape properties (i.e., from sss_funs()). Shape properties in spec may be pipe-delimited. If there are multiple shape properties in spec, x is inspected for any match to any shape property in spec.
...	Arguments passed on to meets

Functions

• sss(): Lists all shape properties possessed by x. Returns a sorted, lowercase, character vector.

• sss_props(): Lists all possible shape properties. Returns a sorted, lowercase, character vector

• sss_funs(): Lists all possible shape-property-checking functions. Returns a sorted, uppercase, character vector.

• is_sss_spec(): Checks whether spec is a shape property spec. Returns a logical scalar. See ppp for the definition of a property spec.

• SSS(): Checks x against the shape property spec spec. Returns a logical scalar. See ppp for the definition of a property spec.

• COL(): Checks x against the column shape property subject to any count or value restrictions in .... Returns a logical scalar.

• EMP(): Checks x against the empty shape property subject to any count or value restrictions in .... Returns a logical scalar.

• LIN(): Checks x against the linear shape property subject to any count or value restrictions in .... Returns a logical scalar.

• PNT(): Checks x against the point shape property subject to any count or value restrictions in .... Returns a logical scalar.

• RCT(): Checks x against the rectangle shape property subject to any count or value restrictions in .... Returns a logical scalar.

• ROW(): Checks x against the row shape property subject to any count or value restrictions in .... Returns a logical scalar.

• SLD(): Checks x against the solid shape property subject to any count or value restrictions in .... Returns a logical scalar.

• SQR(): Checks x against the square shape property subject to any count or value restrictions in .... Returns a logical scalar.

Specifying count and value restrictions

Specifying restrictions in ... is optional. The full set of recognized arguments names are defined in the following table along with the properties each specifies:

⁠.max, .maxr, .maxc⁠	Scalar maximum valid numbers of elements, rows, and columns, respectively.
⁠.min, .minr, .minc⁠	Scalar minimum valid numbers of elements, rows, and columns, respectively.
⁠.lt, .le, .ge, .gt⁠	Complete sortable scalar less-than, less-than-or-equal, greater-than-or-equal, and greater-than bounds, respectively.
⁠.n, .nr, .nc⁠	A vector of valid numbers of elements, rows, and columns, respectively.
.vals	A vector of valid values.

See Also

Other properties: as_mmm(), bbb_ccc_help(), bbb_help(), bbb_mmm_prop_funs(), ccc_help(), cls(), cmp_ccc_help(), cmp_mmm_ccc_help(), cmp_mmm_help(), compatible(), ddd_prop_funs(), eee_help(), iii_help(), meets(), mmm_ccc_help(), mmm_help(), ppp_fast_help(), ppp_help(), sss_ccc_help(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

Examples

Cl1 <- data.frame(letters = letters)
Cl2 <- matrix(1:10)
Emp <- vector()
Ln1 <- letters
Ln2 <- Cl1
Pt1 <- 1
Pt2 <- data.frame(letters = "a")
Rc1 <- data.frame(letters = letters, numbers = 1:26)
Rc2 <- matrix(1:10, nrow = 2)
Rw1 <- data.frame(a = "a", b = 1)
Rw2 <- matrix(1:10, nrow = 1)
Sld <- array(1:27, dim = c(3, 3, 3))
Sqr <- matrix(1:9, nrow = 3)
sss_funs()
sss_funs()
is_sss_spec("emp|pnt")
sss(Cl1)
sss(Sqr)
c(SSS(Cl1, "col"), SSS(Rw1, "col"))
c(COL(Cl1), COL(Rw1))
c(COL(Cl2), COL(Rw2))
c(EMP(Emp), EMP(Ln1))
c(LIN(Ln1), LIN(Pt1))
c(LIN(Ln2), LIN(Rc1))
c(PNT(Pt1), PNT(Rc1))
c(PNT(Pt2), PNT(Rw1))
c(RCT(Rc1), RCT(Pt1))
c(RCT(Rc2), RCT(Ln1))
c(ROW(Rw1), ROW(Cl1))
c(ROW(Rw2), ROW(Rc1))
c(SLD(Sld), SLD(Rc1))
c(SQR(Sqr), SQR(Pt1))

j-martineau/uj documentation built on Sept. 14, 2024, 4:40 a.m.