Skip to content

Commit

Permalink
feat: add nditerMatrices to namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed Nov 5, 2023
1 parent 29d99d7 commit 9fa9570
Show file tree
Hide file tree
Showing 20 changed files with 31 additions and 10 deletions.
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/namespace/alias2pkg/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@ nditer2arrayEach,"@stdlib/ndarray/iter/to-array-each"
nditerColumns,"@stdlib/ndarray/iter/columns"
nditerEntries,"@stdlib/ndarray/iter/entries"
nditerIndices,"@stdlib/ndarray/iter/indices"
nditerMatrices,"@stdlib/ndarray/iter/matrices"
nditerRows,"@stdlib/ndarray/iter/rows"
nditerValues,"@stdlib/ndarray/iter/values"
ndslice,"@stdlib/ndarray/slice"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@ nditer2arrayEach,"ndarray,ndarray2array"
nditerColumns,"nditerRows,ndslice"
nditerEntries,"ndarray,nditerIndices,nditerValues"
nditerIndices,"ndarray,nditerEntries,nditerValues"
nditerMatrices,"nditerColumns,nditerRows,ndslice"
nditerRows,"nditerColumns,ndslice"
nditerValues,"ndarray,nditerEntries,nditerIndices"
ndslice,"array,ndarray,ndsliceAssign,ndsliceDimension"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@ nditer2arrayEach,"@stdlib/ndarray-iter-to-array-each"
nditerColumns,"@stdlib/ndarray-iter-columns"
nditerEntries,"@stdlib/ndarray-iter-entries"
nditerIndices,"@stdlib/ndarray-iter-indices"
nditerMatrices,"@stdlib/ndarray-iter-matrices"
nditerRows,"@stdlib/ndarray-iter-rows"
nditerValues,"@stdlib/ndarray-iter-values"
ndslice,"@stdlib/ndarray-slice"
Expand Down

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/namespace/aliases/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/namespace/aliases/data/data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@ nditer2arrayEach
nditerColumns
nditerEntries
nditerIndices
nditerMatrices
nditerRows
nditerValues
ndslice
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/namespace/lib/namespace/n.js
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,18 @@ ns.push({
]
});

ns.push({
'alias': 'nditerMatrices',
'path': '@stdlib/ndarray/iter/matrices',
'value': require( '@stdlib/ndarray/iter/matrices' ),
'type': 'Function',
'related': [
'@stdlib/ndarray/iter/columns',
'@stdlib/ndarray/iter/rows',
'@stdlib/ndarray/slice'
]
});

ns.push({
'alias': 'nditerRows',
'path': '@stdlib/ndarray/iter/rows',
Expand Down
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/namespace/pkg2alias/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@
"@stdlib/ndarray/iter/columns",nditerColumns
"@stdlib/ndarray/iter/entries",nditerEntries
"@stdlib/ndarray/iter/indices",nditerIndices
"@stdlib/ndarray/iter/matrices",nditerMatrices
"@stdlib/ndarray/iter/rows",nditerRows
"@stdlib/ndarray/iter/values",nditerValues
"@stdlib/ndarray/slice",ndslice
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@
"@stdlib/ndarray/iter/columns","@stdlib/ndarray/iter/rows,@stdlib/ndarray/slice"
"@stdlib/ndarray/iter/entries","@stdlib/ndarray/ctor,@stdlib/ndarray/iter/indices,@stdlib/ndarray/iter/values"
"@stdlib/ndarray/iter/indices","@stdlib/ndarray/ctor,@stdlib/ndarray/iter/entries,@stdlib/ndarray/iter/values"
"@stdlib/ndarray/iter/matrices","@stdlib/ndarray/iter/columns,@stdlib/ndarray/iter/rows,@stdlib/ndarray/slice"
"@stdlib/ndarray/iter/rows","@stdlib/ndarray/iter/columns,@stdlib/ndarray/slice"
"@stdlib/ndarray/iter/values","@stdlib/ndarray/ctor,@stdlib/ndarray/iter/entries,@stdlib/ndarray/iter/indices"
"@stdlib/ndarray/slice","@stdlib/ndarray/array,@stdlib/ndarray/ctor,@stdlib/ndarray/slice-assign,@stdlib/ndarray/slice-dimension"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@
"@stdlib/ndarray/iter/columns","@stdlib/ndarray-iter-columns"
"@stdlib/ndarray/iter/entries","@stdlib/ndarray-iter-entries"
"@stdlib/ndarray/iter/indices","@stdlib/ndarray-iter-indices"
"@stdlib/ndarray/iter/matrices","@stdlib/ndarray-iter-matrices"
"@stdlib/ndarray/iter/rows","@stdlib/ndarray-iter-rows"
"@stdlib/ndarray/iter/values","@stdlib/ndarray-iter-values"
"@stdlib/ndarray/slice","@stdlib/ndarray-slice"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,7 @@
"@stdlib/ndarray-iter-columns","@stdlib/ndarray/iter/columns"
"@stdlib/ndarray-iter-entries","@stdlib/ndarray/iter/entries"
"@stdlib/ndarray-iter-indices","@stdlib/ndarray/iter/indices"
"@stdlib/ndarray-iter-matrices","@stdlib/ndarray/iter/matrices"
"@stdlib/ndarray-iter-rows","@stdlib/ndarray/iter/rows"
"@stdlib/ndarray-iter-values","@stdlib/ndarray/iter/values"
"@stdlib/ndarray-slice","@stdlib/ndarray/slice"
Expand Down

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/data/contributor.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["Ali Salesi","Amit Jimiwal","Athan Reines","Brendan Graetz","Bruno Fenzl","Christopher Dambamuromo","Dan Rose","Dominik Moritz","Dorrin Sotoudeh","Frank Kovacs","Harshita Kalani","James Gelok","Jithin KS","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Marcus Fantham","Matt Cochrane","Milan Raj","Momtchil Momtchev","Naresh Jagadeesan","Nithin Katta","Ognjen Jevremović","Philipp Burckhardt","Pranav Goswami","Ricky Reusser","Roman Stetsyk","Ryan Seal","Seyyed Parsa Neshaei","Shraddheya Shendre","Stephannie Jiménez Gacha","Yernar Yergaziyev","orimiles5","rei2hu","rgizz"]
["Ali Salesi","Amit Jimiwal","Athan Reines","Brendan Graetz","Bruno Fenzl","Christopher Dambamuromo","Dan Rose","Dominik Moritz","Dorrin Sotoudeh","Frank Kovacs","Harshita Kalani","James Gelok","Jithin KS","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Marcus Fantham","Matt Cochrane","Milan Raj","Momtchil Momtchev","Naresh Jagadeesan","Nithin Katta","Ognjen Jevremović","Philipp Burckhardt","Pranav Goswami","Ricky Reusser","Roman Stetsyk","Ryan Seal","Seyyed Parsa Neshaei","Shraddheya Shendre","Stephannie Jiménez Gacha","Yernar Yergaziyev","orimiles5","rei2hu","Robert Gislason"]
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3690,6 +3690,7 @@ ndims,"\nndims( x )\n Returns the number of ndarray dimensions.\n\n Parame
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 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 = 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"
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"
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"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

1 comment on commit 9fa9570

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
namespace/alias2pkg $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
namespace/alias2related $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
namespace/alias2standalone $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
namespace/aliases $\color{green}144/144$
$\color{green}+100.00\%$
$\color{green}14/14$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}144/144$
$\color{green}+100.00\%$
namespace $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
namespace/pkg2alias $\color{green}100/100$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}100/100$
$\color{green}+100.00\%$
namespace/pkg2related $\color{green}100/100$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}100/100$
$\color{green}+100.00\%$
namespace/pkg2standalone $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
namespace/standalone2pkg $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
ndarray/iter $\color{green}105/105$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}105/105$
$\color{green}+100.00\%$
ndarray/iter/matrices $\color{green}274/274$
$\color{green}+100.00\%$
$\color{green}27/27$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}274/274$
$\color{green}+100.00\%$
ndarray/zeros $\color{green}188/188$
$\color{green}+100.00\%$
$\color{green}32/32$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}188/188$
$\color{green}+100.00\%$
repl $\color{red}4124/7307$
$\color{green}+56.44\%$
$\color{red}77/81$
$\color{green}+95.06\%$
$\color{red}5/91$
$\color{green}+5.49\%$
$\color{red}4124/7307$
$\color{green}+56.44\%$
repl/help $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.