@stdlib/assert-is-ndarray-like
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isndarrayLike

NPM version Build Status Coverage Status

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

See Also


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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

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

Homepage

stdlib.io

Weekly Downloads

2,230

Version

0.2.2

License

Apache-2.0

Unpacked Size

28.5 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser