valid: Validity methods

In jordan: A Suite of Routines for Working with Jordan Algebras

Validity methods

Description

Validity methods, to check that objects are well-formed

Usage

valid_rsm(object)
valid_chm(object)
valid_qhm(object)
valid_albert(object)
is_ok_rsm(r)
is_ok_chm(r)
is_ok_qhm(r)
is_ok_albert(r)
is_ok_rsm(r)

Arguments

object	Putative jordan object
r	Integer, number of rows in putative jordan object

Details

Validity methods. The validity_foo() functions test for an object to be the right type, and the is_ok_foo() functions test the number of rows being appropriate for a jordan object of some type; these functions return an error if not appropriate, or, for jordan_matrix objects, the size of the matrix worked with.

Value

Return a Boolean

Author(s)

Robin K. S. Hankin

Examples

 is_ok_qhm(45)   # 5x5 Hermitian quaternionic matrices
#is_ok_qhm(46)   # FALSE

jordan documentation built on July 4, 2024, 5:06 p.m.