All files / unflatten-shape/lib assign.js

61.11% Statements 55/90
100% Branches 1/1
0% Functions 0/1
61.11% Lines 55/90

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 911x 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) 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 numel = require( '@stdlib/ndarray/base/numel' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Expands a dimension over multiple dimensions.
*
* @param {NonNegativeIntegerArray} shape - array shape
* @param {integer} dim - dimension to be unflattened
* @param {NonNegativeIntegerArray} sizes - new shape of the unflattened dimension
* @param {NonNegativeIntegerArray} out - output array
* @throws {RangeError} second argument is out-of-bounds
* @throws {RangeError} product of the sizes must be equal to the size of 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 S1;
	var S2;
	var N;
	var d;
	var i;
	var j;

	S1 = shape.length;
	d = normalizeIndex( dim, S1-1 );
	if ( d < 0 ) {
		throw new RangeError( format( 'invalid argument. Dimension index exceeds the number of dimensions. Number of dimensions: %d. Value: `%d`.', S1, dim ) );
	}
	S2 = sizes.length;
	N = numel( sizes );
	if ( N !== shape[ d ] ) {
		throw new RangeError( format( 'invalid argument. Product of the sizes must be equal to the size of the dimension to be unflattened. Dimension: %d. Size: %d. Value: `[%s]`.', d, shape[ d ], join( sizes, ', ' ) ) );
	}
	for ( i = 0; i < d; i++ ) {
		out[ i ] = shape[ i ];
	}
	j = 0;
	for ( ; i < d+S2; i++ ) {
		out[ i ] = sizes[ j ];
		j += 1;
	}
	j = d + 1;
	if ( j < S1 ) {
		for ( ; i < S1+S2-1; i++ ) {
			out[ i ] = shape[ j ];
			j += 1;
		}
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = unflattenShape;