https://github.com/stdlib-js/ndarray-iter-matrices
Create an iterator which iterates over each matrix in a stack of matrices.
https://github.com/stdlib-js/ndarray-iter-matrices
convert iter iterate iteration iterator javascript matrix multidimensional ndarray node node-js nodejs stack stdlib tensor to util utilities utility utils
Last synced: about 1 month ago
JSON representation
Create an iterator which iterates over each matrix in a stack of matrices.
- Host: GitHub
- URL: https://github.com/stdlib-js/ndarray-iter-matrices
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-11-05T09:29:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-10T03:29:30.000Z (2 months ago)
- Last Synced: 2026-04-20T09:43:50.913Z (about 2 months ago)
- Topics: convert, iter, iterate, iteration, iterator, javascript, matrix, multidimensional, ndarray, node, node-js, nodejs, stack, stdlib, tensor, to, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 2.84 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# nditerMatrices
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which iterates over each matrix in a stack of matrices.
## Installation
```bash
npm install @stdlib/ndarray-iter-matrices
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var nditerMatrices = require( '@stdlib/ndarray-iter-matrices' );
```
#### nditerMatrices( x\[, options] )
Returns an iterator which iterates over each matrix in a stack of matrices.
```javascript
var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns
var iter = nditerMatrices( x );
var v = iter.next().value;
// returns
var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]
v = iter.next().value;
// returns
arr = ndarray2array( v );
// returns [ [ 5, 6 ], [ 7, 8 ] ]
// ...
```
The function accepts the following `options`:
- **readonly**: boolean indicating whether returned [`ndarray`][@stdlib/ndarray/ctor] views should be read-only. In order to return writable [`ndarray`][@stdlib/ndarray/ctor] views, the input [`ndarray`][@stdlib/ndarray/ctor] must be writable. If the input [`ndarray`][@stdlib/ndarray/ctor] is read-only, setting this option to `false` raises an exception. Default: `true`.
By default, the iterator returns [`ndarray`][@stdlib/ndarray/ctor] views which are **read-only**. To return writable [views][@stdlib/ndarray/slice], set the `readonly` option to `false`.
```javascript
var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns
var iter = nditerMatrices( x, {
'readonly': false
});
var v = iter.next().value;
// returns
var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]
v.set( 0, 0, 10 );
arr = ndarray2array( v );
// returns [ [ 10, 2 ], [ 3, 4 ] ]
```
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
- **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.
- **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
## Notes
- If an environment supports `Symbol.iterator`, the returned iterator is iterable.
- A returned iterator does **not** copy a provided [`ndarray`][@stdlib/ndarray/ctor]. To ensure iterable reproducibility, copy the input [`ndarray`][@stdlib/ndarray/ctor] **before** creating an iterator. Otherwise, any changes to the contents of input [`ndarray`][@stdlib/ndarray/ctor] will be reflected in the returned iterator.
- In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an ndarray's `@@iterator` method, regardless of whether this method is defined.
## Examples
```javascript
var array = require( '@stdlib/ndarray-array' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var nditerMatrices = require( '@stdlib/ndarray-iter-matrices' );
// Define an input array:
var x = array( zeroTo( 27 ), {
'shape': [ 3, 3, 3 ]
});
// Create an iterator for iterating over matrices:
var it = nditerMatrices( x );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( ndarray2array( v.value ) );
}
```
* * *
## See Also
- [`@stdlib/ndarray-iter/columns`][@stdlib/ndarray/iter/columns]: create an iterator which iterates over each column in a matrix (or stack of matrices).
- [`@stdlib/ndarray-iter/matrix-entries`][@stdlib/ndarray/iter/matrix-entries]: create an iterator which returns \[index, matrix] pairs for each matrix in a stack of matrices.
- [`@stdlib/ndarray-iter/rows`][@stdlib/ndarray/iter/rows]: create an iterator which iterates over each row in a matrix (or stack of matrices).
- [`@stdlib/ndarray-slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-iter-matrices.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-iter-matrices
[test-image]: https://github.com/stdlib-js/ndarray-iter-matrices/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/ndarray-iter-matrices/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-iter-matrices/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-iter-matrices?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-iter-matrices/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-iter-matrices/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-iter-matrices/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-iter-matrices/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-iter-matrices/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-iter-matrices/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-iter-matrices/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-iter-matrices/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray-slice
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/ndarray-iter-columns
[@stdlib/ndarray/iter/matrix-entries]: https://github.com/stdlib-js/ndarray-iter-matrix-entries
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray-iter-rows