Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-06-18)
+## Unreleased (2024-06-19)
 
 <section class="features">
 
 ### Features
 
+-   [`550285b`](https://github.com/stdlib-js/stdlib/commit/550285bf4a57dd3dabc8ed3998e7b612515fe082) - add support for boolean and mask array assignment
 -   [`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
 
@@ -23,6 +24,7 @@
 
 <details>
 
+-   [`550285b`](https://github.com/stdlib-js/stdlib/commit/550285bf4a57dd3dabc8ed3998e7b612515fe082) - **feat:** add support for boolean and mask array assignment _(by Athan Reines)_
 -   [`074cbef`](https://github.com/stdlib-js/stdlib/commit/074cbef3f9d616c37c2be856a949e257481ff2fc) - **docs:** add note concerning broadcasting of nested array elements _(by Athan Reines)_
 -   [`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)_

README.md

@@ -555,6 +555,35 @@ z = y[ i ];
 i = idx( new Int32Array( [ 0, 0, 1, 1, 2, 2 ] ) ); // integer index array
 z = y[ i ];
 // returns [ 1, 1, 2, 2, -10, -10 ]
+
+// Array index assignment:
+x = [ 1, 2, 3, 4, 5, 6 ];
+y = array2fancy( x );
+
+i = idx( [ true, false, true, false, true, false ] ); // boolean array
+y[ i ] = 5;
+z = y[ ':' ];
+// returns [ 5, 2, 5, 4, 5, 6 ]
+
+i = idx( new BooleanArray( [ true, false, true, false, true, false ] ) ); // boolean array
+y[ i ] = 7;
+z = y[ ':' ];
+// returns [ 7, 2, 7, 4, 7, 6 ]
+
+i = idx( new Uint8Array( [ 1, 1, 1, 0, 0, 0 ] ) ); // mask array
+y[ i ] = 8;
+z = y[ ':' ];
+// returns [ 7, 2, 7, 8, 8, 8 ]
+
+i = idx( new Int32Array( [ 5, 3, 2 ] ) ); // integer index array
+y[ i ] = [ 9, 10, 11 ];
+z = y[ ':' ];
+// returns [ 7, 2, 11, 10, 8, 9 ]
+
+i = idx( [ 0, 1 ] ); // integer index array
+y[ i ] = -1;
+z = y[ ':' ];
+// returns [ -1, -1, 11, 10, 8, 9 ]
 ```
 
 </section>

dist/index.js

@@ -78,3 +78,32 @@ i = idx( new Int32Array( [ 0, 0, 1, 1, 2, 2 ] ) ); // integer index array
 z = y[ i ];
 console.log( z );
 // => [ 1, 1, 2, 2, -10, -10 ]
+
+// Array index assignment:
+x = [ 1, 2, 3, 4, 5, 6 ];
+y = array2fancy( x );
+
+i = idx( [ true, false, true, false, true, false ] ); // boolean array
+y[ i ] = 5;
+console.log( y );
+// => [ 5, 2, 5, 4, 5, 6 ]
+
+i = idx( new BooleanArray( [ true, false, true, false, true, false ] ) ); // boolean array
+y[ i ] = 7;
+console.log( y );
+// => [ 7, 2, 7, 4, 7, 6 ]
+
+i = idx( new Uint8Array( [ 1, 1, 1, 0, 0, 0 ] ) ); // mask array
+y[ i ] = 8;
+console.log( y );
+// => [ 7, 2, 7, 8, 8, 8 ]
+
+i = idx( new Int32Array( [ 5, 3, 2 ] ) ); // integer index array
+y[ i ] = [ 9, 10, 11 ];
+console.log( y );
+// => [ 7, 2, 11, 10, 8, 9 ]
+
+i = idx( [ 0, 1 ] ); // integer index array
+y[ i ] = -1;
+console.log( y );
+// => [ -1, -1, 11, 10, 8, 9 ]

dist/index.js.map

@@ -20,9 +20,12 @@
 
 // MODULES //
 
+var isMostlySafeCast = require( '@stdlib/array-base-assert-is-mostly-safe-data-type-cast' );
 var isCollection = require( '@stdlib/assert-is-collection' );
 var scalar2array = require( '@stdlib/array-from-scalar' );
+var dtype = require( '@stdlib/array-dtype' );
 var put = require( '@stdlib/array-put' );
+var where = require( '@stdlib/array-base-where' ).assign;
 var format = require( '@stdlib/string-format' );
 var prop2array = require( './prop2array.js' );
 var errMessage = require( './error_message.js' );
@@ -52,12 +55,14 @@ var errMessage = require( './error_message.js' );
 function setElements( target, property, value, ctx ) {
 	var idx;
 	var err;
+	var dt;
 	var v;
 
 	idx = prop2array( property, ctx.cache );
 	if ( isCollection( value ) ) {
 		// When handling collections, we delegate to implementation APIs (see below) to perform argument validation (e.g., ensuring a (mostly) safe cast, broadcast compatibility, etc), so we just reassign the value here:
 		v = value;
+		dt = dtype( value ) || 'generic';
 	} else {
 		// When provided a "scalar", we need to check whether the value can be safely cast to the target array data type:
 		err = ctx.validator( value, ctx.dtype );
@@ -71,22 +76,27 @@ function setElements( target, property, value, ctx ) {
 		}
 		// As the scalar can be safely cast, convert the scalar to an array having the same data type as the target array to allow for broadcasting during assignment:
 		v = scalar2array( v, ctx.dtype );
+		dt = ctx.dtype;
 	}
 	if ( idx.type === 'int' ) {
 		try {
-			put( target, idx.data, v );
+			put( target, idx.data, v ); // note: defer to `put` for ensuring a mostly safe cast
 		} catch ( err ) {
 			throw new err.constructor( errMessage( err.message ) );
 		}
 		return true;
 	}
+	// Safe casts are always allowed and allow same kind casts (i.e., downcasts) only when the target array data type is floating-point...
+	if ( !isMostlySafeCast( dt, ctx.dtype ) ) {
+		throw new TypeError( format( 'invalid operation. Assigned value cannot be safely cast to the target array data type. Data types: [%s, %s].', dt, ctx.dtype ) );
+	}
 	if ( idx.type === 'bool' ) {
-		// FIXME: where( idx.data, target, value );
-		return false;
+		where( idx.data, v, target, target, 1, 0 );
+		return true;
 	}
 	if ( idx.type === 'mask' ) {
-		// FIXME: where( idx.data, value, target );
-		return false;
+		where( idx.data, target, v, target, 1, 0 );
+		return true;
 	}
 	throw new Error( format( 'invalid operation. Unrecognized array index type. Value: `%s`.', idx.type ) );
 }

examples/index.js

@@ -40,13 +40,16 @@
     "@stdlib/array-base-arraylike2object": "^0.2.1",
     "@stdlib/array-base-assert-is-boolean-data-type": "github:stdlib-js/array-base-assert-is-boolean-data-type#main",
     "@stdlib/array-base-assert-is-complex-floating-point-data-type": "^0.2.1",
+    "@stdlib/array-base-assert-is-mostly-safe-data-type-cast": "^0.2.1",
     "@stdlib/array-base-assert-is-real-floating-point-data-type": "^0.2.1",
     "@stdlib/array-base-assert-is-safe-data-type-cast": "^0.3.1",
     "@stdlib/array-base-assert-is-signed-integer-data-type": "^0.2.1",
     "@stdlib/array-base-assert-is-unsigned-integer-data-type": "^0.2.1",
     "@stdlib/array-base-fancy-slice": "^0.3.1",
     "@stdlib/array-base-fancy-slice-assign": "^0.2.1",
     "@stdlib/array-base-min-signed-integer-dtype": "^0.2.1",
+    "@stdlib/array-base-where": "github:stdlib-js/array-base-where#main",
+    "@stdlib/array-dtype": "^0.2.1",
     "@stdlib/array-from-scalar": "^0.2.1",
     "@stdlib/array-index": "^0.2.1",
     "@stdlib/array-min-dtype": "^0.2.1",