diff --git a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts index 3f1331db4d49..4be2771201ff 100644 --- a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts @@ -137,6 +137,7 @@ import nullsLike = require( '@stdlib/ndarray/base/nulls-like' ); import numel = require( '@stdlib/ndarray/base/numel' ); import numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); import offset = require( '@stdlib/ndarray/base/offset' ); +import offsets = require( '@stdlib/ndarray/base/offsets' ); import ones = require( '@stdlib/ndarray/base/ones' ); import onesLike = require( '@stdlib/ndarray/base/ones-like' ); import order = require( '@stdlib/ndarray/base/order' ); @@ -166,6 +167,7 @@ import rot180 = require( '@stdlib/ndarray/base/rot180' ); import rotl90 = require( '@stdlib/ndarray/base/rotl90' ); import rotr90 = require( '@stdlib/ndarray/base/rotr90' ); import serializeMetaData = require( '@stdlib/ndarray/base/serialize-meta-data' ); +import setDescriptorOffsets = require( '@stdlib/ndarray/base/set-descriptor-offsets' ); import shape = require( '@stdlib/ndarray/base/shape' ); import shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); import shift = require( '@stdlib/ndarray/base/shift' ); @@ -3593,6 +3595,22 @@ interface Namespace { */ offset: typeof offset; + /** + * Returns the index offset specifying the underlying buffer index of the first iterated element for each ndarray in a provided list of ndarrays. + * + * @param arrays - list of ndarrays + * @returns index offsets + * + * @example + * var zeros = require( '@stdlib/ndarray/zeros' ); + * + * var x = zeros( [ 3, 3, 3 ] ); + * + * var out = ns.offsets( [ x ] ); + * // returns [ 0 ] + */ + offsets: typeof offsets; + /** * Creates a ones-filled ndarray having a specified shape and data type. * @@ -4367,6 +4385,43 @@ interface Namespace { */ serializeMetaData: typeof serializeMetaData; + /** + * Sets ndarray descriptor index offsets. + * + * ## Notes + * + * - This function mutates the provided descriptors. + * + * @param descriptors - list of ndarray descriptors + * @param offsets - list of index offsets + * @returns input array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var getOffset = require( '@stdlib/ndarray/base/offset' ); + * var ndarraylike2descriptor = require( '@stdlib/ndarray/base/ndarraylike2descriptor' ); + * + * var obj = ndarraylike2descriptor({ + * 'dtype': 'float64', + * 'data': new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ), + * 'shape': [ 1 ], + * 'strides': [ 1 ], + * 'offset': 0, + * 'order': 'row-major' + * }); + * + * var arr = [ obj ]; + * var out = ns.setDescriptorOffsets( arr, [ 2 ] ); + * // returns [...] + * + * var bool = ( out === arr ); + * // returns true + * + * var offset = getOffset( arr[ 0 ] ); + * // returns 2 + */ + setDescriptorOffsets: typeof setDescriptorOffsets; + /** * Returns the shape of a provided ndarray. *