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

isFloat32VectorLike

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

Usage

var isFloat32VectorLike = require( '@stdlib/assert/is-float32vector-like' );

isFloat32VectorLike( value )

Tests if a value is a 1-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 ] ), [ 4 ], [ 1 ], 0, 'row-major' );

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

Examples

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

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

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

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

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

out = isFloat32VectorLike( null );
// returns false