time-to-botec/squiggle/node_modules/@stdlib/assert/is-nonsymmetric-matrix/README.md

isNonSymmetricMatrix

Test if a value is a non-symmetric matrix.

Usage

var isNonSymmetricMatrix = require( '@stdlib/assert/is-nonsymmetric-matrix' );

isNonSymmetricMatrix( value )

Tests if a value is a non-symmetric matrix.

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

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

Examples

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

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

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

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

out = isNonSymmetricMatrix( null );
// returns false