https://github.com/stdlib-js/ndarray-flatten
Return a flattened copy of an input ndarray.
https://github.com/stdlib-js/ndarray-flatten
array copy flat flatten javascript matrix multidimensional ndarray node node-js nodejs reshape stdlib tensor transform
Last synced: 2 months ago
JSON representation
Return a flattened copy of an input ndarray.
- Host: GitHub
- URL: https://github.com/stdlib-js/ndarray-flatten
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-09-09T07:59:51.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-04-09T03:25:49.000Z (3 months ago)
- Last Synced: 2026-04-09T05:26:15.986Z (3 months ago)
- Topics: array, copy, flat, flatten, javascript, matrix, multidimensional, ndarray, node, node-js, nodejs, reshape, stdlib, tensor, transform
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 2.38 MB
- Stars: 0
- Watchers: 0
- 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!
# flatten
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a flattened copy of an input [ndarray][@stdlib/ndarray/ctor].
## Installation
```bash
npm install @stdlib/ndarray-flatten
```
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 flatten = require( '@stdlib/ndarray-flatten' );
```
#### flatten( x\[, options] )
Returns a flattened copy of an input [ndarray][@stdlib/ndarray/ctor].
```javascript
var array = require( '@stdlib/ndarray-array' );
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns
var y = flatten( x );
// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
```
The function accepts the following arguments:
- **x**: input [ndarray][@stdlib/ndarray/ctor].
- **options**: function options (_optional_).
The function accepts the following options:
- **order**: order in which input [ndarray][@stdlib/ndarray/ctor] elements should be flattened. Must be one of the following:
- `'row-major'`: flatten elements in lexicographic order. For example, given a two-dimensional input [ndarray][@stdlib/ndarray/ctor] (i.e., a matrix), flattening in lexicographic order means flattening the input [ndarray][@stdlib/ndarray/ctor] row-by-row.
- `'column-major'`: flatten elements in colexicographic order. For example, given a two-dimensional input [ndarray][@stdlib/ndarray/ctor] (i.e., a matrix), flattening in colexicographic order means flattening the input [ndarray][@stdlib/ndarray/ctor] column-by-column.
- `'any'`: flatten according to the physical layout of the input [ndarray][@stdlib/ndarray/ctor] data in memory, regardless of the stated [order][@stdlib/ndarray/orders] of the input [ndarray][@stdlib/ndarray/ctor].
- `'same'`: flatten according to the stated [order][@stdlib/ndarray/orders] of the input [ndarray][@stdlib/ndarray/ctor].
Default: `'row-major'`.
- **depth**: maximum number of input [ndarray][@stdlib/ndarray/ctor] dimensions to flatten.
- **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having the same [data type][@stdlib/ndarray/dtypes] as a provided input [ndarray][@stdlib/ndarray/ctor].
By default, the function flattens all dimensions of the input [ndarray][@stdlib/ndarray/ctor]. To flatten to a desired depth, specify the `depth` option.
```javascript
var array = require( '@stdlib/ndarray-array' );
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns
var y = flatten( x, {
'depth': 1
});
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
```
By default, the input [ndarray][@stdlib/ndarray/ctor] is flattened in lexicographic order. To flatten elements in a different order, specify the `order` option.
```javascript
var array = require( '@stdlib/ndarray-array' );
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns
var y = flatten( x, {
'order': 'column-major'
});
// returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
```
By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option.
```javascript
var array = require( '@stdlib/ndarray-array' );
var dtype = require( '@stdlib/ndarray-dtype' );
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns
var y = flatten( x, {
'dtype': 'float32'
});
// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
var dt = String( dtype( y ) );
// returns 'float32'
```
## Notes
- The function **always** returns a copy of input [ndarray][@stdlib/ndarray/ctor] data, even when an input [ndarray][@stdlib/ndarray/ctor] already has the desired number of dimensions.
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var flatten = require( '@stdlib/ndarray-flatten' );
var xbuf = discreteUniform( 12, -100, 100, {
'dtype': 'generic'
});
var x = array( xbuf, {
'shape': [ 2, 2, 3 ],
'dtype': 'generic'
});
console.log( ndarray2array( x ) );
var y = flatten( x );
console.log( ndarray2array( y ) );
```
* * *
## 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-flatten.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-flatten
[test-image]: https://github.com/stdlib-js/ndarray-flatten/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/ndarray-flatten/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-flatten/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-flatten?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-flatten/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-flatten/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-flatten/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-flatten/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-flatten/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-flatten/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-flatten/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-flatten/main/LICENSE
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes
[@stdlib/ndarray/orders]: https://github.com/stdlib-js/ndarray-orders