Multidimensional array iterators.
npm install @stdlib/ndarray-iterWe 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]
> Multidimensional array iterators.
``bash`
npm install @stdlib/ndarray-iter
`javascript`
var ns = require( '@stdlib/ndarray-iter' );
#### ns
Namespace containing utilities for iterating over multidimensional arrays.
`javascript`
var o = ns;
// returns {...}
- [nditerColumnEntries( x[, options] )][@stdlib/ndarray/iter/column-entries]: create an iterator which returns [index, column] pairs for each column in a matrix (or stack of matrices).
- [nditerColumns( x[, options] )][@stdlib/ndarray/iter/columns]: create an iterator which iterates over each column in a matrix (or stack of matrices).
- [nditerEntries( x[, options] )][@stdlib/ndarray/iter/entries]: create an iterator which returns [index, value] pairs for each element in a provided ndarray.
- [nditerIndices( shape[, options] )][@stdlib/ndarray/iter/indices]: create an iterator which returns indices for use indexing into an ndarray having a specified shape.
- [nditerInterleaveSubarrays( arr, ndims )][@stdlib/ndarray/iter/interleave-subarrays]: create an iterator which iterates over interleaved subarrays.
- [nditerMatrices( x[, options] )][@stdlib/ndarray/iter/matrices]: create an iterator which iterates over each matrix in a stack of matrices.
- [nditerMatrixEntries( x[, options] )][@stdlib/ndarray/iter/matrix-entries]: create an iterator which returns [index, matrix] pairs for each matrix in a stack of matrices.
- [nditerRowEntries( x[, options] )][@stdlib/ndarray/iter/row-entries]: create an iterator which returns [index, row] pairs for each row in a matrix (or stack of matrices).
- [nditerRows( x[, options] )][@stdlib/ndarray/iter/rows]: create an iterator which iterates over each row in a matrix (or stack of matrices).
- [nditerSelectDimension( x, dim[, options] )][@stdlib/ndarray/iter/select-dimension]: create an iterator which iterates over each view along a specified dimension.
- [nditerStacks( x, dims[, options] )][@stdlib/ndarray/iter/stacks]: create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.
- [nditerSubarrays( x, ndims[, options] )][@stdlib/ndarray/iter/subarrays]: create an iterator which iterates over each subarray in a stack of subarrays.
- [nditer2arrayEach( iterator )][@stdlib/ndarray/iter/to-array-each]: create an iterator which converts each iterated ndarray to a generic array.
- [nditerValues( x[, options] )][@stdlib/ndarray/iter/values]: create an iterator which returns individual elements from a provided ndarray.
`javascript
var objectKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/ndarray-iter' );
console.log( objectKeys( ns ) );
`
*
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.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-iter
[test-image]: https://github.com/stdlib-js/ndarray-iter/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/ndarray-iter/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-iter/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-iter?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/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-iter/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-iter/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-iter/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-iter/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-iter/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-iter/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-iter/main/LICENSE
[@stdlib/ndarray/iter/column-entries]: https://www.npmjs.com/package/@stdlib/ndarray-iter-column-entries
[@stdlib/ndarray/iter/columns]: https://www.npmjs.com/package/@stdlib/ndarray-iter-columns
[@stdlib/ndarray/iter/entries]: https://www.npmjs.com/package/@stdlib/ndarray-iter-entries
[@stdlib/ndarray/iter/indices]: https://www.npmjs.com/package/@stdlib/ndarray-iter-indices
[@stdlib/ndarray/iter/interleave-subarrays]: https://www.npmjs.com/package/@stdlib/ndarray-iter-interleave-subarrays
[@stdlib/ndarray/iter/matrices]: https://www.npmjs.com/package/@stdlib/ndarray-iter-matrices
[@stdlib/ndarray/iter/matrix-entries]: https://www.npmjs.com/package/@stdlib/ndarray-iter-matrix-entries
[@stdlib/ndarray/iter/row-entries]: https://www.npmjs.com/package/@stdlib/ndarray-iter-row-entries
[@stdlib/ndarray/iter/rows]: https://www.npmjs.com/package/@stdlib/ndarray-iter-rows
[@stdlib/ndarray/iter/select-dimension]: https://www.npmjs.com/package/@stdlib/ndarray-iter-select-dimension
[@stdlib/ndarray/iter/stacks]: https://www.npmjs.com/package/@stdlib/ndarray-iter-stacks
[@stdlib/ndarray/iter/subarrays]: https://www.npmjs.com/package/@stdlib/ndarray-iter-subarrays
[@stdlib/ndarray/iter/to-array-each]: https://www.npmjs.com/package/@stdlib/ndarray-iter-to-array-each
[@stdlib/ndarray/iter/values]: https://www.npmjs.com/package/@stdlib/ndarray-iter-values