ddd_prop_funs: Defined Dimensionality Droperties

In j-martineau/uj: Utilities by JAM

Defined Dimensionality Droperties

Description

An object's defined dimensionality is the number of dimensions on which its elements can be indexed. The associated property values are:

⁠'d0d', 'D0D'⁠	⁠0D⁠	The NULL object.
⁠'d1d', 'D1D'⁠	⁠1D⁠	Vectors, vlists, ⁠1D⁠ arrays.
⁠'d2d', 'D2D'⁠	⁠2D⁠	Data.frames and matrices.
⁠'dhd', 'DHD'⁠	HD	Hyper-dimensional arrays (of 3+ dimensions).

Usage

ddd_prop_funs()

ddd(x)

ddd_funs()

ddd_props()

is_ddd_spec(spec)

DDD(x, spec, ...)

D0D(x, ...)

D1D(x, ...)

D2D(x, ...)

DHD(x, ...)

nddd(x)

Arguments

x	An R object.
spec	NULL or a complete character vec containing one or more defined.D properties from ddd_props(). Defined.D properties may be pipe-delimited. If there are multiple properties in spec, x is inspected for a Match to any of the specified properties.
...	Arguments passed on to meets

Value

A character vector

⁠ddd_props, ddd_funs, ddd⁠

A logical scalar

⁠is_ddd_spec, DDD, {DDD}⁠

A numeric scalar

nddd

Functions

• ddd(): Lists all defined dimensionality properties possessed by x. Returns a lowercase character scalar.

• ddd_funs(): Lists all defined dimensionality property checking functions. Returns a sorted, uppercase, character vector.

• ddd_props(): Lists all defined dimensionality properties. Returns a sorted, lowercase, character vector.

• is_ddd_spec(): Checks whether spec is a defined-dimensionality property spec. Returns a logical scalar. See ppp for a definition of a property spec.

• DDD(): Checks whether spec is a defined-dimensionality property spec subject to any count or value restrictions in .... Returns a logical scalar. See ppp for a definition of a property spec.

• D0D(): Checks x for zero defined dimensions subject to any count or value restrictions in .... Returns a logical scalar.

• D1D(): Checks x for one defined dimensions subject to any count or value restrictions in .... Returns a logical scalar.

• D2D(): Checks x for two defined dimensions subject to any count or value restrictions in .... Returns a logical scalar.

• DHD(): Checks x for three or more defined dimensions subject to any count or value restrictions in .... Returns a logical scalar.

• nddd(): Gets the defined dimensionality of x. Returns a non-negative integer 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(), eee_help(), iii_help(), meets(), mmm_ccc_help(), mmm_help(), ppp_fast_help(), ppp_help(), sss_ccc_help(), sss_prop_funs(), unq_ccc_prop_funs(), unq_mmm_ccc_help(), unq_mmm_help()

Examples

ddd_funs()
ddd_props()
is_ddd_spec("d1D|d2D")
nddd(matrix(1))
nddd(letters)
nddd(1)
DDD(data.frame(letters), "d2d|dhd")
D0D(NULL)
D1D(NULL)
ddd(letters)

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