feat: add ndarray/unflatten

lib/node_modules/@stdlib/ndarray/unflatten/README.md

@@ -0,0 +1,129 @@
+<!--
+
+@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.
+
+-->
+
+# unflatten
+
+> Return a read-only view of an input [ndarray][@stdlib/ndarray/ctor] in which a specified dimension is expanded over multiple dimensions.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var unflatten = require( '@stdlib/ndarray/unflatten' );
+```
+
+#### unflatten( x, dim, sizes )
+
+Returns a read-only view of an input [ndarray][@stdlib/ndarray/ctor] in which a specified dimension is expanded over multiple dimensions.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+// Create a 1-dimensional ndarray:
+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 ]
+
+// Unflatten the first dimension:
+var y = unflatten( x, 0, [ 2, 3 ] );
+// returns <ndarray>[ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **dim**: dimension to be unflattened. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
+-   **sizes**: new shape of the unflattened dimension.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var unflatten = require( '@stdlib/ndarray/unflatten' );
+
+var x = uniform( [ 12 ], -10.0, 10.0 );
+console.log( ndarray2array( x ) );
+
+var y = unflatten( x, 0, [ 3, 4 ] );
+console.log( ndarray2array( y ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/unflatten/benchmark/benchmark.js

@@ -0,0 +1,127 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var empty = require( '@stdlib/ndarray/empty' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var unflatten = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s::1d', pkg ), function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	values = [
+		empty( [ 6 ], { 'dtype': 'float64' } ),
+		empty( [ 6 ], { 'dtype': 'float32' } ),
+		empty( [ 6 ], { 'dtype': 'int32' } ),
+		empty( [ 6 ], { 'dtype': 'complex128' } ),
+		empty( [ 6 ], { 'dtype': 'generic' } )
+	];
+
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unflatten( values[ i%values.length ], 0, [ 2, 3 ] );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s::2d', pkg ), function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	values = [
+		empty( [ 2, 6 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 6 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 6 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 6 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 6 ], { 'dtype': 'generic' } )
+	];
+
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unflatten( values[ i%values.length ], 1, [ 2, 3 ] );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s::3d', pkg ), function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	values = [
+		empty( [ 2, 2, 6 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 2, 6 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 2, 6 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 2, 6 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 2, 6 ], { 'dtype': 'generic' } )
+	];
+
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unflatten( values[ i%values.length ], 2, [ 2, 3 ] );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/unflatten/docs/repl.txt

@@ -0,0 +1,33 @@
+
+{{alias}}( x, dim, sizes )
+    Returns a read-only view of an input ndarray in which a specified dimension
+    is expanded over multiple dimensions.
+
+    Parameters
+    ----------
+    x: ndarray
+        Input array.
+
+    dim: integer
+        Dimension to be unflattened. If provided an integer less than zero,
+        the dimension index is resolved relative to the last dimension, with
+        the last dimension corresponding to the value `-1`.
+
+    sizes: ArrayLikeObject<integer>
+        New shape of the unflattened dimension.
+
+    Returns
+    -------
+    out: ndarray
+        Output array.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/array}}( [ 1, 2, 3, 4, 5, 6 ] )
+    <ndarray>[ 1, 2, 3, 4, 5, 6 ]
+    > var y = {{alias}}( x, 0, [ 2, 3 ] )
+    <ndarray>[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/ndarray/unflatten/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { typedndarray } from '@stdlib/types/ndarray';
+
+/**
+* Returns a read-only view of an input ndarray in which a specified dimension is expanded over multiple dimensions.
+*
+* @param x - input array
+* @param dim - dimension to be unflattened
+* @param sizes - new shape of the unflattened dimension
+* @returns 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 = unflatten( x, 0, [ 2, 3 ] );
+* // returns <ndarray>[ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ]
+*/
+declare function unflatten<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: U, dim: number, sizes: ArrayLike<number> ): U;
+
+
+// EXPORTS //
+
+export = unflatten;