Type Cast Indices

These functions typecast indices to proper integer indices.

Usage

tci_bool(indx, n, inv = FALSE, .abortcall = sys.call())

tci_int(indx, n, inv = FALSE, chkdup = FALSE, .abortcall = sys.call())

tci_chr(
  indx,
  nms,
  inv = FALSE,
  chkdup = FALSE,
  uniquely_named = FALSE,
  .abortcall = sys.call()
)

tci_cplx(indx, n, inv = FALSE, chkdup = FALSE, .abortcall = sys.call())

Arguments

indx

the indices to typecast

n

the relevant size, when typecasting integer or logical indices.
Examples:

• If the target is row indices, input nrow for n.

• If the target is flat indices, input the length for n.

inv

Boolean, indicating if the indices should be inverted.
See squarebrackets_indx_args.

.abortcall

environment where the error message is passed to.

chkdup

see squarebrackets_options.

nms

the relevant names, when typecasting character indices.
Examples:

• If the target is row indices, input row names for nms.

• If the target is flat indices, input flat names for nms.

uniquely_named

Boolean, indicating if the user knows a-priori that the relevant names of x are unique.
If set to TRUE, speed may increase.
But specifying TRUE when the relevant names are not unique will result in incorrect output.

Value

An integer vector of type-cast indices.

Examples

x <- matrix(1:25, 5, 5)
colnames(x) <- c("a", "a", "b", "c", "d")
print(x)
#>      a  a  b  c  d
#> [1,] 1  6 11 16 21
#> [2,] 2  7 12 17 22
#> [3,] 3  8 13 18 23
#> [4,] 4  9 14 19 24
#> [5,] 5 10 15 20 25

bool <- sample(c(TRUE, FALSE), 5, TRUE)
int <- 1:4
chr <- c("a", "a")
cplx <- 1:4 * -1i
tci_bool(bool, nrow(x))
#> [1] 1 2 3 4 5
tci_int(int, ncol(x), inv = TRUE)
#> [1] 5
tci_chr(chr, colnames(x))
#> [1] 1 2 1 2
tci_cplx(cplx, nrow(x))
#> [1] 5 4 3 2

ci_flat(x, 1:10 * -1i)
#>  [1] 25 24 23 22 21 20 19 18 17 16
ci_margin(x, 1:4, 2)
#> [1] 1 2 3 4
ci_sub(x, n(1:5 * -1i, 1:4), 1:2)
#> [[1]]
#> [1] 5 4 3 2 1
#> 
#> [[2]]
#> [1] 1 2 3 4
#>