validateIndices {matrixStats}R Documentation

Validate indices

Description

Computes validated positive indices from given indices.

Usage

validateIndices(idxs = NULL, maxIdx, allowOutOfBound = TRUE)

Arguments

idxs

A vector indicating subset of elements to operate over. If NULL, no subsetting is done.

maxIdx

The possible max index.

allowOutOfBound

Allow positive out of bound to indicate NA.

Value

Returns a validated integers list indicating the indices. If some of the indices cannot be represented as an integer, the indices are returned as doubles.

Examples

idxs <- validateIndices(c(-4, 0, -3, -1), 5)  # [2, 5]

idxs <- validateIndices(c(4, 4, 8, 2, 3), 8)  # [4, 4, 8, 2, 3]

[Package matrixStats version 0.62.0 Index]