refactor: update implementation, fix TypeScript annotations, and clean-up

Ref: #1374
Ref: 4253607

Author: kgryte

lib/node_modules/@stdlib/array/base/with/README.md

@@ -18,9 +18,9 @@ limitations under the License.
 
 -->
 
-# withArray
+# arrayWith
 
-> Return a new array after replacing an index with a given value.
+> Return a new array with the element at the specified index replaced with a provided value.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -37,21 +37,21 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var withArray = require( '@stdlib/array/base/with' );
+var arrayWith = require( '@stdlib/array/base/with' );
 ```
 
-#### withArray( x, index, value )
+#### arrayWith( x, index, value )
 
-Return a new array after updating an index into the input array.
+Returns a new array with the element at the specified index replaced with a provided value.
 
 ```javascript
 var x = [ 1, 2, 3, 4 ];
 
-var out = withArray( x, 0, 5 );
-// returns [5, 2, 3, 4]
+var out = arrayWith( x, 0, 5 );
+// returns [ 5, 2, 3, 4 ]
 
-out = withArray( x, -1, 6 );
-// returns [1, 2, 3, 6]
+out = arrayWith( x, -1, 6 );
+// returns [ 1, 2, 3, 6 ]
 
 ```
 
@@ -77,12 +77,10 @@ The function accepts the following arguments:
     x.with( index, value )
     ```
 
-    If provided an array-like object without a `with` method, the function manually shallow copied that object and assign provided value to that index.
+    If provided an array-like object without a `with` method, the function shallow copies input array data to a new generic array, normalizes a provided index, and sets a specified element.
 
 -   Negative indices are resolved relative to the last array element, with the last element corresponding to `-1`.
 
--   If provided out-of-bounds indices, the function always returns `undefined`.
-
 </section>
 
 <!-- /.notes -->
@@ -96,29 +94,25 @@ The function accepts the following arguments:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteuniform = require( '@stdlib/random/array/discrete-uniform' );
-var withArray = require( '@stdlib/array/base/with' );
-var rand = require( '@stdlib/random/base/randu' );
-var x;
-var indices;
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var arrayWith = require( '@stdlib/array/base/with' );
 
 // Define an array:
-x = discreteuniform( 10, -100, 100 );
+var opts = {
+    'dtype': 'generic'
+};
+var x = discreteUniform( 5, -100, 100, opts );
 
 // Define an array containing random index values:
-indices = discreteuniform( 100, -x.length, x.length-1 );
+var indices = discreteUniform( 100, -x.length, x.length-1, opts );
+
+// Define an array with random values to set:
+var values = discreteUniform( indices.length, -10000, 10000, opts );
 
-// Randomly selected values from the input array:
+// Randomly set elements in the input array:
 var i;
-var index;
-var newvalue;
-var updatedarray;
-for (i = 0; i < indices.length; i++) {
-    index = indices[i];
-    newvalue = rand(); // Random value between -100 and 100
-    updatedarray = withArray(x, index, newvalue); // Update the value at the given index
-    console.log('Updated x[%d] to %d', index, newvalue);
-    console.log('Updated array:', updatedarray);
+for ( i = 0; i < indices.length; i++ ) {
+    console.log( 'x = [%s]', arrayWith( x, indices[ i ], values[ i ] ).join( ',' ) );
 }
 ```
 

lib/node_modules/@stdlib/array/base/with/benchmark/benchmark.js

@@ -20,32 +20,77 @@
 
 // MODULES //
 
-var withArray = require( '@stdlib/array/base/with/lib' );
-var uniform = require( '@stdlib/random/array/uniform' );
 var bench = require( '@stdlib/bench' );
-var rand = require( '@stdlib/random/base/randu' );
-var pkg = require( '@stdlib/array/base/with/package.json' ).name;
+var pow = require( '@stdlib/math/base/special/pow' );
+var isArray = require( '@stdlib/assert/is-array' );
+var ones = require( '@stdlib/array/base/ones' );
+var pkg = require( './../package.json' ).name;
+var arrayWith = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = ones( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = arrayWith( x, i%len, i );
+			if ( out.length !== len ) {
+				b.fail( 'unexpected length' );
+			}
+		}
+		b.toc();
+		if ( !isArray( out ) ) {
+			b.fail( 'should return an array' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
 
 
 // MAIN //
 
-bench( pkg, function benchmark( b ) {
-	var value;
-	var x;
-	var v;
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
 	var i;
-	var j;
 
-	x = uniform( 100, 0.0, 10.0 );
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		j = ( i%20 );
-		value = rand();
-		v = withArray( x, j, value );
-		b.equal(v[j], value, 'index ' + j + ' should be updated to ' + value);
+		f = createBenchmark( len );
+		bench( pkg+':dtype=generic,len='+len, f );
 	}
-	b.toc();
-	b.pass( 'benchmark finished' );
-	b.end();
-});
+}
+
+main();

lib/node_modules/@stdlib/array/base/with/docs/repl.txt

@@ -1,6 +1,20 @@
 
 {{alias}}( x, index, value )
-    Return a new array after replacing an index with a given value.
+    Returns a new array with the element at the specified index replaced with a
+    provided value.
+
+    Negative indices are resolved relative to the last array element, with the
+    last element corresponding to `-1`.
+
+    If provided an array-like object having a `with` method , the function
+    defers execution to that method and assumes that the method has the
+    following signature:
+
+      x.with( index, value )
+
+    If provided an array-like object without a `with` method, the function
+    shallow copies input array data to a new generic array, normalizes a
+    provided index, and sets a specified element.
 
     Parameters
     ----------
@@ -11,12 +25,12 @@
         Index of the element to be replaced.
 
     value: any
-        Value to replace the element at the specified index with.
+        Replacement value.
 
     Returns
     -------
     out: ArrayLikeObject
-        Updated array.
+        Output array.
 
     Examples
     --------
@@ -25,6 +39,9 @@
     [ 5, 2, 3, 4 ]
     > {{alias}}( x, -1, 6 )
     [ 1, 2, 3, 6 ]
+    > x
+    [ 1, 2, 3, 4 ]
 
     See Also
     --------
+

lib/node_modules/@stdlib/array/base/with/docs/types/index.d.ts

@@ -20,70 +20,67 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array';
+import { Collection, RealTypedArray, ComplexTypedArray } from '@stdlib/types/array';
+import { ComplexLike } from '@stdlib/types/complex';
 
 /**
-* Returns a new array after updating an index into the input array.
+* Returns a new array with the element at the specified index replaced with a provided value.
 *
-* If provided an array-like object having a `with` method , the function defers
-* execution to that method and assumes that the method has the following
-* signature:
-*
-*   x.with( index, value )
+* @param x - input array
+* @param index - index at which to set a provided value
+* @param value - replacement value
+* @returns output array
 *
-* If provided an array-like object without a `with` method, the function manually
-* shallow copied that object and assign provided value to that index.
+* @example
+* var Complex128Array = require( '@stdlib/array/complex128' );
+* var Complex128 = require( '@stdlib/complex/float64' );
 *
-* Negative indices are resolved relative to the last array element, with the last
-* element corresponding to `-1`.
+* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
-* If provided out-of-bounds indices, the function always returns `undefined`.
+* var out = withArray( x, 0, new Complex128( 7.0, 8.0 ) );
+* // returns <Complex128Array>[ 7.0, 8.0, 3.0, 4.0, 5.0, 6.0 ]
+*/
+declare function withArray<T extends ComplexTypedArray>( x: T, index: number, value: ComplexLike ): T;
+
+/**
+* Returns a new array with the element at the specified index replaced with a provided value.
 *
 * @param x - input array
-* @param index - element index
+* @param index - index at which to set a provided value
 * @param value - replacement value
-* @returns updated array
+* @returns output array
 *
 * @example
-* var x = [ 1, 2, 3, 4 ];
-* var out = with( x, 0, 5 );
-* // returns [ 5, 2, 3, 4 ]
-
-* @example
-* var out = with( x, -1, 6 );
-* // returns [ 1, 2, 3, 6 ]
+* var Float64Array = require( '@stdlib/array/float64' );
+*
+* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
+*
+* var out = withArray( x, 0, 5.0 );
+* // returns <Float64Array>[ 5.0, 2.0, 3.0 ]
 */
+declare function withArray<T extends RealTypedArray>( x: T, index: number, value: number ): T; // eslint-disable-line @typescript-eslint/unified-signatures
 
 /**
- * Sets the value at the specified index in a Complex128Array.
- *
- * @param x - Complex128Array to modify
- * @param index - index at which to set the value
- * @param value - new value to set
- * @returns modified Complex128Array if successful; otherwise, throws a range error.
- */
-declare function withArray( x: Complex128Array, index: number, value: any ): Complex128Array | void;
-
-/**
- * Sets the value at the specified index in a Complex64Array.
- *
- * @param x - Complex64Array to modify
- * @param index - index at which to set the value
- * @param value - new value to set
- * @returns modified Complex64Array if successful; otherwise, throws a range error
- */
-declare function withArray( x: Complex64Array, index: number, value: any ): Complex64Array | void;
-
-/**
- * Sets the value at the specified index in an array and returns the modified array.
- *
- * @template T - type of elements in the array
- * @param x - array to modify, which can be either a Collection or an AccessorArrayLike
- * @param index - index at which to set the value
- * @param value - new value to set
- * @returns modified array if successful; otherwise, throws range error
- */
-declare function withArray< T = unknown >( x: Collection<T> | AccessorArrayLike<T>, index: number, value: any ): Collection<T> | AccessorArrayLike<T> | void;
+* Returns a new array with the element at the specified index replaced with a provided value.
+*
+* @param x - input array
+* @param index - index at which to set a provided value
+* @param value - replacement value
+* @returns output array
+*
+* @example
+* var x = [ 1, 2, 3 ];
+*
+* var out = withArray( x, 0, 7 );
+* // returns [ 7, 2, 3 ]
+*
+* @example
+* var x = [ 1, 2, 3, 4, 5, 6 ];
+*
+* var out = withArray( x, 2, 8 );
+* // returns [ 1, 8, 3, 4, 5, 6 ]
+*/
+declare function withArray<T = unknown>( x: Collection<T>, index: number, value: T ): Array<T>;
 
 
 // EXPORTS //