feat: add support for assigning to an output array

Author: kgryte

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

@@ -52,14 +52,37 @@ var out = arrayWith( x, 0, 5 );
 
 out = arrayWith( x, -1, 6 );
 // returns [ 1, 2, 3, 6 ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: an input array.
+-   **index**: element index.
+-   **value**: replacement value.
+
+### arrayWith.assign( x, index, value, out, stride, offset )
+
+Copies elements from one array to another array and sets the element at the specified index to a provided value.
+
+```javascript
+var x = [ 1, 2, 3, 4 ];
+
+var out = [ 0, 0, 0, 0 ];
+var arr = arrayWith.assign( x, 0, 5, out, 1, 0 );
+// returns [ 5, 2, 3, 4 ]
 
+var bool = ( arr === out );
+// returns true
 ```
 
 The function accepts the following arguments:
 
 -   **x**: an input array.
 -   **index**: element index.
 -   **value**: replacement value.
+-   **out**: output array.
+-   **stride**: output array stride.
+-   **offset**: output array offset.
 
 </section>
 
@@ -71,13 +94,13 @@ The function accepts the following arguments:
 
 ## Notes
 
--   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:
+-   If provided an array-like object having a `with` method, the `arrayWith` function defers execution to that method and assumes that the method has the following signature:
 
     ```text
     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.
+    If provided an array-like object without a `with` method, the `arrayWith` 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`.
 

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

@@ -0,0 +1,98 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 pow = require( '@stdlib/math/base/special/pow' );
+var isArray = require( '@stdlib/assert/is-array' );
+var ones = require( '@stdlib/array/base/ones' );
+var zeros = require( '@stdlib/array/base/zeros' );
+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 out = zeros( len );
+	var x = ones( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = arrayWith.assign( x, i%len, i, out, 1, 0 );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an array' );
+			}
+		}
+		b.toc();
+		if ( !isArray( v ) ) {
+			b.fail( 'should return an array' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+
+		f = createBenchmark( len );
+		bench( pkg+':assign:dtype=generic,len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/with/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/array/base/with/benchmark/benchmark.length.js

@@ -42,6 +42,48 @@
     > x
     [ 1, 2, 3, 4 ]
 
+
+{{alias}}.assign( x, index, value, out, stride, offset )
+    Copies elements from one array to another array and sets the element at the
+    specified index to a provided value.
+
+    Negative indices are resolved relative to the last array element, with the
+    last element corresponding to `-1`.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input array.
+
+    index: integer
+        Index of the element to be replaced.
+
+    value: any
+        Replacement value.
+
+    out: ArrayLikeObject
+        Output array.
+
+    stride: integer
+        Output array stride.
+
+    offset: integer
+        Output array offset.
+
+    Returns
+    -------
+    out: ArrayLikeObject
+        Output array.
+
+    Examples
+    --------
+    > var x = [ 1, 2, 3, 4 ];
+    > var out = [ 0, 0, 0, 0 ];
+    > var arr = {{alias}}.assign( x, 0, 5, out, 1, 0 )
+    [ 5, 2, 3, 4 ]
+    > var bool = ( arr === out )
+    true
+
     See Also
     --------