All files / flatten-shape-from/lib main.js

79.34% Statements 73/92
100% Branches 1/1
0% Functions 0/1
79.34% Lines 73/92

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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 931x 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 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 zeros = require( '@stdlib/array/base/zeros' );
var assign = require( './assign.js' );
 
 
// MAIN //
 
/**
* Flattens a shape starting from a specified dimension.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {integer} dim - dimension to start flattening from
* @returns {NonNegativeIntegerArray} flattened shape
*
* @example
* var sh = flattenShapeFrom( [ 3, 3, 2 ], 1 );
* // returns [ 3, 6 ]
*
* sh = flattenShapeFrom( [ 3, 2, 1 ], 1 );
* // returns [ 3, 2 ]
*
* sh = flattenShapeFrom( [ 3 ], 0 );
* // returns [ 3 ]
*
* sh = flattenShapeFrom( [ 3, 2 ], 0 );
* // returns [ 6 ]
*
* sh = flattenShapeFrom( [], 0 );
* // returns []
*
* @example
* var sh = flattenShapeFrom( [ 3, 3, 2 ], -2 );
* // returns [ 3, 6 ]
*
* sh = flattenShapeFrom( [ 3, 2, 1 ], -2 );
* // returns [ 3, 2 ]
*
* sh = flattenShapeFrom( [ 3 ], -1 );
* // returns [ 3 ]
*
* sh = flattenShapeFrom( [ 3, 2 ], -2 );
* // returns [ 6 ]
*
* sh = flattenShapeFrom( [], -1 );
* // returns []
*/
function flattenShapeFrom( shape, dim ) {
	var ndims;
	var out;
	var d;

	ndims = shape.length;

	// Normalize the dimension index...
	if ( dim < 0 ) {
		dim += ndims;
		if ( dim < 0 ) {
			dim = 0;
		}
	}
	d = min( ndims-1, dim );
	out = zeros( d+1 );
	assign( shape, d, out );
	return out;
}
 
 
// EXPORTS //
 
module.exports = flattenShapeFrom;