assert_is_square_matrix {assertive.matrices}R Documentation

Is the matrix a square matrix?

Description

Checks that the input is a square matrix.

Usage

assert_is_square_matrix(x, severity = getOption("assertive.severity",
  "stop"))

is_square_matrix(x, .xname = get_name_in_parent(x))

Arguments

x

Input to check.

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 all zeroes (after coercion to be a matrix).

Examples

is_square_matrix(matrix(1:9, nrow = 3))
is_square_matrix(matrix(1:12, nrow = 3))
[Package assertive.matrices version 0.0-2 Index]