Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-06-05)
+## Unreleased (2024-06-18)
 
 <section class="features">
 
 ### Features
 
+-   [`b079d65`](https://github.com/stdlib-js/stdlib/commit/b079d653226019925581555fdaf9aa927ec69c0e) - add support for integer array indexing assignment
 -   [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - add support for boolean array indices
 
 </section>
@@ -22,6 +23,7 @@
 
 <details>
 
+-   [`b079d65`](https://github.com/stdlib-js/stdlib/commit/b079d653226019925581555fdaf9aa927ec69c0e) - **feat:** add support for integer array indexing assignment _(by Athan Reines)_
 -   [`96e896a`](https://github.com/stdlib-js/stdlib/commit/96e896a39be08912b2e06dfb6b671ec13d042412) - **feat:** add support for boolean array indices _(by Athan Reines)_
 -   [`75d4f83`](https://github.com/stdlib-js/stdlib/commit/75d4f83cb85610d23a04dc21a03f8075f6d3665f) - **refactor:** update require and include paths _(by Athan Reines)_
 

CONTRIBUTORS

@@ -63,6 +63,7 @@ Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
 Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
 Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com>
 Ricky Reusser <rsreusser@gmail.com>
+Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
 Robert Gislason <gztown2216@yahoo.com>
 Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
 Rutam <138517416+performant23@users.noreply.github.com>
@@ -75,7 +76,7 @@ Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
 Shubham Mishra <shubh622005@gmail.com>
 Sivam Das <100067002+Sivam2313@users.noreply.github.com>
-Snehil Shah <130062020+Snehil-Shah@users.noreply.github.com>
+Snehil Shah <snehilshah.989@gmail.com>
 Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com>
 Spandan Barve <contact@marsian.dev>
 Stephannie Jiménez Gacha <steff456@hotmail.com>

README.md

@@ -489,6 +489,7 @@ im = imag( v );
 ```javascript
 var Uint8Array = require( '@stdlib/array-uint8' );
 var Int32Array = require( '@stdlib/array-int32' );
+var BooleanArray = require( '@stdlib/array-bool' );
 var array2fancy = require( '@stdlib/array-to-fancy' );
 
 var x = [ 1, 2, 3, 4, 5, 6 ];
@@ -525,6 +526,10 @@ i = idx( [ true, false, false, true, true, true ] ); // boolean array
 z = y[ i ];
 // returns [ 1, -9, -8, 6 ]
 
+i = idx( new BooleanArray( [ true, false, false, true, true, true ] ) ); // boolean array
+z = y[ i ];
+// returns [ 1, -9, -8, 6 ]
+
 i = idx( new Uint8Array( [ 0, 0, 1, 0, 0, 1 ] ) ); // mask array
 z = y[ i ];
 // returns [ 1, 2, -9, -8 ]

benchmark/benchmark.set.js

@@ -155,3 +155,41 @@ bench( pkg+'::set,subsequence:len=1', opts, function benchmark( b ) {
 	b.pass( 'benchmark finished' );
 	b.end();
 });
+
+bench( pkg+'::set,integer_array:len=1', opts, function benchmark( b ) {
+	var values;
+	var base;
+	var opts;
+	var idx;
+	var x;
+	var v;
+	var i;
+
+	base = zeroTo( 100, 'generic' );
+	x = array2fancy( base );
+
+	opts = {
+		'persist': true
+	};
+	values = [
+		array2fancy.idx( [ 0 ], opts ),
+		array2fancy.idx( [ 1 ], opts ),
+		array2fancy.idx( [ 2 ], opts )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		idx = values[ i%values.length ];
+		x[ idx ] = i * 2;
+		v = base[ i%3 ];
+		if ( v !== v ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( v ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

dist/index.js

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection, ArrayLike, AccessorArrayLike, Complex128Array, Complex64Array, ArrayIndexObject } from '@stdlib/types/array';
+import { Collection, ArrayLike, AccessorArrayLike, ComplexTypedArray, TypedArray, BooleanTypedArray, ArrayIndexObject } from '@stdlib/types/array';
 import ArrayIndex = require( '@stdlib/array-index' );
 
 /**
@@ -74,17 +74,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
-	*/
-	( x: Float64Array, options?: Options ): Float64Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Float32Array = require( '@stdlib/array-float32' );
@@ -96,17 +85,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]
-	*/
-	( x: Float32Array, options?: Options ): Float32Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array-complex128' );
@@ -118,17 +96,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Complex128Array>[ 1.0, 2.0, 3.0, 4.0 ]
-	*/
-	( x: Complex128Array, options?: Options ): Complex128Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Complex64Array = require( '@stdlib/array-complex64' );
@@ -140,17 +107,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Complex64Array>[ 1.0, 2.0, 3.0, 4.0 ]
-	*/
-	( x: Complex64Array, options?: Options ): Complex64Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Int32Array = require( '@stdlib/array-int32' );
@@ -162,17 +118,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Int32Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Int32Array, options?: Options ): Int32Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Int16Array = require( '@stdlib/array-int16' );
@@ -184,17 +129,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Int16Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Int16Array, options?: Options ): Int16Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Int8Array = require( '@stdlib/array-int8' );
@@ -206,17 +140,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Int8Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Int8Array, options?: Options ): Int8Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Uint32Array = require( '@stdlib/array-uint32' );
@@ -228,17 +151,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Uint32Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Uint32Array, options?: Options ): Uint32Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Uint16Array = require( '@stdlib/array-uint16' );
@@ -250,17 +162,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Uint16Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Uint16Array, options?: Options ): Uint16Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Uint8Array = require( '@stdlib/array-uint8' );
@@ -272,17 +173,6 @@ interface Array2Fancy {
 	*
 	* var v = y[ ':' ];
 	* // returns <Uint8Array>[ 1, 2, 3, 4 ]
-	*/
-	( x: Uint8Array, options?: Options ): Uint8Array;
-
-	/**
-	* Converts an array to an object supporting fancy indexing.
-	*
-	* @param x - input array
-	* @param options - function options
-	* @param options.strict - boolean indicating whether to enforce strict bounds checking
-	* @param options.cache - cache for resolving array index objects
-	* @returns fancy array
 	*
 	* @example
 	* var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
@@ -295,7 +185,7 @@ interface Array2Fancy {
 	* var v = y[ ':' ];
 	* // returns <Uint8ClampedArray>[ 1, 2, 3, 4 ]
 	*/
-	( x: Uint8ClampedArray, options?: Options ): Uint8ClampedArray;
+	<T extends TypedArray | ComplexTypedArray | BooleanTypedArray>( x: T, options?: Options ): T;
 
 	/**
 	* Converts an array to an object supporting fancy indexing.

dist/index.js.map

@@ -38,6 +38,7 @@ import array2fancy = require( './index' );
 	array2fancy( new Uint8ClampedArray( [ 1, 2, 3 ] ) ); // $ExpectType Uint8ClampedArray
 	array2fancy( new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] ) ); // $ExpectType Complex128Array
 	array2fancy( new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] ) ); // $ExpectType Complex64Array
+	array2fancy( new BooleanArray( [ true, false, true ] ) ); // $ExpectType BooleanArray
 
 	const opts = {
 		'strict': true
@@ -54,6 +55,7 @@ import array2fancy = require( './index' );
 	array2fancy( new Uint8ClampedArray( [ 1, 2, 3 ] ), opts ); // $ExpectType Uint8ClampedArray
 	array2fancy( new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] ), opts ); // $ExpectType Complex128Array
 	array2fancy( new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] ), opts ); // $ExpectType Complex64Array
+	array2fancy( new BooleanArray( [ true, false, true ] ), opts ); // $ExpectType BooleanArray
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an array-like value...

docs/types/index.d.ts

@@ -20,6 +20,7 @@
 
 var Uint8Array = require( '@stdlib/array-uint8' );
 var Int32Array = require( '@stdlib/array-int32' );
+var BooleanArray = require( '@stdlib/array-bool' );
 var array2fancy = require( './../lib' );
 
 var x = [ 1, 2, 3, 4, 5, 6 ];
@@ -63,6 +64,11 @@ z = y[ i ];
 console.log( z );
 // => [ 1, -9, -8, 6 ]
 
+i = idx( new BooleanArray( [ true, false, false, true, true, true ] ) ); // boolean array
+z = y[ i ];
+console.log( z );
+// => [ 1, -9, -8, 6 ]
+
 i = idx( new Uint8Array( [ 0, 0, 1, 0, 0, 1 ] ) ); // mask array
 z = y[ i ];
 console.log( z );

docs/types/test.ts

@@ -36,7 +36,6 @@ var prop2array = require( './prop2array.js' );
 * @param {Object} target - target object
 * @param {string} property - index string
 * @param {Object} ctx - context object
-* @param {boolean} ctx.strict - boolean indicating whether to enforce strict bounds checking
 * @param {Object} ctx.cache - cache for resolving array index objects
 * @param {Function} ctx.postGetArray - function to process a retrieved array
 * @throws {Error} invalid array index