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 returns indices for use indexing into an
ndarrayhaving a specified shape.
import nditerIndices from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-iter-indices@esm/index.mjs';Returns an iterator which returns indices for use indexing into an ndarray having a specified shape.
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs';
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns <ndarray>
var iter = nditerIndices( x.shape );
var v = iter.next().value;
// returns [ 0, 0, 0 ]
v = iter.next().value;
// returns [ 0, 0, 1 ]
v = iter.next().value;
// returns [ 0, 1, 0 ]
// ...The function accepts the following options:
- order: index iteration order. By default, the returned iterator iterates over the last dimensions first, thus corresponding to iteration over contiguous data stored in row-major order. Must be either
'row-major'or'column-major'.
By default, the iterator returns indices such that the last dimensions are iterated over first. To return indices according to a specified order, set the order option.
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs';
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ], {
'order': 'row-major'
});
// returns <ndarray>
var iter = nditerIndices( x.shape, {
'order': 'column-major'
});
var v = iter.next().value;
// returns [ 0, 0, 0 ]
v = iter.next().value;
// returns [ 1, 0, 0 ]
v = iter.next().value;
// returns [ 0, 1, 0 ]
// ...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.
- If an environment supports
Symbol.iterator, the returned iterator is iterable.
<!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 nditerIndices from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-iter-indices@esm/index.mjs';
// Define an input array:
var x = array( zeroTo( 27 ), {
'shape': [ 3, 3, 3 ]
});
// Create an iterator for generating indices:
var it = nditerIndices( x.shape );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( x.get.apply( x, v.value ) );
}
</script>
</body>
</html>@stdlib/ndarray-ctor: multidimensional array constructor.@stdlib/ndarray-iter/entries: create an iterator which returns [index, value] pairs for each element in a provided ndarray.@stdlib/ndarray-iter/values: create an iterator which returns individual elements from a provided 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.