@stdlib/assert-is-ndarray-like NPM

isndarrayLike

Test if a value is ndarray-like.

Installation

npm install @stdlib/assert-is-ndarray-like

Usage

var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' );

isndarrayLike( value )

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 true

A value is ndarray-like if a value is an object with the following properties:

dtype: string specifying a data type.
data: object pointing to an underlying data buffer.
shape: array-like object containing dimensions.
strides: array-like object containing stride lengths.
offset: number specifying the index offset.
order: string describing the memory layout.
ndims: number specifying the number of dimensions.
length: number specifying the total number of elements.
flags: object containing meta data.
get: function for retrieving elements.
set: function for setting elements.

Examples

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.