Test if a value is ndarray-like.
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );Tests if a value is ndarray-like.
var ndarray = require( '@stdlib/ndarray/ctor' );
var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var bool = isndarrayLike( arr );
// returns trueA value is ndarray-like if a value is an object with the following properties:
- dtype:
stringspecifying a data type. - data:
objectpointing to an underlying data buffer. - shape: array-like
objectcontaining dimensions. - strides: array-like
objectcontaining stride lengths. - offset:
numberspecifying the index offset. - order:
stringdescribing the memory layout. - ndims:
numberspecifying the number of dimensions. - length:
numberspecifying the total number of elements. - flags:
objectcontaining meta data. - get:
functionfor retrieving elements. - set:
functionfor setting elements.
var ndarray = require( '@stdlib/ndarray/ctor' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
var bool = isndarrayLike( arr );
// returns true
bool = isndarrayLike( [ 1, 2, 3, 4 ] );
// returns false
bool = isndarrayLike( {} );
// returns false
bool = isndarrayLike( null );
// returns false@stdlib/assert/is-array: test if a value is an array.@stdlib/assert/is-array-like: test if a value is array-like.@stdlib/assert/is-matrix-like: test if a value is a 2-dimensional ndarray-like object.@stdlib/assert/is-typed-array-like: test if a value is typed-array-like.@stdlib/assert/is-vector-like: test if a value is a 1-dimensional ndarray-like object.