Flatten a five-dimensional nested array.
APACHE-2.0 License
Flatten a five-dimensional nested array.
npm install @stdlib/array-base-flatten5d
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).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.
var flatten5d = require( '@stdlib/array-base-flatten5d' );
Flattens a five-dimensional nested array.
var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
// returns [ 1, 2, 3, 4 ]
To flatten in colexicographic order, provide a third argument equal to true
.
var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
// returns [ 1, 3, 2, 4 ]
Flattens a five-dimensional nested array and assigns elements to a provided output array.
var Float64Array = require( '@stdlib/array-float64' );
var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
var out = new Float64Array( 4 );
var y = flatten5d.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 );
// returns <Float64Array>[ 1, 2, 3, 4 ]
var bool = ( y === out );
// returns true
y = flatten5d.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0 );
// returns <Float64Array>[ 1, 3, 2, 4 ]
var flatten5d = require( '@stdlib/array-base-flatten5d' );
// Define a 2x2x1x2x2 array:
var x = [
[
[
[
[ 1, 2 ], [ 3, 4 ]
]
],
[
[
[ 5, 6 ], [ 7, 8 ]
]
]
],
[
[
[
[ 9, 10 ], [ 11, 12 ]
]
],
[
[
[ 13, 14 ], [ 15, 16 ]
]
]
]
];
var out = flatten5d( x, [ 0, 0, 0, 0, 0 ], false );
// returns []
out = flatten5d( x, [ 0, 0, 0, 0, 0 ], true );
// returns []
out = flatten5d( x, [ 1, 1, 1, 1, 1 ], false );
// returns [ 1 ]
out = flatten5d( x, [ 1, 1, 1, 1, 1 ], true );
// returns [ 1 ]
out = flatten5d( x, [ 1, 2, 1, 2, 2 ], false );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8 ]
out = flatten5d( x, [ 1, 2, 1, 2, 2 ], true );
// returns [ 1, 5, 3, 7, 2, 6, 4, 8 ]
out = flatten5d( x, [ 2, 2, 1, 2, 2 ], false );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]
out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
// returns [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.