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

Return a flattened copy of an input ndarray.

Installation

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 available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var flatten = require( '@stdlib/ndarray-flatten' );

flatten( x[, options] )

Returns a flattened copy of an input ndarray.

var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

var y = flatten( x );
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]

The function accepts the following arguments:

• x: input ndarray.
• options: function options (optional).

The function accepts the following options:

• order: order in which input ndarray 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 (i.e., a matrix), flattening in lexicographic order means flattening the input ndarray row-by-row.
  • 'column-major': flatten elements in colexicographic order. For example, given a two-dimensional input ndarray (i.e., a matrix), flattening in colexicographic order means flattening the input ndarray column-by-column.
  • 'any': flatten according to the physical layout of the input ndarray data in memory, regardless of the stated order of the input ndarray.
  • 'same': flatten according to the stated order of the input ndarray.

  Default: 'row-major'.

• depth: maximum number of input ndarray dimensions to flatten.

By default, the function flattens all dimensions of the input ndarray. To flatten to a desired depth, specify the depth option.

var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

var y = flatten( x, {
    'depth': 1
});
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]

By default, the input ndarray is flattened in lexicographic order. To flatten elements in a different order, specify the order option.

var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

var y = flatten( x, {
    'order': 'column-major'
});
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]

Notes

• The function always returns a copy of input ndarray data, even when an input ndarray already has the desired number of dimensions.

Examples

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, 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, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.