All files / flatten-shape/lib main.js

91.04% Statements 61/67
100% Branches 1/1
0% Functions 0/1
91.04% Lines 61/67

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 681x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x             1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var min = require( '@stdlib/math/base/special/fast/min' );
var max = require( '@stdlib/math/base/special/fast/max' );
var zeros = require( '@stdlib/array/base/zeros' );
var assign = require( './assign.js' );
 
 
// MAIN //
 
/**
* Flattens a shape to a specified depth.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {NonNegativeInteger} depth - maximum depth to flatten
* @returns {NonNegativeIntegerArray} flattened shape
*
* @example
* var sh = flattenShape( [ 3, 2 ], 1 );
* // returns [ 6 ]
*
* sh = flattenShape( [ 3, 2, 1 ], 1 );
* // returns [ 6, 1 ]
*
* sh = flattenShape( [ 3 ], 0 );
* // returns [ 3 ]
*
* sh = flattenShape( [ 3, 2 ], 0 );
* // returns [ 3, 2 ]
*
* sh = flattenShape( [ 3 ], 1 );
* // returns [ 3 ]
*
* sh = flattenShape( [], 1 );
* // returns []
*/
function flattenShape( shape, depth ) {
	var ndims = shape.length;
	var out = zeros( ndims-max( min( ndims-1, depth ), 0 ) );
	assign( shape, depth, out );
	return out;
}
 
 
// EXPORTS //
 
module.exports = flattenShape;