ndarray

Multidimensional arrays.

Installation

$ npm install @stdlib/ndarray

Usage

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

ns

ndarray namespace.

var o = ns;
// returns {...}

The namespace exports the following functions to create multidimensional arrays:

• array( [buffer,] [options] ): create a multidimensional array.
• ndarray( dtype, buffer, shape, strides, offset, order[, options] ): multidimensional array constructor.

The namespace contains the following sub-namespaces:

• base: base ndarray.

In addition, the namespace contaians the following multidimensional array utility functions:

• ndarrayCastingModes(): list of ndarray casting modes.
• ndarrayDataTypes(): list of ndarray data types.
• ind2sub( shape, idx[, options] ): convert a linear index to an array of subscripts.
• ndarrayIndexModes(): list of ndarray index modes.
• ndarrayMinDataType( value ): determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value.
• ndarrayNextDataType( [dtype] ): return the next larger ndarray data type of the same kind.
• ndarrayOrders(): list of ndarray orders.
• ndarrayPromotionRules( [dtype1, dtype2] ): return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be safely cast.
• ndarraySafeCasts( [dtype] ): return a list of ndarray data types to which a provided ndarray data type can be safely cast.
• ndarraySameKindCasts( [dtype] ): return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".
• sub2ind( shape, ...subscripts[, options] ): convert subscripts to a linear index.

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/ndarray' );

console.log( objectKeys( ns ) );

stdlib-js

---

This package is part of stdlib, a standard library for JavaScript and Node.js.

stdlib is 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 unit tests, benchmarks, and information on how to develop stdlib, see the main project repository.

---

License

See LICENSE.

Copyright

Copyright © 2016-2020. The Stdlib Authors.