time-to-botec/js/node_modules/@stdlib/assert/is-float32matrix-like/README.md

isFloat32MatrixLike

Test if a value is a 2-dimensional ndarray-like object containing single-precision floating-point numbers.

Usage

var isFloat32MatrixLike = require( '@stdlib/assert/is-float32matrix-like' );

isFloat32MatrixLike( value )

Tests if a value is a 2-dimensional ndarray-like object whose underlying data type is float32.

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

var arr = ndarray( 'float32', new Float32Array( [ 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );

var bool = isFloat32MatrixLike( arr );
// returns true

Examples

var ndarray = require( '@stdlib/ndarray/ctor' );
var Float32Array = require( '@stdlib/array/float32' );
var isFloat32MatrixLike = require( '@stdlib/assert/is-float32matrix-like' );

var buffer = new Float32Array( [ 0, 0, 0, 0 ] );
var arr = ndarray( 'float32', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );

var out = isFloat32MatrixLike( arr );
// returns true

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

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

out = isFloat32MatrixLike( null );
// returns false