Base

Base ndarray.

Usage

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

ns

Base ndarray.

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

• bind2vind( shape, strides, offset, order, idx, mode ): convert a linear index in an underlying data buffer to a linear index in an array view.
• bufferCtors( dtype ): ndarray data buffer constructors.
• bufferDataType( buffer ): return the data type of an ndarray data buffer.
• buffer( dtype, size ): create a zero-filled contiguous linear ndarray data buffer.
• bytesPerElement( dtype ): return the number of bytes per element provided an underlying array data type.
• clampIndex( idx, max ): restrict an index to the interval [0,max].
• ndarray( dtype, ndims[, options] ): create a multidimensional array constructor.
• dtypeChar( dtype ): return the single letter abbreviation for an underlying array data type.
• ind( idx, max, mode ): return an index given an index mode.
• ind2sub( [out,] shape, strides, offset, order, idx, mode ): convert a linear index to an array of subscripts.
• iterationOrder( strides ): given a stride array, determine array iteration order.
• maxViewBufferIndex( shape, strides, offset ): compute the maximum linear index in an underlying data buffer accessible to an array view.
• ndarrayMemoized( dtype, ndims[, options] ): create a memoized multidimensional array constructor.
• minViewBufferIndex( shape, strides, offset ): compute the minimum linear index in an underlying data buffer accessible to an array view.
• minmaxViewBufferIndex( [out,] shape, strides, offset ): compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.
• numel( shape ): return the number of elements in an array.
• shape2strides( [out,] shape, order ): generate a stride array from an array shape.
• strides2offset( shape, strides ): determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array.
• strides2order( strides ): determine the order of a multidimensional array based on a provided stride array.
• sub2ind( shape, strides, offset, ...subscripts, mode ): convert subscripts to a linear index.
• ndarray2array( buffer, shape, strides, offset, order ): convert an ndarray buffer to a generic array.
• vind2bind( shape, strides, offset, order, idx, mode ): convert a linear index in an array view to a linear index in an underlying data buffer.
• wrapIndex( idx, max ): wrap an index on the interval [0,max].

The namespace contains the following sub-namespaces:

• assert: base ndarray assertion utilities.

Examples

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

console.log( objectKeys( ns ) );