assert_is_symmetric_matrix

0th

Percentile

Is the input a symmetric matrix?

Checks that the input is a symmetric matrix.

Usage
assert_is_symmetric_matrix(x, tol = 100 * .Machine$double.eps, ...,
  severity = getOption("assertive.severity", "stop"))

is_symmetric_matrix(x, tol = 100 * .Machine$double.eps, .xname = get_name_in_parent(x), ...)

Arguments
x

Input to check.

tol

Differences smaller than tol are not considered.

...

Passed to all.equal.

severity

How severe should the consequences of the assertion be? Either "stop", "warning", "message", or "none".

.xname

Not intended to be used directly.

Value

TRUE if the input is symmetric (after coercion to be a matrix).

Aliases
  • assert_is_symmetric_matrix
  • is_symmetric_matrix
Examples
# NOT RUN {
m <- diag(3); m[3, 1] <- 1e-100
assert_is_symmetric_matrix(m)
#These examples should fail.
assertive.base::dont_stop(assert_is_symmetric_matrix(m, tol = 0))
# }
Documentation reproduced from package assertive.matrices, version 0.0-2, License: GPL (>= 3)

Community examples

Looks like there are no examples yet.