chore: clean-up

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # unflattenShape
 
-> Unflatten a shape over multiple dimensions.
+> Expand a dimension 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. -->
 
@@ -42,7 +42,7 @@ var unflattenShape = require( '@stdlib/ndarray/base/unflatten-shape' );
 
 #### unflattenShape( shape, dim, sizes )
 
-Unflattens a shape over multiple dimensions.
+Expands a dimension over multiple dimensions.
 
 ```javascript
 var sh = unflattenShape( [ 6, 2, 1 ], 0, [ 3, 2 ] );
@@ -52,12 +52,12 @@ var sh = unflattenShape( [ 6, 2, 1 ], 0, [ 3, 2 ] );
 The function accepts the following parameters:
 
 -   **shape**: array shape.
--   **dim**: dimension to be unflattened.
+-   **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.
 
 #### unflattenShape.assign( shape, dim, sizes, out )
 
-Unflattens a shape over multiple dimensions and assigns results to a provided output array.
+Expands a dimension over multiple dimensions and assigns results to a provided output array.
 
 ```javascript
 var o = [ 0, 0, 0, 0 ];
@@ -72,7 +72,7 @@ var bool = ( out === o );
 The function accepts the following parameters:
 
 -   **shape**: array shape.
--   **dim**: dimension to be unflattened.
+-   **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.
 -   **out**: output array.
 
@@ -102,7 +102,11 @@ var unflattenShape = require( '@stdlib/ndarray/base/unflatten-shape' );
 var out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 2 ] );
 // returns [ 2, 2, 2, 1 ]
 
-console.log( 'Unflattened Shape: ', out );
+out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 1, 2 ] );
+// returns [ 2, 2, 1, 2, 1 ]
+
+out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 1, 1, 2 ] );
+// returns [ 2, 2, 1, 1, 2, 1 ]
 ```
 
 </section>

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/docs/repl.txt

@@ -1,21 +1,23 @@
 
 {{alias}}( shape, dim, sizes )
-    Unflattens a shape over multiple dimensions.
+    Expands a dimension over multiple dimensions.
 
     Parameters
     ----------
-    shape: ArrayLike
+    shape: ArrayLike<number>
         Array shape.
 
     dim: integer
-        Dimension to be unflattened.
+        Dimension to be unflattened. If less than zero, the index is resolved
+        relative to the last dimension, with the last dimension corresponding to
+        the value `-1`.
 
-    sizes: ArrayLike
+    sizes: ArrayLike<number>
         New shape of the unflattened dimension.
 
     Returns
     -------
-    out: Array
+    out: Array<number>
         Unflattened shape.
 
     Examples
@@ -27,18 +29,20 @@
 
 
 {{alias}}.assign( shape, dim, sizes, out )
-    Unflattens a shape over multiple dimensions and assigns results to a
+    Expands a dimension over multiple dimensions and assigns results to a
     provided output array.
 
     Parameters
     ----------
-    shape: ArrayLike
+    shape: ArrayLike<number>
         Array shape.
 
     dim: integer
-        Dimension to be unflattened.
+        Dimension to be unflattened. If less than zero, the index is resolved
+        relative to the last dimension, with the last dimension corresponding to
+        the value `-1`.
 
-    sizes: ArrayLike
+    sizes: ArrayLike<number>
         New shape of the unflattened dimension.
 
     out: Array|TypedArray|Object

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

@@ -20,12 +20,14 @@
 
 /// <reference types="@stdlib/types"/>
 
+import { ArrayLike } from '@stdlib/types/array';
+
 /**
-* Interface describing `unflattenShape`
+* Interface describing `unflattenShape`.
 */
 interface Routine {
 	/**
-	* Unflattens a shape over multiple dimensions.
+	* Expands a dimension over multiple dimensions.
 	*
 	* @param shape - array shape
 	* @param dim - dimension to be unflattened
@@ -36,10 +38,10 @@ interface Routine {
 	* var sh = unflattenShape( [ 6, 2, 1 ], 0, [ 3, 2 ] );
 	* // returns [ 3, 2, 2, 1 ]
 	*/
-	( shape: Array<number>, dim: number, sizes: Array<number> ): Array<number>;
+	( shape: ArrayLike<number>, dim: number, sizes: ArrayLike<number> ): Array<number>;
 
 	/**
-	* Unflattens a shape over multiple dimensions.
+	* Expands a dimension over multiple dimensions.
 	*
 	* @param shape - array shape
 	* @param dim - dimension to be unflattened
@@ -56,11 +58,11 @@ interface Routine {
 	* var bool = ( out === o );
 	* // returns true
 	*/
-	assign( shape: Array<number>, dim: number, sizes: Array<number>, out: Array<number> ): Array<number>;
+	assign<T extends ArrayLike<number> = ArrayLike<number>>( shape: ArrayLike<number>, dim: number, sizes: ArrayLike<number>, out: T ): T;
 }
 
 /**
-* Unflattens a shape over multiple dimensions.
+* Expands a dimension over multiple dimensions.
 *
 * @param shape - array shape
 * @param dim - dimension to be unflattened

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/docs/types/test.ts

@@ -26,7 +26,7 @@ import unflattenShape = require( './index' );
 	unflattenShape( [ 6, 2, 1 ], 1, [ 3, 2 ] ); // $ExpectType number[]
 }
 
-// The compiler throws an error if the function is provided a first argument that is not an array-like object containing numbers...
+// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers...
 {
 	unflattenShape( true, 1, [ 3, 2 ] ); // $ExpectError
 	unflattenShape( false, 1, [ 3, 2 ] ); // $ExpectError
@@ -38,7 +38,7 @@ import unflattenShape = require( './index' );
 	unflattenShape( ( x: number ): number => x, 1, [ 3, 2 ] ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument that is not a number...
+// The compiler throws an error if the function is provided a second argument which is not a number...
 {
 	unflattenShape( [ 6, 2, 1 ], true, [ 3, 2 ] ); // $ExpectError
 	unflattenShape( [ 6, 2, 1 ], false, [ 3, 2 ] ); // $ExpectError
@@ -50,7 +50,7 @@ import unflattenShape = require( './index' );
 	unflattenShape( [ 6, 2, 1 ], ( x: number ): number => x, [ 3, 2 ] ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a third argument that is not an array-like object containing numbers...
+// The compiler throws an error if the function is provided a third argument which is not an array-like object containing numbers...
 {
 	unflattenShape( [ 6, 2, 1 ], 1, true ); // $ExpectError
 	unflattenShape( [ 6, 2, 1 ], 1, false ); // $ExpectError
@@ -70,12 +70,12 @@ import unflattenShape = require( './index' );
 	unflattenShape( [ 6, 2, 1 ], 1, [ 3, 2 ], {} ); // $ExpectError
 }
 
-// The assign method returns an array of numbers...
+// The `assign` method returns an array of numbers...
 {
 	unflattenShape.assign( [ 6, 2, 1 ], 1, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectType number[]
 }
 
-// The compiler throws an error if the assign method is provided a first argument that is not an array-like object containing numbers...
+// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object containing numbers...
 {
 	unflattenShape.assign( true, 1, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
 	unflattenShape.assign( false, 1, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
@@ -87,7 +87,7 @@ import unflattenShape = require( './index' );
 	unflattenShape.assign( ( x: number ): number => x, 1, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
 }
 
-// The compiler throws an error if the assign method is provided a second argument that is not a number...
+// The compiler throws an error if the `assign` method is provided a second argument which is not a number...
 {
 	unflattenShape.assign( [ 6, 2, 1 ], true, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
 	unflattenShape.assign( [ 6, 2, 1 ], false, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
@@ -99,7 +99,7 @@ import unflattenShape = require( './index' );
 	unflattenShape.assign( [ 6, 2, 1 ], ( x: number ): number => x, [ 3, 2 ], [ 0, 0, 0, 0 ] ); // $ExpectError
 }
 
-// The compiler throws an error if the assign method is provided a third argument that is not an array-like object containing numbers...
+// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object containing numbers...
 {
 	unflattenShape.assign( [ 6, 2, 1 ], 1, true, [ 0, 0, 0, 0 ] ); // $ExpectError
 	unflattenShape.assign( [ 6, 2, 1 ], 1, false, [ 0, 0, 0, 0 ] ); // $ExpectError
@@ -111,7 +111,7 @@ import unflattenShape = require( './index' );
 	unflattenShape.assign( [ 6, 2, 1 ], 1, ( x: number ): number => x, [ 0, 0, 0, 0 ] ); // $ExpectError
 }
 
-// The compiler throws an error if the assign method is provided a fourth argument that is not an array-like object containing numbers...
+// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object containing numbers...
 {
 	unflattenShape.assign( [ 6, 2, 1 ], 1, [ 3, 2 ], true ); // $ExpectError
 	unflattenShape.assign( [ 6, 2, 1 ], 1, [ 3, 2 ], false ); // $ExpectError
@@ -123,7 +123,7 @@ import unflattenShape = require( './index' );
 	unflattenShape.assign( [ 6, 2, 1 ], 1, [ 3, 2 ], ( x: number ): number => x ); // $ExpectError
 }
 
-// The compiler throws an error if the assign method is provided an unsupported number of arguments...
+// The compiler throws an error if the `assign` method is provided an unsupported number of arguments...
 {
 	unflattenShape.assign(); // $ExpectError
 	unflattenShape.assign( [ 6, 2, 1 ] ); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/examples/index.js

@@ -21,6 +21,13 @@
 var unflattenShape = require( './../lib' );
 
 var out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 2 ] );
-// returns [ 2, 2, 2, 1 ]
+console.log( out );
+// => [ 2, 2, 2, 1 ]
 
-console.log( 'Unflattened Shape: ', out );
+out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 1, 2 ] );
+console.log( out );
+// => [ 2, 2, 1, 2, 1 ]
+
+out = unflattenShape( [ 2, 4, 1 ], 1, [ 2, 1, 1, 2 ] );
+console.log( out );
+// => [ 2, 2, 1, 1, 2, 1 ]

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/lib/assign.js

@@ -20,20 +20,23 @@
 
 // MODULES //
 
-var flattenShape = require( '@stdlib/ndarray/base/flatten-shape' );
+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 //
 
 /**
-* Unflattens a shape over multiple dimensions.
+* Expands a dimension over multiple dimensions.
 *
 * @param {NonNegativeIntegerArray} shape - array shape
-* @param {NonNegativeInteger} dim - dimension to be unflattened
+* @param {integer} 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
+* @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
@@ -46,28 +49,37 @@ var format = require( '@stdlib/string/format' );
 * // returns true
 */
 function unflattenShape( shape, dim, sizes, out ) {
-	var s;
+	var S1;
+	var S2;
+	var N;
+	var d;
 	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] ) );
+	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 ) );
 	}
-	for ( i = 0; i < dim; i++ ) {
+	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;
-	k = dim + sizes.length - 1;
-	for ( i = dim; i <= k; i++ ) {
+	for ( ; i < d+S2; 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;
+	j = d + 1;
+	if ( j < S1 ) {
+		for ( ; i < S1+S2-1; i++ ) {
+			out[ i ] = shape[ j ];
+			j += 1;
+		}
 	}
 	return out;
 }

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Unflatten a shape over multiple dimensions.
+* Expand a dimension over multiple dimensions.
 *
 * @module @stdlib/ndarray/base/unflatten-shape
 *

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/lib/main.js

@@ -27,11 +27,13 @@ var assign = require( './assign.js' );
 // MAIN //
 
 /**
-* Unflattens a shape over multiple dimensions.
+* Expands a dimension over multiple dimensions.
 *
 * @param {NonNegativeIntegerArray} shape - array shape
-* @param {NonNegativeInteger} dim - dimension to be unflattened
+* @param {integer} dim - dimension to be unflattened
 * @param {NonNegativeIntegerArray} sizes - new shape of the unflattened dimension
+* @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

lib/node_modules/@stdlib/ndarray/base/unflatten-shape/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/ndarray/base/unflatten-shape",
   "version": "0.0.0",
-  "description": "Unflatten a shape over multiple dimensions.",
+  "description": "Expand a dimension over multiple dimensions.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",