matsbyname (version 0.6.11)

iszero_byname: Test whether this is the zero matrix

Description

Note that this function tests whether the elements of abs(a) are <= tol. The default value for tol is 1e-6. So, you can set tol = 0 to discover if a is EXACTLY the zero matrix.

Usage

iszero_byname(a, tol = 1e-06)

Value

TRUE Iff this is the zero matrix within tol.

Arguments

a

A matrix or list of matrices.

tol

The allowable deviation from 0 for any element. Interpreted as an absolute value.

Details

If a contains any NA values, NA is returned.

Examples

zero <- matrix(0, nrow = 50, ncol = 50)
iszero_byname(zero)
nonzero <- matrix(1:4, nrow = 2)
iszero_byname(nonzero)
# Also works for lists
iszero_byname(list(zero, nonzero))
# And it works for data frames
DF <- data.frame(A = I(list()), B = I(list()))
DF[[1,"A"]] <- zero
DF[[2,"A"]] <- nonzero
DF[[1,"B"]] <- nonzero
DF[[2,"B"]] <- zero
iszero_byname(DF$A)
iszero_byname(DF$B)
iszero_byname(matrix(1e-10, nrow = 2))
iszero_byname(matrix(1e-10, nrow = 2), tol = 1e-11)
# When any NA value is present, NA is returned
iszero_byname(NA)
iszero_byname(matrix(c(0, NA), ncol = 2))
iszero_byname(list(matrix(c(0, NA)), zero, nonzero))