chore: apply requested changes

Author: LoayAhmed304

lib/node_modules/@stdlib/ndarray/base/where/README.md

@@ -131,7 +131,6 @@ Each provided ndarray should be an object with the following properties:
 
 -   `condition` ndarray must be a `boolean` or `uint8` ndarray.
 -   `condition`, `x`, `y`, and `out` ndarrays must have the same shape.
--   The function **mutates** the input ndarrays shapes and strides if necessary.
 -   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before conditionally assigning elements in order to achieve better performance.
 
 </section>

lib/node_modules/@stdlib/ndarray/base/where/benchmark/benchmark.2d_rowmajor_accessors_complex.js

@@ -99,11 +99,11 @@ function createBenchmark( len, shape, ctype, xtype, ytype, otype ) {
 	var y;
 
 	cbuf = filledarrayBy( len, ctype, bernoulli( 0.5 ) );
-	xbuf = filledarrayBy( len*2, abtype[ xtype ], discreteUniform( -100, 100 ) );
-	ybuf = filledarrayBy( len*2, abtype[ ytype ], discreteUniform( -100, 100 ) );
+	xbuf = filledarrayBy( len*2, abtype[ xtype ], discreteUniform( -100, 100 ) ); // eslint-disable-line max-len
+	ybuf = filledarrayBy( len*2, abtype[ ytype ], discreteUniform( -100, 100 ) ); // eslint-disable-line max-len
 	obuf = filledarray( 0.0, len*2, abtype[ otype ] );
 
-	// broadcast extra dimension along last axis for the condition array for complex compatibility.
+	// Broadcast extra dimension along last axis for the condition array for complex compatibility.
 	stride = shape2strides( shape, order );
 	cshape = shape.slice();
 	cshape.push( 1 );

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

@@ -29,7 +29,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @param arrays - array-like object containing three input ndarrays and one output ndarray
 * @throws arrays must have the same number of dimensions
 * @throws arrays must have the same shape
-* @throws {Error} condition array must be a boolean or uint8 ndarray
+* @throws condition array must be a boolean or uint8 ndarray
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/ndarray/base/where/lib/0d_accessors.js

@@ -31,27 +31,31 @@
 * @param {IntegerArray} condition.strides - stride lengths
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} condition.accessors - data buffer accessors
 * @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} x.accessors - data buffer accessors
 * @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
 * @param {IntegerArray} y.strides - stride lengths
 * @param {NonNegativeInteger} y.offset - index offset
 * @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} y.accessors - data buffer accessors
 * @param {Object} out - object containing output ndarray meta data
 * @param {*} out.dtype - data type
 * @param {Collection} out.data - data buffer
 * @param {NonNegativeIntegerArray} out.shape - dimensions
 * @param {IntegerArray} out.strides - stride lengths
 * @param {NonNegativeInteger} out.offset - index offset
 * @param {string} out.order - specifies whether `out` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} out.accessors - data buffer accessors
 * @returns {void}
 *
 * @example

lib/node_modules/@stdlib/ndarray/base/where/lib/10d.js

@@ -33,14 +33,14 @@
 * @param {IntegerArray} condition.strides - stride lengths
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} x - object containing input ndarray meta data
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} y - object containing input ndarray meta data
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
@@ -122,7 +122,7 @@
 * console.log( out.data );
 * // => <Float64Array>[ -2.0, -3.0, 6.0, 7.0, -10.0, -11.0 ]
 */
-function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line max-statements
+function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line max-statements, max-lines-per-function
 	var cbuf;
 	var xbuf;
 	var ybuf;
@@ -333,7 +333,7 @@ function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line m
 								for ( i2 = 0; i2 < S2; i2++ ) {
 									for ( i1 = 0; i1 < S1; i1++ ) {
 										for ( i0 = 0; i0 < S0; i0++ ) {
-											obuf[ io ] = ( cbuf[ ic ] ) ? xbuf[ ix ] : ybuf[ iy ];
+											obuf[ io ] = ( cbuf[ ic ] ) ? xbuf[ ix ] : ybuf[ iy ]; // eslint-disable-line max-len
 											ic += dc0;
 											ix += dx0;
 											iy += dy0;

lib/node_modules/@stdlib/ndarray/base/where/lib/10d_accessors.js

@@ -34,15 +34,15 @@
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
 * @param {Array<Function>} condition.accessors - data buffer accessors
-* @param {Object} x - object containing input ndarray meta data
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
 * @param {Array<Function>} x.accessors - data buffer accessors
-* @param {Object} y - object containing input ndarray meta data
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
@@ -147,7 +147,7 @@
 * var im = imagf( v );
 * // returns 2.0
 */
-function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line max-statements
+function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line max-statements, max-lines-per-function
 	var cbuf;
 	var xbuf;
 	var ybuf;
@@ -368,7 +368,7 @@ function where10d( condition, x, y, out, isRowMajor ) { // eslint-disable-line m
 								for ( i2 = 0; i2 < S2; i2++ ) {
 									for ( i1 = 0; i1 < S1; i1++ ) {
 										for ( i0 = 0; i0 < S0; i0++ ) {
-											seto( obuf, io, ( getc( cbuf, ic ) ) ? getx( xbuf, ix ) : gety( ybuf, iy ) );
+											seto( obuf, io, ( getc( cbuf, ic ) ) ? getx( xbuf, ix ) : gety( ybuf, iy ) ); // eslint-disable-line max-len
 											ic += dc0;
 											ix += dx0;
 											iy += dy0;

lib/node_modules/@stdlib/ndarray/base/where/lib/10d_blocked.js

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-/* eslint-disable max-depth, max-len */
+/* eslint-disable max-depth, max-len, max-lines */
 
 'use strict';
 
@@ -39,14 +39,14 @@ var blockSize = require( '@stdlib/ndarray/base/ternary-tiling-block-size' );
 * @param {IntegerArray} condition.strides - stride lengths
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} x - object containing input ndarray meta data
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} y - object containing input ndarray meta data
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
@@ -60,7 +60,6 @@ var blockSize = require( '@stdlib/ndarray/base/ternary-tiling-block-size' );
 * @param {IntegerArray} out.strides - stride lengths
 * @param {NonNegativeInteger} out.offset - index offset
 * @param {string} out.order - specifies whether `out` is row-major (C-style) or column-major (Fortran-style)
-* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
 * @returns {void}
 *
 * @example

lib/node_modules/@stdlib/ndarray/base/where/lib/10d_blocked_accessors.js

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-/* eslint-disable max-depth, max-len */
+/* eslint-disable max-depth, max-len, max-lines */
 
 'use strict';
 
@@ -40,15 +40,15 @@ var blockSize = require( '@stdlib/ndarray/base/ternary-tiling-block-size' );
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
 * @param {Array<Function>} condition.accessors - data buffer accessors
-* @param {Object} x - object containing input ndarray meta data
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
 * @param {Array<Function>} x.accessors - data buffer accessors
-* @param {Object} y - object containing input ndarray meta data
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions

lib/node_modules/@stdlib/ndarray/base/where/lib/1d.js

@@ -31,14 +31,14 @@
 * @param {IntegerArray} condition.strides - stride lengths
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} x - object containing input ndarray meta data
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} y - object containing input ndarray meta data
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
@@ -61,7 +61,7 @@
 * // Create data buffers:
 * var cbuf = new Uint8Array( [ 1, 0, 1, 0 ] );
 * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-* var ybuf = new Float64Array( [-1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0] );
+* var ybuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 ] );
 * var obuf = new Float64Array( 4 );
 *
 * // Define the shape of the input and output arrays:
@@ -124,25 +124,23 @@ function where1d( condition, x, y, out ) {
 	var xbuf;
 	var ybuf;
 	var obuf;
-	var dc0;
-	var dx0;
-	var dy0;
-	var do0;
-	var S0;
+	var dout;
+	var dc;
+	var dx;
+	var dy;
 	var ic;
 	var ix;
 	var iy;
 	var io;
-	var i0;
-
-	// Note on variable naming convention: S#, dc#, dx#, dy#, do#, i# where # corresponds to the loop number, with `0` being the innermost loop...
+	var S;
+	var i;
 
 	// Extract loop variables: dimensions and loop offset (pointer) increments...
-	S0 = x.shape[ 0 ];
-	dc0 = condition.strides[ 0 ];
-	dx0 = x.strides[ 0 ];
-	dy0 = y.strides[ 0 ];
-	do0 = out.strides[ 0 ];
+	S = x.shape[ 0 ];
+	dc = condition.strides[ 0 ];
+	dx = x.strides[ 0 ];
+	dy = y.strides[ 0 ];
+	dout = out.strides[ 0 ];
 
 	// Set the pointers to the first indexed elements in the respective ndarrays...
 	ic = condition.offset;
@@ -157,12 +155,12 @@ function where1d( condition, x, y, out ) {
 	obuf = out.data;
 
 	// Iterate over the ndarray dimensions...
-	for ( i0 = 0; i0 < S0; i0++ ) {
+	for ( i = 0; i < S; i++ ) {
 		obuf[ io ] = ( cbuf[ ic ] ) ? xbuf[ ix ] : ybuf[ iy ];
-		ic += dc0;
-		ix += dx0;
-		iy += dy0;
-		io += do0;
+		ic += dc;
+		ix += dx;
+		iy += dy;
+		io += dout;
 	}
 }
 

lib/node_modules/@stdlib/ndarray/base/where/lib/1d_accessors.js

@@ -31,27 +31,31 @@
 * @param {IntegerArray} condition.strides - stride lengths
 * @param {NonNegativeInteger} condition.offset - index offset
 * @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} x - object containing input ndarray meta data
+* @param {Array<Function>} condition.accessors - data buffer accessors
+* @param {Object} x - object containing first input ndarray meta data
 * @param {*} x.dtype - data type
 * @param {Collection} x.data - data buffer
 * @param {NonNegativeIntegerArray} x.shape - dimensions
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
-* @param {Object} y - object containing input ndarray meta data
+* @param {Array<Function>} x.accessors - data buffer accessors
+* @param {Object} y - object containing second input ndarray meta data
 * @param {*} y.dtype - data type
 * @param {Collection} y.data - data buffer
 * @param {NonNegativeIntegerArray} y.shape - dimensions
 * @param {IntegerArray} y.strides - stride lengths
 * @param {NonNegativeInteger} y.offset - index offset
 * @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} y.accessors - data buffer accessors
 * @param {Object} out - object containing output ndarray meta data
 * @param {*} out.dtype - data type
 * @param {Collection} out.data - data buffer
 * @param {NonNegativeIntegerArray} out.shape - dimensions
 * @param {IntegerArray} out.strides - stride lengths
 * @param {NonNegativeInteger} out.offset - index offset
 * @param {string} out.order - specifies whether `out` is row-major (C-style) or column-major (Fortran-style)
+* @param {Array<Function>} out.accessors - data buffer accessors
 * @returns {void}
 *
 * @example
@@ -148,25 +152,23 @@ function where1d( condition, x, y, out ) {
 	var getx;
 	var gety;
 	var seto;
-	var dc0;
-	var dx0;
-	var dy0;
-	var do0;
-	var S0;
+	var dout;
+	var dc;
+	var dx;
+	var dy;
 	var ic;
 	var ix;
 	var iy;
 	var io;
-	var i0;
-
-	// Note on variable naming convention: S#, dc#, dx#, dy#, do#, i# where # corresponds to the loop number, with `0` being the innermost loop...
+	var i;
+	var S;
 
 	// Extract loop variables: dimensions and loop offset (pointer) increments...
-	S0 = x.shape[ 0 ];
-	dc0 = condition.strides[ 0 ];
-	dx0 = x.strides[ 0 ];
-	dy0 = y.strides[ 0 ];
-	do0 = out.strides[ 0 ];
+	S = x.shape[ 0 ];
+	dc = condition.strides[ 0 ];
+	dx = x.strides[ 0 ];
+	dy = y.strides[ 0 ];
+	dout = out.strides[ 0 ];
 
 	// Set the pointers to the first indexed elements in the respective ndarrays...
 	ic = condition.offset;
@@ -180,19 +182,19 @@ function where1d( condition, x, y, out ) {
 	ybuf = y.data;
 	obuf = out.data;
 
-	// Cache accessors
+	// Cache accessors:
 	getc = condition.accessors[ 0 ];
 	getx = x.accessors[ 0 ];
 	gety = y.accessors[ 0 ];
 	seto = out.accessors[ 1 ];
 
 	// Iterate over the ndarray dimensions...
-	for ( i0 = 0; i0 < S0; i0++ ) {
+	for ( i = 0; i < S; i++ ) {
 		seto( obuf, io, ( getc( cbuf, ic ) ) ? getx( xbuf, ix ) : gety( ybuf, iy ) ); // eslint-disable-line max-len
-		ic += dc0;
-		ix += dx0;
-		iy += dy0;
-		io += do0;
+		ic += dc;
+		ix += dx;
+		iy += dy;
+		io += dout;
 	}
 }