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

isMatrixLike

Test if a value is 2-dimensional ndarray-like object.

Usage

var isMatrixLike = require( '@stdlib/assert/is-matrix-like' );

isMatrixLike( value )

Tests if a value is a 2-dimensional ndarray-like object.

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

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

Examples

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

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

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

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

out = isMatrixLike( null );
// returns false