time-to-botec/squiggle/node_modules/@stdlib/assert/is-vector-like
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

isVectorLike

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

Usage

var isVectorLike = require( '@stdlib/assert/is-vector-like' );

isVectorLike( value )

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

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

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

Examples

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

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

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

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

out = isVectorLike( null );
// returns false