MatrixCheck: Check Matrix Properties

In jeksterslab/matrixR: Matrix/Linear Algebra

Description

Checks matrix properties and stops if any test fails. Returns the matrix if all tests succeed.

Usage

MatrixCheck(
  A,
  IsSquareMatrix = FALSE,
  IsSymmetric = FALSE,
  IsNilpotent = FALSE,
  ...
)

## Default S3 method:
MatrixCheck(
  A,
  IsSquareMatrix = FALSE,
  IsSymmetric = FALSE,
  IsNilpotent = FALSE,
  ...
)

## S3 method for class 'yac_symbol'
MatrixCheck(
  A,
  IsSquareMatrix = FALSE,
  IsSymmetric = FALSE,
  IsNilpotent = FALSE,
  ...
)

Arguments

A	Input.
IsSquareMatrix	Logical. Test if input is a square matrix.
IsSymmetric	Logical. Test if input is a symmetric matrix.
IsNilpotent	Logical. Test if input is a nilponent matrix.
...	...

Author(s)

Ivan Jacob Agaloos Pesigan

See Also

Other predicate functions: IsDiagonal(), IsIdempotent(), IsInvertible(), IsMatrix(), IsNilpotent(), IsOrthogonal(), IsPositiveDefinite(), IsScalar(), IsSingular(), IsSquareMatrix(), IsSymmetric(), IsVector()

jeksterslab/matrixR documentation built on Feb. 22, 2021, 8:10 a.m.