All files assign.js

100% Statements 78/78
100% Branches 6/6
100% Functions 1/1
100% Lines 78/78

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 793x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 14x 14x 14x 14x 14x 14x 14x 14x 6x 6x 8x 8x 8x 8x 8x 8x 18x 18x 18x 8x 8x 4x 4x 4x 8x 14x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 flattenShape = require( '@stdlib/ndarray/base/flatten-shape' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Unflattens a shape over multiple dimensions.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {NonNegativeInteger} dim - dimension to be unflattened
* @param {NonNegativeIntegerArray} sizes - new shape of the unflattened dimension
* @param {NonNegativeIntegerArray} out - output array
* @throws {RangeError} - product of the sizes array must be equal to the dimension to be unflattened
* @returns {NonNegativeIntegerArray} unflattened shape
*
* @example
* var o = [ 0, 0, 0, 0 ];
*
* var out = unflattenShape( [ 6, 2, 1 ], 0, [ 3, 2 ], o );
* // returns [ 3, 2, 2, 1 ]
*
* var bool = ( out === o );
* // returns true
*/
function unflattenShape( shape, dim, sizes, out ) {
	var s;
	var i;
	var j;
	var k;
 
	s = flattenShape( sizes, sizes.length-1 );
	if ( shape[ dim ] !== s[ 0 ] ) {
		throw new RangeError( format( 'invalid argument. Product of the sizes array must be equal to the dimension to be unflattened. Dim: `%d`. Product: `%d`.', shape[dim], s[0] ) );
	}
	for ( i = 0; i < dim; i++ ) {
		out[ i ] = shape[ i ];
	}
	j = 0;
	k = dim + sizes.length - 1;
	for ( i = dim; i <= k; i++ ) {
		out[ i ] = sizes[ j ];
		j += 1;
	}
	j = shape.length - 1;
	for ( i = out.length-1; i > k; i-- ) {
		out[ i ] = shape[ j ];
		j -= 1;
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = unflattenShape;