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!
Create an iterator which iterates over interleaved subarrays.
import nditerInterleaveSubarrays from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-iter-interleave-subarrays@esm/index.mjs';Returns an iterator which iterates over interleaved subarrays.
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs';
import ndarray2array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-to-array@esm/index.mjs';
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns <ndarray>
var iter = nditerInterleaveSubarrays( [ x, x ], 2 );
var v = iter.next().value;
// returns <ndarray>
var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]
v = iter.next().value;
// returns <ndarray>
arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]
// ...The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a
valueproperty and adoneproperty having abooleanvalue indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
- All provided
ndarraysmust be broadcast compatible. - After broadcasting, each broadcasted input
ndarraymust have at leastndims+1dimensions. - For input
ndarrayssupporting read-only views, the function returns read-only views of interleaved subarrays. As inputndarraysmay 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. - If an environment supports
Symbol.iterator, the returned iterator is iterable. - A returned iterator does not copy a provided
ndarray. To ensure iterable reproducibility, copy the inputndarraybefore creating an iterator. Otherwise, any changes to the contents of inputndarraywill be reflected in the returned iterator. - In environments supporting
Symbol.iterator, the function explicitly does not invoke an ndarray's@@iteratormethod, regardless of whether this method is defined.
<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs';
import zeroTo from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zero-to@esm/index.mjs';
import ndarray2array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-to-array@esm/index.mjs';
import nditerInterleaveSubarrays from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-iter-interleave-subarrays@esm/index.mjs';
// 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 ) );
}
</script>
</body>
</html>@stdlib/ndarray-iter/subarrays: create an iterator which iterates over each subarray in a stack of subarrays.@stdlib/ndarray-slice: return a read-only view of an input ndarray.
This package is part of stdlib, a standard library 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, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
