feat: add nditerIndices to namespace

Author: kgryte

lib/node_modules/@stdlib/namespace/alias2pkg/data/data.csv

@@ -2288,6 +2288,7 @@ ndempty,"@stdlib/ndarray/empty"
 ndemptyLike,"@stdlib/ndarray/empty-like"
 nditer2arrayEach,"@stdlib/ndarray/iter/to-array-each"
 nditerColumns,"@stdlib/ndarray/iter/columns"
+nditerIndices,"@stdlib/ndarray/iter/indices"
 nditerRows,"@stdlib/ndarray/iter/rows"
 ndslice,"@stdlib/ndarray/slice"
 ndsliceAssign,"@stdlib/ndarray/slice-assign"

lib/node_modules/@stdlib/namespace/alias2pkg/data/data.json

@@ -2288,6 +2288,7 @@ ndempty,"ndemptyLike,ndzeros"
 ndemptyLike,"ndempty,ndzerosLike"
 nditer2arrayEach,"ndarray,ndarray2array"
 nditerColumns,"nditerRows,ndslice"
+nditerIndices,"ndarray"
 nditerRows,"nditerColumns,ndslice"
 ndslice,"array,ndarray,ndsliceAssign"
 ndsliceAssign,"array,ndarray,ndslice"

lib/node_modules/@stdlib/namespace/alias2related/data/data.csv

@@ -2288,6 +2288,7 @@ ndempty,"@stdlib/ndarray-empty"
 ndemptyLike,"@stdlib/ndarray-empty-like"
 nditer2arrayEach,"@stdlib/ndarray-iter-to-array-each"
 nditerColumns,"@stdlib/ndarray-iter-columns"
+nditerIndices,"@stdlib/ndarray-iter-indices"
 nditerRows,"@stdlib/ndarray-iter-rows"
 ndslice,"@stdlib/ndarray-slice"
 ndsliceAssign,"@stdlib/ndarray-slice-assign"

lib/node_modules/@stdlib/namespace/alias2related/data/data.json

@@ -2288,6 +2288,7 @@ ndempty
 ndemptyLike
 nditer2arrayEach
 nditerColumns
+nditerIndices
 nditerRows
 ndslice
 ndsliceAssign

lib/node_modules/@stdlib/namespace/alias2standalone/data/data.csv

@@ -248,6 +248,16 @@ ns.push({
 	]
 });
 
+ns.push({
+	'alias': 'nditerIndices',
+	'path': '@stdlib/ndarray/iter/indices',
+	'value': require( '@stdlib/ndarray/iter/indices' ),
+	'type': 'Function',
+	'related': [
+		'@stdlib/ndarray/ctor'
+	]
+});
+
 ns.push({
 	'alias': 'nditerRows',
 	'path': '@stdlib/ndarray/iter/rows',

lib/node_modules/@stdlib/namespace/alias2standalone/data/data.json

@@ -2288,6 +2288,7 @@
 "@stdlib/ndarray/empty-like",ndemptyLike
 "@stdlib/ndarray/iter/to-array-each",nditer2arrayEach
 "@stdlib/ndarray/iter/columns",nditerColumns
+"@stdlib/ndarray/iter/indices",nditerIndices
 "@stdlib/ndarray/iter/rows",nditerRows
 "@stdlib/ndarray/slice",ndslice
 "@stdlib/ndarray/slice-assign",ndsliceAssign

lib/node_modules/@stdlib/namespace/aliases/data/data.json

@@ -2288,6 +2288,7 @@
 "@stdlib/ndarray/empty-like","@stdlib/ndarray/empty,@stdlib/ndarray/zeros-like"
 "@stdlib/ndarray/iter/to-array-each","@stdlib/ndarray/ctor,@stdlib/ndarray/to-array"
 "@stdlib/ndarray/iter/columns","@stdlib/ndarray/iter/rows,@stdlib/ndarray/slice"
+"@stdlib/ndarray/iter/indices","@stdlib/ndarray/ctor"
 "@stdlib/ndarray/iter/rows","@stdlib/ndarray/iter/columns,@stdlib/ndarray/slice"
 "@stdlib/ndarray/slice","@stdlib/ndarray/array,@stdlib/ndarray/ctor,@stdlib/ndarray/slice-assign"
 "@stdlib/ndarray/slice-assign","@stdlib/ndarray/array,@stdlib/ndarray/ctor,@stdlib/ndarray/slice"

lib/node_modules/@stdlib/namespace/aliases/data/data.txt

@@ -2288,6 +2288,7 @@
 "@stdlib/ndarray/empty-like","@stdlib/ndarray-empty-like"
 "@stdlib/ndarray/iter/to-array-each","@stdlib/ndarray-iter-to-array-each"
 "@stdlib/ndarray/iter/columns","@stdlib/ndarray-iter-columns"
+"@stdlib/ndarray/iter/indices","@stdlib/ndarray-iter-indices"
 "@stdlib/ndarray/iter/rows","@stdlib/ndarray-iter-rows"
 "@stdlib/ndarray/slice","@stdlib/ndarray-slice"
 "@stdlib/ndarray/slice-assign","@stdlib/ndarray-slice-assign"

lib/node_modules/@stdlib/namespace/lib/namespace/n.js

@@ -2288,6 +2288,7 @@
 "@stdlib/ndarray-empty-like","@stdlib/ndarray/empty-like"
 "@stdlib/ndarray-iter-to-array-each","@stdlib/ndarray/iter/to-array-each"
 "@stdlib/ndarray-iter-columns","@stdlib/ndarray/iter/columns"
+"@stdlib/ndarray-iter-indices","@stdlib/ndarray/iter/indices"
 "@stdlib/ndarray-iter-rows","@stdlib/ndarray/iter/rows"
 "@stdlib/ndarray-slice","@stdlib/ndarray/slice"
 "@stdlib/ndarray-slice-assign","@stdlib/ndarray/slice-assign"

lib/node_modules/@stdlib/namespace/pkg2alias/data/data.csv

@@ -2341,6 +2341,7 @@ binomialTest,"var out = binomialTest( 682, 925 )\nout = binomialTest( [ 682, 925
 Boolean,"var b = new Boolean( null )\nb = Boolean( null )\nb = Boolean( [] )\n"
 Boolean.prototype.toString,"var b = new Boolean( true )\nb.toString()\n"
 Boolean.prototype.valueOf,"var b = new Boolean( true )\nb.valueOf()\n"
+broadcastArray,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nvar sh = x.shape\nvar y = broadcastArray( x, [ 3, 2, 2 ] )\nsh = y.shape\nvar v = y.get( 0, 0, 0 )\nv = y.get( 0, 0, 1 )\nv = y.get( 0, 1, 0 )\nv = y.get( 0, 1, 1 )\nv = y.get( 1, 0, 0 )\nv = y.get( 1, 1, 0 )\nv = y.get( 2, 0, 0 )\nv = y.get( 2, 1, 1 )\n"
 Buffer,"var b = new Buffer( 4 )\nvar b1 = new Buffer( [ 1, 2, 3, 4 ] );\nvar b2 = new Buffer( b1 )\nvar b = new Buffer( [ 1, 2, 3, 4 ] )\nvar b = new Buffer( 'beep boop' )\n"
 buffer2json,"var buf = new allocUnsafe( 2 );\nbuf[ 0 ] = 1;\nbuf[ 1 ] = 2;\nvar json = buffer2json( buf )\n"
 BYTE_ORDER,"BYTE_ORDER\n"

lib/node_modules/@stdlib/namespace/pkg2alias/data/data.json

@@ -3679,6 +3679,7 @@ ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype] )\n    Returns a list of n
 ndempty,"\nndempty( shape[, options] )\n    Returns an uninitialized ndarray having a specified shape and data type.\n\n    In browser environments, the function always returns zero-filled ndarrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n    For returned ndarrays whose underlying memory is *not* initialized, memory\n    contents are unknown and may contain *sensitive* data.\n\n    Parameters\n    ----------\n    shape: ArrayLikeObject<integer>|integer\n        Array shape.\n\n    options: Object (optional)\n        Options.\n\n    options.dtype: string (optional)\n        Underlying data type. Default: 'float64'.\n\n    options.order: string (optional)\n        Specifies whether an array is row-major (C-style) or column-major\n        (Fortran-style). Default: 'row-major'.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions to\n        either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n        array dimensions using modulo arithmetic. If equal to 'clamp', an\n        ndarray instance sets a subscript exceeding array dimensions to either\n        `0` (minimum index) or the maximum index. If the number of modes is\n        fewer than the number of dimensions, the function recycles modes using\n        modulo arithmetic. Default: [ options.mode ].\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var arr = ndempty( [ 2, 2 ] )\n    <ndarray>\n    > var sh = arr.shape\n    [ 2, 2 ]\n    > var dt = arr.dtype\n    'float64'\n\n    See Also\n    --------\n    ndemptyLike, ndzeros\n"
 ndemptyLike,"\nndemptyLike( x[, options] )\n    Returns an uninitialized ndarray having the same shape and data type as a\n    provided input ndarray.\n\n    The function infers the following attributes from the input array:\n\n    - shape: array shape.\n    - dtype: underlying array data type.\n    - order: whether the array order is row-major (C-style) or column-major\n      (Fortran-style).\n\n    In browser environments, the function always returns zero-filled ndarrays.\n\n    If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n    For returned ndarrays whose underlying memory is *not* initialized, memory\n    contents are unknown and may contain *sensitive* data.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    options: Object (optional)\n        Options.\n\n    options.shape: ArrayLikeObject<integer>|integer (optional)\n        Array shape. Overrides the input array's inferred shape.\n\n    options.dtype: string (optional)\n        Array data type. Overrides the input array's inferred data type.\n\n    options.order: string (optional)\n        Array order (either 'row-major' (C-style) or 'column-major' (Fortran-\n        style)). Overrides the input array's inferred order.\n\n    options.mode: string (optional)\n        Specifies how to handle indices which exceed array dimensions. If equal\n        to 'throw', an ndarray instance throws an error when an index exceeds\n        array dimensions. If equal to 'wrap', an ndarray instance wraps around\n        indices exceeding array dimensions using modulo arithmetic. If equal to\n        'clamp', an ndarray instance sets an index exceeding array dimensions to\n        either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n    options.submode: Array<string> (optional)\n        Specifies how to handle subscripts which exceed array dimensions. If a\n        mode for a corresponding dimension is equal to 'throw', an ndarray\n        instance throws an error when a subscript exceeds array dimensions. If\n        equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n        array dimensions using modulo arithmetic. If equal to 'clamp', an\n        ndarray instance sets a subscript exceeding array dimensions to either\n        `0` (minimum index) or the maximum index. If the number of modes is\n        fewer than the number of dimensions, the function recycles modes using\n        modulo arithmetic. Default: [ options.mode ].\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\n    <ndarray>\n    > var sh = x.shape\n    [ 2, 2 ]\n    > var dt = x.dtype\n    'float64'\n    > var y = ndemptyLike( x )\n    <ndarray>\n    > sh = y.shape\n    [ 2, 2 ]\n    > dt = y.dtype\n    'float64'\n\n    See Also\n    --------\n    ndempty, ndzerosLike\n"
 nditerColumns,"\nnditerColumns( x[, options] )\n    Returns an iterator which iterates over each column in a matrix (or stack of\n    matrices).\n\n    If an environment supports Symbol.iterator, the returned iterator is\n    iterable.\n\n    If an environment supports Symbol.iterator, the function explicitly does not\n    invoke an ndarray's `@@iterator` method, regardless of whether this method\n    is defined.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray for which to create the iterator.\n\n    options: Object (optional)\n        Options.\n\n    options.readonly: boolean (optional)\n        Boolean indicating whether returned ndarray views should be read-only.\n        Default: true.\n\n    Returns\n    -------\n    iterator: Object\n        Iterator.\n\n    iterator.next(): Function\n        Returns an iterator protocol-compliant object containing the next\n        iterated value (if one exists) and a boolean flag indicating whether the\n        iterator is finished.\n\n    iterator.return( [value] ): Function\n        Finishes an iterator and returns a provided value.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n    > var it = nditerColumns( x );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ 1, 3 ]\n    > v = it.next().value;\n    > ndarray2array( v )\n    [ 2, 4 ]\n\n    See Also\n    --------\n    nditerRows, ndslice\n"
+nditerIndices,"\nnditerIndices( shape[, options] )\n    Returns an iterator which returns indices for use indexing into an ndarray\n    having a specified shape.\n\n    If an environment supports Symbol.iterator, the returned iterator is\n    iterable.\n\n    Parameters\n    ----------\n    shape: Array<integer>\n        Input shape.\n\n    options: Object (optional)\n        Options.\n\n    options.order: string (optional)\n        Index iteration order. By default, the returned iterator iterates over\n        the last dimensions first, thus corresponding to iteration over\n        contiguous data stored in row-major order. Must be either 'row-major'\n        or 'column-major'.\n\n    Returns\n    -------\n    iterator: Object\n        Iterator.\n\n    iterator.next(): Function\n        Returns an iterator protocol-compliant object containing the next\n        iterated value (if one exists) and a boolean flag indicating whether the\n        iterator is finished.\n\n    iterator.return( [value] ): Function\n        Finishes an iterator and returns a provided value.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n    > var it = nditerIndices( x.shape );\n    > var v = it.next().value\n    [ 0, 0 ]\n    > v = it.next().value\n    [ 0, 1 ]\n\n    See Also\n    --------\n    ndarray\n"
 nditerRows,"\nnditerRows( x[, options] )\n    Returns an iterator which iterates over each row in a matrix (or stack of\n    matrices).\n\n    If an environment supports Symbol.iterator, the returned iterator is\n    iterable.\n\n    If an environment supports Symbol.iterator, the function explicitly does not\n    invoke an ndarray's `@@iterator` method, regardless of whether this method\n    is defined.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray for which to create the iterator.\n\n    options: Object (optional)\n        Options.\n\n    options.readonly: boolean (optional)\n        Boolean indicating whether returned ndarray views should be read-only.\n        Default: true.\n\n    Returns\n    -------\n    iterator: Object\n        Iterator.\n\n    iterator.next(): Function\n        Returns an iterator protocol-compliant object containing the next\n        iterated value (if one exists) and a boolean flag indicating whether the\n        iterator is finished.\n\n    iterator.return( [value] ): Function\n        Finishes an iterator and returns a provided value.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n    > var it = nditerRows( x );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ 1, 2 ]\n    > v = it.next().value;\n    > ndarray2array( v )\n    [ 3, 4 ]\n\n    See Also\n    --------\n    nditerColumns, ndslice\n"
 ndslice,"\nndslice( x, ...s[, options] )\n    Returns a read-only view of an input ndarray.\n\n    The function supports three (mutually exclusive) means of providing slice\n    arguments:\n\n    1. Providing a single MultiSlice object.\n    2. Providing a single array containing slice arguments.\n    3. Providing slice arguments as separate arguments.\n\n    An individual slice argument must be either a Slice, an integer, null, or\n    undefined.\n\n    In all cases, the number of slice dimensions must match the number of array\n    dimensions.\n\n    If providing a MultiSlice object or an array of slice arguments, no other\n    slice arguments should be provided.\n\n    Mixing function invocation styles (e.g., providing multiple MultiSlice\n    objects or providing an array of slice arguments followed by additional\n    slice arguments) is not supported.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    s: ...MultiSlice|Slice|null|undefined|integer|ArrayLike\n        Slice arguments.\n\n    options: Object (optional)\n        Options.\n\n    options.strict: boolean (optional)\n        Boolean indicating whether to enforce strict bounds checking.\n        Default: true.\n\n    Returns\n    -------\n    out: ndarray\n        Output array view.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\n    <ndarray>\n    > x.shape\n    [ 2, 2 ]\n    > var s = new MultiSlice( null, 1 )\n    <MultiSlice>\n    > var y = ndslice( x, s )\n    <ndarray>\n    > y.shape\n    [ 2 ]\n    > ndarray2array( y )\n    [ 2, 4 ]\n\n    See Also\n    --------\n    array, ndarray, ndsliceAssign\n"
 ndsliceAssign,"\nndsliceAssign( x, y, ...s[, options] )\n    Assigns element values from a broadcasted input ndarray to corresponding\n    elements in an output ndarray view.\n\n    The function supports three (mutually exclusive) means of providing slice\n    arguments:\n\n    1. Providing a single MultiSlice object.\n    2. Providing a single array containing slice arguments.\n    3. Providing slice arguments as separate arguments.\n\n    An individual slice argument must be either a Slice, an integer, null, or\n    undefined.\n\n    In all cases, the number of slice dimensions must match the number of output\n    array dimensions.\n\n    If providing a MultiSlice object or an array of slice arguments, no other\n    slice arguments should be provided.\n\n    Mixing function invocation styles (e.g., providing multiple MultiSlice\n    objects or providing an array of slice arguments followed by additional\n    slice arguments) is not supported.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array. The input array must be broadcast compatible with the\n        output array view and must have a data type which can be safely cast to\n        the output array data type. Floating-point data types (both real and\n        complex) are allowed to downcast to a lower precision data type of the\n        same kind (e.g., element values from a 'float64' input array can be\n        assigned to corresponding elements in a 'float32' output array).\n\n    y: ndarray\n        Output array. The output array must be writable.\n\n    s: ...MultiSlice|Slice|null|undefined|integer|ArrayLike\n        Slice arguments.\n\n    options: Object (optional)\n        Options.\n\n    options.strict: boolean (optional)\n        Boolean indicating whether to enforce strict bounds checking.\n        Default: true.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var y = ndzeros( [ 2, 2 ] )\n    <ndarray>\n    > var x = scalar2ndarray( 3.0 )\n    <ndarray>\n    > var s = new MultiSlice( null, 1 )\n    <MultiSlice>\n    > var out = ndsliceAssign( x, y, s )\n    <ndarray>\n    > var bool = ( out === y )\n    true\n    > ndarray2array( y )\n    [ [ 0.0, 3.0 ], [ 0.0, 3.0 ] ]\n\n    See Also\n    --------\n    array, ndarray, ndslice\n"

lib/node_modules/@stdlib/namespace/pkg2related/data/data.csv

@@ -2341,6 +2341,7 @@ binomialTest,"\nbinomialTest( x:(number|Array[, n:Array<number>][, options:Objec
 Boolean,"\nBoolean( value:any )\n    Returns a boolean.\n"
 Boolean.prototype.toString,"\nBoolean.prototype.toString()\n    Returns a string representing the `Boolean` object.\n"
 Boolean.prototype.valueOf,"\nBoolean.prototype.valueOf()\n    Returns the primitive value of a `Boolean` object.\n"
+broadcastArray,"\nbroadcastArray( x:ndarray, shape:ArrayLikeObject )\n    Broadcasts an ndarray to a specified shape.\n"
 Buffer,"\nBuffer\n\nBuffer( size:integer )\n    Allocates a buffer having a specified number of bytes.\n\nBuffer( buffer:Buffer )\n    Copies buffer data to a new Buffer instance.\n\nBuffer( array:Array )\n    Allocates a buffer using an array of octets.\n\nBuffer( str:string[, encoding:string] )\n    Allocates a buffer containing a provided string.\n"
 buffer2json,"\nbuffer2json( buffer:Buffer )\n    Returns a JSON representation of a buffer.\n"
 BYTE_ORDER,"\nBYTE_ORDER\n    Platform byte order.\n"

lib/node_modules/@stdlib/namespace/pkg2related/data/data.json

@@ -2342,6 +2342,7 @@ binomialTest,"binomialTest( x[, n][, options] )"
 Boolean,"Boolean( value )"
 Boolean.prototype.toString,"Boolean.prototype.toString()"
 Boolean.prototype.valueOf,"Boolean.prototype.valueOf()"
+broadcastArray,"broadcastArray( x, shape )"
 Buffer,"Buffer"
 Buffer,"Buffer( size )"
 Buffer,"Buffer( buffer )"

lib/node_modules/@stdlib/namespace/pkg2standalone/data/data.csv

@@ -2342,6 +2342,7 @@ binomialTest,"binomialTest( x:(number|Array[, n:Array<number>][, options:Object]
 Boolean,"Boolean( value:any )"
 Boolean.prototype.toString,"Boolean.prototype.toString()"
 Boolean.prototype.valueOf,"Boolean.prototype.valueOf()"
+broadcastArray,"broadcastArray( x:ndarray, shape:ArrayLikeObject )"
 Buffer,"Buffer"
 Buffer,"Buffer( size:integer )"
 Buffer,"Buffer( buffer:Buffer )"