time-to-botec/js/node_modules/@stdlib/assert/is-persymmetric-matrix/README.md

isPersymmetricMatrix

Test if a value is a persymmetric matrix.

Usage

var isPersymmetricMatrix = require( '@stdlib/assert/is-persymmetric-matrix' );

isPersymmetricMatrix( value )

Tests if a value is a persymmetric matrix.

var ndarray = require( '@stdlib/ndarray/ctor' );

var arr = ndarray( 'generic', [ 1, 2, 3, 1 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var bool = isPersymmetricMatrix( arr );
// returns true

Examples

var ndarray = require( '@stdlib/ndarray/ctor' );
var isPersymmetricMatrix = require( '@stdlib/assert/is-persymmetric-matrix' );

var arr = ndarray( 'generic', [ 1, 2, 3, 1 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var out = isPersymmetricMatrix( arr );
// returns true

out = isPersymmetricMatrix( [ 1, 2, 3, 4 ] );
// returns false

out = isPersymmetricMatrix( {} );
// returns false

out = isPersymmetricMatrix( null );
// returns false