refactor: apply suggestions from code review

headlessNode · headlessNode · commit 1a526a608326 · 2025-12-05T01:35:41.000+05:00
diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts
@@ -38,12 +38,11 @@ interface Concat1d {
 	* @example
 	* var array = require( '@stdlib/ndarray/array' );
 	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	*
 	* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 	* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
 	*
-	* var out = concat1d( [ x, y ] );
+	* var out = concat1d( x, y );
 	* // returns <ndarray>
 	*
 	* var arr = ndarray2array( out );
@@ -60,7 +59,6 @@ interface Concat1d {
 	* @example
 	* var array = require( '@stdlib/ndarray/array' );
 	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
-	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	*
 	* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 	* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -125,7 +123,7 @@ interface Concat1d {
 	* var arr = ndarray2array( z );
 	* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
 	*/
-	assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( ...args: Array<Input<T>> ): V;
+	assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( ...args: Array<Input<T> | V> ): V;
 }
 
 /**
@@ -137,12 +135,11 @@ interface Concat1d {
 * @example
 * var array = require( '@stdlib/ndarray/array' );
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
 *
-* var out = concat1d( [ x, y ] );
+* var out = concat1d( x, y );
 * // returns <ndarray>
 *
 * var arr = ndarray2array( out );
diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js
@@ -28,7 +28,6 @@ var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
 var broadcastArray = require( '@stdlib/ndarray/broadcast-array' );
 var format = require( '@stdlib/string/format' );
 var defaults = require( '@stdlib/ndarray/defaults' );
-var normalizeArrays = require( './normalize_arrays.js' );
 var resolveDataTypes = require( './resolve_dtypes.js' );
 var resolveOrder = require( './resolve_order.js' );
 
@@ -44,9 +43,9 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
 /**
 * Concatenates provided input arguments and assigns the result to a provided one-dimensional output ndarray.
 *
-* @param {...*} args - input arguments
+* @param {...*} arguments - input arguments
 * @param {ndarray} out - output ndarray
-* @throws {Error} function must be provided an array of inputs or more than one separate input arguments and an output ndarray
+* @throws {Error} function must be provided an array of inputs or more than one separate input argument and an output ndarray
 * @throws {RangeError} function must be provided a one-dimensional ndarray or a zero-dimensional ndarray
 * @throws {Error} output argument must be a one-dimensional ndarray-like object
 * @returns {ndarray} output ndarray
@@ -83,7 +82,7 @@ function assign() {
 
 	// Resolve function arguments...
 	if ( nargs < 2 ) {
-		throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input arguments and an output ndarray. Value: `%s`.', nargs ) );
+		throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input argument and an output ndarray. Value: `%s`.', nargs ) );
 	}
 	if ( nargs > 2 ) {
 		args = [];
@@ -104,23 +103,26 @@ function assign() {
 		throw new Error( format( 'invalid argument. Output argument must be a one-dimensional ndarray. Value: `%s`.', out ) );
 	}
 
-	// Resolve the `dtype` and `order` of input ndarrays...
+	// Resolve the `dtype` and `order` of input ndarrays:
 	arrs = [];
 	for ( i = 0; i < args.length; i++ ) {
 		if ( isndarrayLike( args[ i ] ) ) {
 			d = ndims( args[ i ] );
 			if ( d > 1 ) {
-				throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray.. Value: `%s`.', d ) );
+				throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray. Value: `%s`.', d ) );
 			}
 			arrs.push( args[ i ] );
 		}
 	}
 	if ( arrs.length >= 1 ) {
 		dt = resolveDataTypes( arrs );
 		ord = resolveOrder( arrs );
+	} else {
+		dt = DEFAULT_DTYPE;
+		ord = DEFAULT_ORDER;
 	}
 
-	// Broadcast scalar or 0d ndarray inputs...
+	// Broadcast scalar or 0d ndarray inputs:
 	for ( i = 0; i < args.length; i++ ) {
 		if ( isndarrayLike( args[ i ] ) ) {
 			if ( ndims( args[ i ] ) === 0 ) {
@@ -132,7 +134,7 @@ function assign() {
 			args[ i ] = broadcastScalar( args[ i ], dt, [ 1 ], ord );
 		}
 	}
-	return concat.assign( normalizeArrays( args ), out );
+	return concat.assign( args, out );
 }
 
 
diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js
@@ -26,7 +26,6 @@
 * @example
 * var array = require( '@stdlib/ndarray/array' );
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var concat1d = require( '@stdlib/ndarray/concat1d' );
 *
 * var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js
@@ -28,7 +28,6 @@ var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
 var broadcastArray = require( '@stdlib/ndarray/broadcast-array' );
 var format = require( '@stdlib/string/format' );
 var defaults = require( '@stdlib/ndarray/defaults' );
-var normalizeArrays = require( './normalize_arrays.js' );
 var resolveDataTypes = require( './resolve_dtypes.js' );
 var resolveOrder = require( './resolve_order.js' );
 
@@ -44,15 +43,14 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
 /**
 * Returns a one-dimensional ndarray formed by concatenating the provided input arguments.
 *
-* @param {...*} args - input arguments
-* @throws {Error} function must be provided an array of inputs or more than one separate input arguments
+* @param {...*} arguments - input arguments
+* @throws {Error} function must be provided an array of inputs or more than one separate input argument
 * @throws {RangeError} function must be provided a one-dimensional ndarray or a zero-dimensional ndarray
 * @returns {ndarray} output ndarray
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -76,7 +74,7 @@ function concat1d() {
 
 	// Resolve function arguments...
 	if ( nargs < 1 ) {
-		throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input arguments. Value: `%s`.', nargs ) );
+		throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input argument. Value: `%s`.', nargs ) );
 	}
 	if ( nargs > 1 ) {
 		args = [];
@@ -93,35 +91,36 @@ function concat1d() {
 		}
 	}
 
-	// Resolve the `dtype` and `order` of input ndarrays...
+	// Resolve the `dtype` and `order` of input ndarrays:
 	arrs = [];
 	for ( i = 0; i < args.length; i++ ) {
 		if ( isndarrayLike( args[ i ] ) ) {
 			d = ndims( args[ i ] );
 			if ( d > 1 ) {
-				throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray.. Value: `%s`.', d ) );
+				throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray. Value: `%s`.', d ) );
 			}
 			arrs.push( args[ i ] );
 		}
 	}
 	if ( arrs.length >= 1 ) {
 		dt = resolveDataTypes( arrs );
 		ord = resolveOrder( arrs );
+	} else {
+		dt = DEFAULT_DTYPE;
+		ord = DEFAULT_ORDER;
 	}
 
-	// Broadcast scalar or 0d ndarray inputs...
+	// Broadcast scalar or 0d ndarray inputs:
 	for ( i = 0; i < args.length; i++ ) {
 		if ( isndarrayLike( args[ i ] ) ) {
 			if ( ndims( args[ i ] ) === 0 ) {
 				args[ i ] = broadcastArray( args[ i ], [ 1 ] );
 			}
-		} else if ( !dt && !ord ) {
-			args[ i ] = broadcastScalar( args[ i ], DEFAULT_DTYPE, [ 1 ], DEFAULT_ORDER ); // eslint-disable-line max-len
 		} else {
 			args[ i ] = broadcastScalar( args[ i ], dt, [ 1 ], ord );
 		}
 	}
-	return concat( normalizeArrays( args ) );
+	return concat( args );
 }
 
 
diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/package.json b/lib/node_modules/@stdlib/ndarray/concat1d/package.json
@@ -62,6 +62,9 @@
     "append",
     "add",
     "concat1d",
-    "concatenating"
+    "concatenating",
+    "join",
+    "merge",
+    "combine"
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,11 @@ interface Concat1d {`
`38`	`38`	`* @example`
`39`	`39`	`* var array = require( '@stdlib/ndarray/array' );`
`40`	`40`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`41`		`- * var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`42`	`41`	`*`
`43`	`42`	`* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );`
`44`	`43`	`* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );`
`45`	`44`	`*`
`46`		`- * var out = concat1d( [ x, y ] );`
	`45`	`+ * var out = concat1d( x, y );`
`47`	`46`	`* // returns <ndarray>`
`48`	`47`	`*`
`49`	`48`	`* var arr = ndarray2array( out );`
`@@ -60,7 +59,6 @@ interface Concat1d {`
`60`	`59`	`* @example`
`61`	`60`	`* var array = require( '@stdlib/ndarray/array' );`
`62`	`61`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`63`		`- * var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`64`	`62`	`*`
`65`	`63`	`* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );`
`66`	`64`	`* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );`
`@@ -125,7 +123,7 @@ interface Concat1d {`
`125`	`123`	`* var arr = ndarray2array( z );`
`126`	`124`	`* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]`
`127`	`125`	`*/`
`128`		`- assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( ...args: Array<Input<T>> ): V;`
	`126`	`+ assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( ...args: Array<Input<T> \| V> ): V;`
`129`	`127`	`}`
`130`	`128`
`131`	`129`	`/**`
`@@ -137,12 +135,11 @@ interface Concat1d {`
`137`	`135`	`* @example`
`138`	`136`	`* var array = require( '@stdlib/ndarray/array' );`
`139`	`137`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`140`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`141`	`138`	`*`
`142`	`139`	`* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );`
`143`	`140`	`* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );`
`144`	`141`	`*`
`145`		`-* var out = concat1d( [ x, y ] );`
	`142`	`+* var out = concat1d( x, y );`
`146`	`143`	`* // returns <ndarray>`
`147`	`144`	`*`
`148`	`145`	`* var arr = ndarray2array( out );`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@`
`26`	`26`	`* @example`
`27`	`27`	`* var array = require( '@stdlib/ndarray/array' );`
`28`	`28`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`29`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`30`	`29`	`* var concat1d = require( '@stdlib/ndarray/concat1d' );`
`31`	`30`	`*`
`32`	`31`	`* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );`
`28`	`28`	`var broadcastArray = require( '@stdlib/ndarray/broadcast-array' );`
`29`	`29`	`var format = require( '@stdlib/string/format' );`
`30`	`30`	`var defaults = require( '@stdlib/ndarray/defaults' );`
`31`		`-var normalizeArrays = require( './normalize_arrays.js' );`
`32`	`31`	`var resolveDataTypes = require( './resolve_dtypes.js' );`
`33`	`32`	`var resolveOrder = require( './resolve_order.js' );`
`34`	`33`
`@@ -44,15 +43,14 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );`
`44`	`43`	`/**`
`45`	`44`	`* Returns a one-dimensional ndarray formed by concatenating the provided input arguments.`
`46`	`45`	`*`
`47`		`-* @param {...*} args - input arguments`
`48`		`-* @throws {Error} function must be provided an array of inputs or more than one separate input arguments`
	`46`	`+* @param {...*} arguments - input arguments`
	`47`	`+* @throws {Error} function must be provided an array of inputs or more than one separate input argument`
`49`	`48`	`* @throws {RangeError} function must be provided a one-dimensional ndarray or a zero-dimensional ndarray`
`50`	`49`	`* @returns {ndarray} output ndarray`
`51`	`50`	`*`
`52`	`51`	`* @example`
`53`	`52`	`* var array = require( '@stdlib/ndarray/array' );`
`54`	`53`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`55`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`56`	`54`	`*`
`57`	`55`	`* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );`
`58`	`56`	`* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );`
`@@ -76,7 +74,7 @@ function concat1d() {`
`76`	`74`
`77`	`75`	`// Resolve function arguments...`
`78`	`76`	`if ( nargs < 1 ) {`
`79`		- throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input arguments. Value: `%s`.', nargs ) );
	`77`	+ throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input argument. Value: `%s`.', nargs ) );
`80`	`78`	`}`
`81`	`79`	`if ( nargs > 1 ) {`
`82`	`80`	`args = [];`
`@@ -93,35 +91,36 @@ function concat1d() {`
`93`	`91`	`}`
`94`	`92`	`}`
`95`	`93`
`96`		- // Resolve the `dtype` and `order` of input ndarrays...
	`94`	+ // Resolve the `dtype` and `order` of input ndarrays:
`97`	`95`	`arrs = [];`
`98`	`96`	`for ( i = 0; i < args.length; i++ ) {`
`99`	`97`	`if ( isndarrayLike( args[ i ] ) ) {`
`100`	`98`	`d = ndims( args[ i ] );`
`101`	`99`	`if ( d > 1 ) {`
`102`		- throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray.. Value: `%s`.', d ) );
	`100`	+ throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray. Value: `%s`.', d ) );
`103`	`101`	`}`
`104`	`102`	`arrs.push( args[ i ] );`
`105`	`103`	`}`
`106`	`104`	`}`
`107`	`105`	`if ( arrs.length >= 1 ) {`
`108`	`106`	`dt = resolveDataTypes( arrs );`
`109`	`107`	`ord = resolveOrder( arrs );`
	`108`	`+ } else {`
	`109`	`+ dt = DEFAULT_DTYPE;`
	`110`	`+ ord = DEFAULT_ORDER;`
`110`	`111`	`}`
`111`	`112`
`112`		`- // Broadcast scalar or 0d ndarray inputs...`
	`113`	`+ // Broadcast scalar or 0d ndarray inputs:`
`113`	`114`	`for ( i = 0; i < args.length; i++ ) {`
`114`	`115`	`if ( isndarrayLike( args[ i ] ) ) {`
`115`	`116`	`if ( ndims( args[ i ] ) === 0 ) {`
`116`	`117`	`args[ i ] = broadcastArray( args[ i ], [ 1 ] );`
`117`	`118`	`}`
`118`		`- } else if ( !dt && !ord ) {`
`119`		`- args[ i ] = broadcastScalar( args[ i ], DEFAULT_DTYPE, [ 1 ], DEFAULT_ORDER ); // eslint-disable-line max-len`
`120`	`119`	`} else {`
`121`	`120`	`args[ i ] = broadcastScalar( args[ i ], dt, [ 1 ], ord );`
`122`	`121`	`}`
`123`	`122`	`}`
`124`		`- return concat( normalizeArrays( args ) );`
	`123`	`+ return concat( args );`
`125`	`124`	`}`
`126`	`125`
`127`	`126`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,9 @@`
`62`	`62`	`"append",`
`63`	`63`	`"add",`
`64`	`64`	`"concat1d",`
`65`		`- "concatenating"`
	`65`	`+ "concatenating",`
	`66`	`+ "join",`
	`67`	`+ "merge",`
	`68`	`+ "combine"`
`66`	`69`	`]`
`67`	`70`	`}`