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

isFloat64VectorLike

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

Usage

var isFloat64VectorLike = require( '@stdlib/assert/is-float64vector-like' );

isFloat64VectorLike( value )

Tests if a value is a 1-dimensional ndarray-like object whose underlying data type is float64.

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

var arr = ndarray( 'float64', new Float64Array( [ 0, 0, 0, 0 ] ), [ 4 ], [ 1 ], 0, 'row-major' );

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

Examples

var ndarray = require( '@stdlib/ndarray/ctor' );
var Float64Array = require( '@stdlib/array/float64' );
var isFloat64VectorLike = require( '@stdlib/assert/is-float64vector-like' );

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

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

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

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

out = isFloat64VectorLike( null );
// returns false