Auto-generated commit

code-blocks/data/data.csv

@@ -3690,6 +3690,7 @@ ndims,"var n = ndims( ndzeros( [ 3, 3, 3 ] ) )\n"
 nditerColumns,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerColumns( x );\nvar v = it.next().value;\nndarray2array( v )\nv = it.next().value;\nndarray2array( v )\n"
 nditerEntries,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerEntries( x );\nvar v = it.next().value\nv = it.next().value\n"
 nditerIndices,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerIndices( x.shape );\nvar v = it.next().value\nv = it.next().value\n"
+nditerMatrices,"var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );\nvar it = nditerMatrices( x );\nvar v = it.next().value;\nndarray2array( v )\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"
 nditerValues,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerValues( x );\nvar v = it.next().value\nv = it.next().value\n"
 ndslice,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nx.shape\nvar s = new MultiSlice( null, 1 )\nvar y = ndslice( x, s )\ny.shape\nndarray2array( y )\n"

help/data/data.csv

@@ -3691,6 +3691,7 @@ nditerColumns,"\nnditerColumns( x[, options] )\n    Returns an iterator which it
 nditerEntries,"\nnditerEntries( x[, options] )\n    Returns an iterator which returns [index, value] pairs for each element in a\n    provided ndarray.\n\n    Each returned index is a Cartesian index (i.e., an array of subscripts/\n    dimension indices).\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 manor, 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 = nditerEntries( x );\n    > var v = it.next().value\n    [ [ 0, 0 ], 1 ]\n    > v = it.next().value\n    [ [ 0, 1 ], 2 ]\n\n    See Also\n    --------\n    ndarray, nditerIndices, nditerValues\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, nditerEntries, nditerValues\n"
 nditerMatrices,"\nnditerMatrices( x[, options] )\n    Returns an iterator which iterates over each matrix in a stack of 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 = nditerMatrices( x );\n    > var v = it.next().value;\n    > ndarray2array( v )\n    [ [ 1, 2 ], [ 3, 4 ] ]\n\n    See Also\n    --------\n    nditerColumns, nditerRows, ndslice\n"
+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    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, 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 manor, 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"
 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, ndsliceDimension\n"

info/data/data.csv

@@ -3690,6 +3690,7 @@ ndims,"\nndims( x:ndarray )\n    Returns the number of ndarray dimensions.\n"
 nditerColumns,"\nnditerColumns( x:ndarray[, options:Object] )\n    Returns an iterator which iterates over each column in a matrix (or stack of\n    matrices).\n"
 nditerEntries,"\nnditerEntries( x:ndarray[, options:Object] )\n    Returns an iterator which returns [index, value] pairs for each element in a\n    provided ndarray.\n"
 nditerIndices,"\nnditerIndices( shape:Array<integer>[, options:Object] )\n    Returns an iterator which returns indices for use indexing into an ndarray\n    having a specified shape.\n"
+nditerMatrices,"\nnditerMatrices( x:ndarray[, options:Object] )\n    Returns an iterator which iterates over each matrix in a stack of matrices.\n"
 nditerRows,"\nnditerRows( x:ndarray[, options:Object] )\n    Returns an iterator which iterates over each row in a matrix (or stack of\n    matrices).\n"
 nditerValues,"\nnditerValues( x:ndarray[, options:Object] )\n    Returns an iterator which returns individual elements from a provided\n    ndarray.\n"
 ndslice,"\nndslice( x:ndarray, ...s:MultiSlice|Slice|null|undefined|integer|ArrayLike[, \n  options:Object] )\n    Returns a read-only view of an input ndarray.\n"

signature/data/data.csv

@@ -3727,6 +3727,7 @@ ndims,"ndims( x )"
 nditerColumns,"nditerColumns( x[, options] )"
 nditerEntries,"nditerEntries( x[, options] )"
 nditerIndices,"nditerIndices( shape[, options] )"
+nditerMatrices,"nditerMatrices( x[, options] )"
 nditerRows,"nditerRows( x[, options] )"
 nditerValues,"nditerValues( x[, options] )"
 ndslice,"ndslice( x, ...s[, options] )"

typed-signature/data/data.csv

@@ -3727,6 +3727,7 @@ ndims,"ndims( x:ndarray )"
 nditerColumns,"nditerColumns( x:ndarray[, options:Object] )"
 nditerEntries,"nditerEntries( x:ndarray[, options:Object] )"
 nditerIndices,"nditerIndices( shape:Array<integer>[, options:Object] )"
+nditerMatrices,"nditerMatrices( x:ndarray[, options:Object] )"
 nditerRows,"nditerRows( x:ndarray[, options:Object] )"
 nditerValues,"nditerValues( x:ndarray[, options:Object] )"
 ndslice,"ndslice( x:ndarray, ...s:MultiSlice|Slice|null|undefined|integer|ArrayLike[, options:Object] )"