Create an iterator which iterates over interleaved subarrays.
npm install @stdlib/ndarray-iter-interleave-subarraysWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which iterates over interleaved subarrays.
``bash`
npm install @stdlib/ndarray-iter-interleave-subarrays
`javascript`
var nditerInterleaveSubarrays = require( '@stdlib/ndarray-iter-interleave-subarrays' );
#### nditerInterleaveSubarrays( arr, ndims )
Returns an iterator which iterates over interleaved subarrays.
`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 = nditerInterleaveSubarrays( [ x, x ], 2 );
var v = iter.next().value;
// returns
var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]
v = iter.next().value;
// returns
arr = ndarray2array( v );
// returns [ [ 1, 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.
- All provided [ndarrays][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes].ndarray
- After broadcasting, each broadcasted input [][@stdlib/ndarray/ctor] must have at least ndims+1 dimensions.ndarrays
- For input [][@stdlib/ndarray/ctor] supporting read-only views, the function returns read-only views of interleaved subarrays. As input [ndarrays][@stdlib/ndarray/ctor] may be broadcasted, a view is typically not contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to a subarray, copy the subarray before attempting mutation.Symbol.iterator
- If an environment supports , the returned iterator is iterable.ndarray
- A returned iterator does not copy a provided [][@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.Symbol.iterator
- In environments supporting , the function explicitly does not invoke an ndarray's @@iterator method, regardless of whether this method is defined.
`javascript
var array = require( '@stdlib/ndarray-array' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var nditerInterleaveSubarrays = require( '@stdlib/ndarray-iter-interleave-subarrays' );
// Define input arrays:
var x = array( zeroTo( 27 ), {
'shape': [ 3, 3, 3 ]
});
var y = array( zeroTo( 9 ), {
'shape': [ 3, 3 ]
});
// Create an iterator for iterating over interleaved matrices:
var it = nditerInterleaveSubarrays( [ x, y ], 2 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( ndarray2array( v.value ) );
}
`
*
- [@stdlib/ndarray-iter/subarrays][@stdlib/ndarray/iter/subarrays]: create an iterator which iterates over each subarray in a stack of subarrays.
- [@stdlib/ndarray-slice][@stdlib/ndarray/slice]: return a read-only view of an input ndarray.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-iter-interleave-subarrays.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-iter-interleave-subarrays
[test-image]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/actions/workflows/test.yml/badge.svg?branch=v0.1.0
[test-url]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/actions/workflows/test.yml?query=branch:v0.1.0
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-iter-interleave-subarrays/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-iter-interleave-subarrays?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-interleave-subarrays/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-iter-interleave-subarrays/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-iter-interleave-subarrays/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
[@stdlib/ndarray/base/broadcast-shapes]: https://www.npmjs.com/package/@stdlib/ndarray-base-broadcast-shapes
[@stdlib/ndarray/iter/subarrays]: https://www.npmjs.com/package/@stdlib/ndarray-iter-subarrays
[@stdlib/ndarray/slice]: https://www.npmjs.com/package/@stdlib/ndarray-slice