is_identity_matrix: Check if the passed entity is an identity matrix

In AstraZeneca/qscheck: qscheck

Check if the passed entity is an identity matrix

Description

Check if the passed entity is an identity matrix

Usage

is_identity_matrix(
  value,
  exact_dimension = NULL,
  allow_null = FALSE,
  tol = sqrt(.Machine$double.eps)
)

Arguments

value	the value to check
exact_dimension	If specified, the matrix must have the specified exact dimension
allow_null	If TRUE, allow NULL as a value

Examples

## Not run: 
# For assertion
assertthat::assert_that(qscheck::is_identity_matrix(value))
# For check
if (qscheck::is_identity_matrix(value)) {}

## End(Not run)

AstraZeneca/qscheck documentation built on Nov. 1, 2023, 4:45 a.m.