All files / to-unflattened/lib main.js

77.94% Statements 53/68
100% Branches 1/1
0% Functions 0/1
77.94% Lines 53/68

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 691x 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 emptyLike = require( '@stdlib/ndarray/base/empty-like' );
var unflatten = require( '@stdlib/ndarray/base/unflatten' );
var assign = require( '@stdlib/ndarray/base/assign' );
 
 
// MAIN //
 
/**
* Returns a new ndarray in which a specified dimension of an input ndarray is expanded over multiple dimensions.
*
* @param {ndarray} x - input array
* @param {integer} dim - dimension index
* @param {NonNegativeIntegerArray} sizes - new shape of the unflattened dimension
* @throws {RangeError} must provide a valid dimension index
* @throws {RangeError} product of the sizes must be equal to the size of the dimension to be unflattened
* @returns {ndarray} output array
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
*
* var y = toUnflattened( x, 0, [ 2, 3 ] );
* // returns <ndarray>[ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ]
*/
function toUnflattened( x, dim, sizes ) {
	var out;
	var xv;

	// Create an unflattened view of the input ndarray:
	xv = unflatten( x, dim, sizes, false );

	// Create an output ndarray with the same data type as the input ndarray having the unflattened shape:
	out = emptyLike( xv );

	// Assign the elements of the unflattened input ndarray view to the output ndarray:
	assign( [ xv, out ] );

	return out;
}
 
 
// EXPORTS //
 
module.exports = toUnflattened;