12 KiB
12 KiB
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.broadcastArray( arr, shape ): broadcast an ndarray to a specified shape.broadcastShapes( shapes ): broadcast array shapes to a single shape.bufferCtors( dtype ): ndarray data buffer constructors.bufferDataTypeEnum( buffer ): return the data type enumeration constant of an ndarray data buffer.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, buffer, shape, strides, offset, order ): create a multidimensional array.dtypeChar( dtype ): return the single letter abbreviation for an underlying array data type.dtypes2signatures( dtypes, nin, nout ): transform a list of array argument data types into a list of signatures.ind( idx, max, mode ): return an index given an index mode.ind2sub( 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.minViewBufferIndex( shape, strides, offset ): compute the minimum linear index in an underlying data buffer accessible to an array view.minmaxViewBufferIndex( shape, strides, offset ): compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.nonsingletonDimensions( shape ): return the number of non-singleton dimensions.numel( shape ): return the number of elements in an array.serializeMetaData( x ): serialize ndarray meta data.shape2strides( shape, order ): generate a stride array from an array shape.singletonDimensions( shape ): return the number of singleton dimensions.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 ) );