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 | 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) 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 isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var getShape = require( '@stdlib/ndarray/shape' );
var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
var unflatten = require( '@stdlib/ndarray/base/unflatten' );
var emptyLike = require( '@stdlib/ndarray/empty-like' );
var assign = require( '@stdlib/ndarray/base/assign' );
var format = require( '@stdlib/string/format' );
// 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 to be unflattened
* @param {NonNegativeIntegerArray} sizes - new shape of the unflattened dimension
* @throws {TypeError} first argument must be an ndarray
* @throws {TypeError} second argument must be an integer
* @throws {TypeError} third argument must be an array of nonnegative integers
* @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 ndarray
*
* @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 bv;
var sh;
var d;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
}
if ( !isInteger( dim ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be an integer. Value: `%s`.', dim ) );
}
if ( !isNonNegativeIntegerArray( sizes ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be an array of nonnegative integers. Value: `%s`.', sizes ) );
}
sh = getShape( x );
d = normalizeIndex( dim, sh.length - 1 );
if ( d === -1 ) {
throw new RangeError( format( 'invalid argument. Dimension index exceeds the number of dimensions. Number of dimensions: %d. Value: `%d`.', sh.length, dim ) );
}
bv = ndarraylike2ndarray( x );
bv = unflatten( bv, d, sizes, false );
out = emptyLike( bv );
assign( [ bv, out ] );
return out;
}
// EXPORTS //
module.exports = toUnflattened;
|