docs: update REPL namespace documentation

PR-URL: #11561

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>

Author: stdlib-bot

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

@@ -4232,7 +4232,7 @@ nditerMatrixEntries,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = ndit
 nditerRowEntries,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerRowEntries( x );\nvar v = it.next().value;\nv[ 0 ]\nndarray2array( v[ 1 ] )\nv = it.next().value;\nv[ 0 ]\nndarray2array( v[ 1 ] )\n"
 nditerRows,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerRows( x );\nvar v = it.next().value;\nndarray2array( v )\nv = it.next().value;\nndarray2array( v )\n"
 nditerSelectDimension,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = nditerSelectDimension( x, 0 );\nvar v = it.next().value;\nndarray2array( v )\n"
-nditerStacks,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = nditerStacks( x, [ 1, 2 ] );\nvar v = it.next().value;\nndarray2array( v )\n"
+nditerStacks,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = nditerStacks( x, [ 1, 2 ] );\nvar v = it.next().value\n"
 nditerSubarrays,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = nditerSubarrays( x, 2 );\nvar v = it.next().value;\nndarray2array( v )\n"
 nditerValues,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerValues( x );\nvar v = it.next().value\nv = it.next().value\n"
 ndmap,"var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\nfunction f( v ) { return v*10.0; };\nvar y = ndmap( x, f )\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

@@ -4233,7 +4233,7 @@ nditerMatrixEntries,"\nnditerMatrixEntries( x[, options] )\n    Returns an itera
 nditerRowEntries,"\nnditerRowEntries( x[, options] )\n    Returns an iterator which returns [index, row] pairs for each row in a\n    matrix (or stack of matrices).\n\n    Each returned index is a Cartesian index (i.e., an array of subscripts/\n    dimension indices). A dimension index equal to `null` indicates that all\n    values along the respective dimension are included in the returned ndarray.\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 array.\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. 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 = nditerRowEntries( x );\n    > var v = it.next().value;\n    > v[ 0 ]\n    [ 0, null ]\n    > ndarray2array( v[ 1 ] )\n    [ 1, 2 ]\n    > v = it.next().value;\n    > v[ 0 ]\n    [ 1, null ]\n    > ndarray2array( v[ 1 ] )\n    [ 3, 4 ]\n\n    See Also\n    --------\n    nditerColumnEntries, nditerEntries, nditerRows, ndslice\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. 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, nditerRowEntries, ndslice\n"
 nditerSelectDimension,"\nnditerSelectDimension( x, dim[, options] )\n    Returns an iterator which iterates over each view along a specified\n    dimension.\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    dim: integer\n        Dimension index. If less than zero, the index is resolved relative to\n        the last dimension, with the last dimension corresponding to the value\n        `-1`.\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. Default: true.\n\n    options.keepdim: boolean (optional)\n        Boolean indicating whether returned views should include the selected\n        dimension as a singleton dimension. Including the selected dimension as\n        a singleton dimension can be useful when wanting to ensure that returned\n        views remain broadcast compatible with the input ndarray. Default:\n        false.\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 = nditerSelectDimension( x, 0 );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ [ 1, 2 ], [ 3, 4 ] ]\n\n    See Also\n    --------\n    nditerColumns, nditerMatrices, nditerRows, ndslice\n"
-nditerStacks,"\nnditerStacks( x, dims[, options] )\n    Returns an iterator which iterates over each subarray in a stack of\n    subarrays according to a list of specified stack dimensions.\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. Must have at least\n        `dims.length+1` dimensions.\n\n    dims: Array<integer>\n        Indices of dimensions to stack. If a dimension index is less than zero,\n        the index is resolved relative to the last dimension, with the last\n        dimension corresponding to the value `-1`. The list of indices must be\n        unique and resolve to dimension indices sorted in ascending order.\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. 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 = nditerStacks( x, [ 1, 2 ] );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ [ 1, 2 ], [ 3, 4 ] ]\n\n    See Also\n    --------\n    nditerColumns, nditerMatrices, nditerRows, nditerSubarrays, ndslice\n"
+nditerStacks,"\nnditerStacks( x, dims[, options] )\n    Returns an iterator which iterates over each subarray in a stack of\n    subarrays according to a list of specified stack dimensions.\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. Must have at least\n        `dims.length+1` dimensions.\n\n    dims: Array<integer>\n        Indices of dimensions to stack. If a dimension index is less than zero,\n        the index is resolved relative to the last dimension, with the last\n        dimension corresponding to the value `-1`. The list of indices must be\n        unique and resolve to dimension indices sorted in ascending order.\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. 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 = nditerStacks( x, [ 1, 2 ] );\n    > var v = it.next().value\n    <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]\n\n    See Also\n    --------\n    nditerColumns, nditerMatrices, nditerRows, nditerSubarrays, ndslice\n"
 nditerSubarrays,"\nnditerSubarrays( x, ndims[, options] )\n    Returns an iterator which iterates over each subarray in a stack of\n    subarrays.\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. Must have at least\n        `ndims+1` dimensions.\n\n    ndims: integer\n        Number of dimensions to stack.\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        If the input ndarray is read-only, setting this option to `false` raises\n        an exception. 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 = nditerSubarrays( x, 2 );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ [ 1, 2 ], [ 3, 4 ] ]\n\n    See Also\n    --------\n    nditerColumns, nditerMatrices, nditerRows, nditerStacks, ndslice\n"
 nditerValues,"\nnditerValues( x[, options] )\n    Returns an iterator which returns individual elements from a provided\n    ndarray.\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 array.\n\n    options: Object (optional)\n        Options.\n\n    options.order: string (optional)\n        Index iteration order. By default, the returned iterator returns values\n        according to the layout order of the provided array. Accordingly, for\n        row-major input arrays, the last dimension indices increment fastest.\n        For column-major input arrays, the first dimension indices increment\n        fastest. To override the inferred order and ensure that indices\n        increment in a specific manner, regardless of the input array's layout\n        order, explicitly set the iteration order. Note, however, that iterating\n        according to an order which does not match that of the input array may,\n        in some circumstances, result in performance degradation due to cache\n        misses. Must be either 'row-major' 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 = nditerValues( x );\n    > var v = it.next().value\n    1\n    > v = it.next().value\n    2\n\n    See Also\n    --------\n    ndarray, nditerEntries, nditerIndices\n"
 ndmap,"\nndmap( x[, options], fcn[, thisArg] )\n    Applies a callback function to elements in an input ndarray and assigns\n    results to elements in a new output ndarray.\n\n    The callback function is provided the following arguments:\n\n    - value: current array element.\n    - indices: current array element indices.\n    - arr: the input ndarray.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input ndarray.\n\n    options: Object (optional)\n        Function options.\n\n    options.dtype: string (optional)\n        Output ndarray data type. Overrides using the input array's inferred\n        data type.\n\n    fcn: Function\n        Callback function.\n\n    thisArg: any (optional)\n        Callback function execution context.\n\n    Examples\n    --------\n    > var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n    > function f( v ) { return v*10.0; };\n    > var y = ndmap( x, f )\n    <ndarray>[ [ 10.0, 20.0 ], [ 30.0, 40.0 ] ]\n\n    See Also\n    --------\n    ndfilter, ndfilterMap, ndforEach, ndslice"