Flatten

Flattens an array.

Installation

$ npm install compute-flatten

For use in the browser, use browserify.

Usage

var flatten = require( 'compute-flatten' );

flatten( arr[, options] )

Flattens an array.

var arr = [ 1, [2, [3, [4, [ 5 ], 6], 7], 8], 9 ];

var out = flatten( arr );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]

The function accepts the following options:

• depth: nonnegative integer specifying the depth to which the input array should be flattened. Default: Number.POSITIVE_INFINITY.
• matrix: boolean indicating whether the function can assume that the input array is a matrix; i.e., an array (of arrays) having uniform dimensions. Default: false.
• copy: boolean indicating whether array elements should be deep copied. Default: false.

To limit the depth to which the input array is flattened, set the depth option:

var opts = {
	'depth': 2	
};

var out = flatten( arr, opts );
// returns [ 1, 2, 3, [4, [ 5 ], 6], 7, 8, 9 ]

To deep copy array elements, set the copy option to true.

var opts = {
	'depth': 2,
	'copy': true
};

var out = flatten( arr, opts );
// returns [ 1, 2, 3, [4, [ 5 ], 6], 7, 8, 9 ]

console.log( arr[1][1][1] === out[3] );
// returns false

To indicate that the function may assume that the input array is a matrix, set the matrix option to true.

var arr = [
	[ 1, 2, 3 ],
	[ 4, 5, 6 ],
	[ 7, 8, 9 ]
];

var opts = {
	'matrix': true
};

var out = flatten( arr, opts );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]

Notes:

• this function handles the generic case where an array may be heterogeneous (contain mixed data types) or have unknown dimensions.
• if repeatedly flattening arrays having the same dimensions, create a customized flatten function, as documented below.

flatten.createFlatten( dims[, options] )

Returns a customized function for flattening arrays having specified dimensions.

var dims = [ 3, 3 ];

// Create a flatten function customized for flattening 3x3 arrays:
var flat = flatten.createFlatten( dims );

var arr = [
	[ 1, 2, 3 ],
	[ 4, 5, 6 ],
	[ 7, 8, 9 ]
];

var out = flat( arr );
// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ]

The function accepts the following options:

• copy: boolean indicating whether array elements should be deep copied. Default: false.

To deep copy array elements, set the copy option to true.

var dims = [ 3, 3 ];

var opts = {
	'copy': true
};

var flat = flatten.createFlatten( dims, opts );

var arr = [
	[ 1, 2, 3 ],
	[ 4, {'x':5}, 6 ],
	[ 7, 8, 9 ]
];

var out = flat( arr );
// returns [ 1, 2, 3, 4, {'x':5}, 6, 7, 8, 9 ]

console.log( arr[1][1] === out[4] );
// returns false

Notes:

• when repeatedly flattening arrays having the same shape, creating and applying a customized flatten function will provide performance benefits.
• no attempt is made to validate that input arrays actually have the specified dimensions. Input values are assumed to be valid arrays. If validation is needed, see validate.io-size.

Examples

var flatten = require( 'compute-flatten' );

var xStride,
	yStride,
	zStride,
	data,
	tmp1,
	tmp2,
	arr,
	val,
	N, M, L,
	i, j, k;

N = 1000;
M = 100;
L = 10;

// Create an NxMxL (3D) array...
data = new Array( N );
for ( i = 0; i < N; i++ ) {
	tmp1 = new Array( M );
	for ( j = 0; j < M; j++ ) {
		tmp2 = new Array( L );
		for ( k = 0; k < L; k++ ) {
			tmp2[ k ] = M*L*i + j*L + k + 1;
		}
		tmp1[ j ] = tmp2;
	}
	data[ i ] = tmp1;
}
// Create a flattened (strided) array:
arr = flatten( data );

// To access the data[4][20][2] element...
xStride = M * L;
yStride = L;
zStride = 1;
val = arr[ 4*xStride + 20*yStride + 2*zStride ];

console.log( val );
// returns 4203

console.log( data[4][20][2] === val );
// returns true

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.