Auto-generated commit

Author: stdlib-bot

Diff for: CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-03-21)
+## Unreleased (2025-03-22)
 
 <section class="packages">
 
@@ -91,6 +91,7 @@
 
 ##### Features
 
+-   [`282d01f`](https://github.com/stdlib-js/stdlib/commit/282d01f86247ea1b4c8a3345493b6dc8ec034517) - add `fillBy` to namespace
 -   [`e661213`](https://github.com/stdlib-js/stdlib/commit/e66121352ef767cdb87d19e938b1eccf7970fa3a) - update namespace TypeScript declarations [(#4706)](https://github.com/stdlib-js/stdlib/pull/4706)
 -   [`741b6f1`](https://github.com/stdlib-js/stdlib/commit/741b6f1df8ce11e77fb22c279cee6bbae3323176) - add `spreadDimensions` to namespace
 -   [`908239e`](https://github.com/stdlib-js/stdlib/commit/908239e7cc6b4b3e260d0cc1f5aebb9af35d83c6) - add `toUniqueNormalizedIndices` to namespace
@@ -391,6 +392,28 @@ This release closes the following issue:
 
 <!-- /.package -->
 
+<section class="package" id="ndarray-base-fill-by-unreleased">
+
+#### [@stdlib/ndarray/base/fill-by](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill-by)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`d29b55f`](https://github.com/stdlib-js/stdlib/commit/d29b55fd2f01608cf9cbff68eb5b6dad4ca1722b) - add `ndarray/base/fill-by`
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="ndarray-base-from-scalar-like-unreleased">
 
 #### [@stdlib/ndarray/base/from-scalar-like](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/from-scalar-like)
@@ -1087,6 +1110,10 @@ A total of 7 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`282d01f`](https://github.com/stdlib-js/stdlib/commit/282d01f86247ea1b4c8a3345493b6dc8ec034517) - **feat:** add `fillBy` to namespace _(by Athan Reines)_
+-   [`d29b55f`](https://github.com/stdlib-js/stdlib/commit/d29b55fd2f01608cf9cbff68eb5b6dad4ca1722b) - **feat:** add `ndarray/base/fill-by` _(by Athan Reines)_
+-   [`266a064`](https://github.com/stdlib-js/stdlib/commit/266a064a8cc55b100a00d2ad98c84820d8f17653) - **style:** fix spacing _(by Athan Reines)_
+-   [`04f7752`](https://github.com/stdlib-js/stdlib/commit/04f77520acf685e9325bf4413be6da7543ed3cb5) - **refactor:** accommodate known array types for increased performance _(by Athan Reines)_
 -   [`70d0be2`](https://github.com/stdlib-js/stdlib/commit/70d0be235297eecc69d8e7ec4aad484ac7d5aedc) - **test:** add 0d tests _(by Athan Reines)_
 -   [`d761114`](https://github.com/stdlib-js/stdlib/commit/d761114ce6f6f74f0befb8c445e4632c0265c150) - **docs:** update descriptions _(by Athan Reines)_
 -   [`59ab26d`](https://github.com/stdlib-js/stdlib/commit/59ab26d220e5950d2a4e1fa087602e73ce3e3b5b) - **docs:** add `c_x_as_z_x` example _(by Athan Reines)_

Diff for: base/assign/lib/main.js

@@ -22,11 +22,16 @@
 
 var isComplexDataType = require( './../../../base/assert/is-complex-floating-point-data-type' );
 var isRealDataType = require( './../../../base/assert/is-real-data-type' );
+var isComplexArray = require( '@stdlib/array/base/assert/is-complex-typed-array' );
+var isBooleanArray = require( '@stdlib/array/base/assert/is-booleanarray' );
 var iterationOrder = require( './../../../base/iteration-order' );
 var castReturn = require( '@stdlib/complex/base/cast-return' );
 var complexCtors = require( '@stdlib/complex/ctors' );
 var minmaxViewBufferIndex = require( './../../../base/minmax-view-buffer-index' );
 var ndarray2object = require( './../../../base/ndarraylike2object' );
+var reinterpretComplex = require( '@stdlib/strided/base/reinterpret-complex' );
+var reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
+var gscal = require( '@stdlib/blas/base/gscal' );
 var blockedaccessorassign2d = require( './2d_blocked_accessors.js' );
 var blockedaccessorassign3d = require( './3d_blocked_accessors.js' );
 var blockedaccessorassign4d = require( './4d_blocked_accessors.js' );
@@ -123,6 +128,57 @@ var BLOCKED_ACCESSOR_ASSIGN = [
 ];
 var MAX_DIMS = ASSIGN.length - 1;
 
+// TODO: consider adding a package utility for mapping a complex dtype to its complementary real-valued counterpart
+var COMPLEX_TO_REAL = { // WARNING: this table needs to be manually updated if we add support for additional complex number dtypes
+	'complex128': 'float64',
+	'complex64': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Converts a boolean ndarray to an 8-bit unsigned integer ndarray.
+*
+* ## Notes
+*
+* -   The function mutates the input ndarray object.
+*
+* @private
+* @param {Object} x - input ndarray object
+* @returns {Object} output ndarray object
+*/
+function boolean2uint8( x ) {
+	x.data = reinterpretBoolean( x.data, 0 );
+	x.accessorProtocol = false;
+	return x;
+}
+
+/**
+* Converts a complex-valued floating-point ndarray to a real-valued floating-point ndarray.
+*
+* ## Notes
+*
+* -   The function mutates the input ndarray object.
+*
+* @private
+* @param {Object} x - input ndarray object
+* @returns {Object} output ndarray object
+*/
+function complex2real( x ) {
+	x.data = reinterpretComplex( x.data, 0 );
+	x.accessorProtocol = false;
+	x.dtype = COMPLEX_TO_REAL[ x.dtype ];
+	x.strides = gscal( x.shape.length, 2, x.strides, 1 );
+	x.offset *= 2;
+
+	// Append a trailing dimension where each element is the real and imaginary component for a corresponding element in the original input ndarray (note: this means that a two-dimensional complex-valued ndarray becomes a three-dimensional real-valued ndarray; while this does entail additional loop overhead, it is still significantly faster than sending complex-valued ndarrays down the accessor path):
+	x.shape.push( 2 ); // real and imaginary components
+	x.strides.push( 1 ); // real and imaginary components are assumed to be adjacent in memory
+
+	return x;
+}
+
 
 // MAIN //
 
@@ -210,8 +266,16 @@ function assign( arrays ) {
 	x = ndarray2object( arrays[ 0 ] );
 	y = ndarray2object( arrays[ 1 ] );
 
+	// Check for known array types which can be reinterpreted for better iteration performance...
+	if ( isBooleanArray( x.data ) && isBooleanArray( y.data ) ) {
+		x = boolean2uint8( x );
+		y = boolean2uint8( y );
+	} else if ( isComplexArray( x.data ) && isComplexArray( y.data ) ) {
+		x = complex2real( x );
+		y = complex2real( y );
+	}
 	// Determine whether we are casting a real data type to a complex data type and we need to use a specialized accessor (note: we don't support the other way, complex-to-real, as this is not an allowed (mostly) safe cast)...
-	if ( isRealDataType( x.dtype ) && isComplexDataType( y.dtype ) ) {
+	else if ( isRealDataType( x.dtype ) && isComplexDataType( y.dtype ) ) {
 		x.accessorProtocol = true;
 		x.accessors[ 0 ] = castReturn( x.accessors[ 0 ], 2, complexCtors( y.dtype ) ); // eslint-disable-line max-len
 	}

Diff for: base/fill-by/README.md

@@ -0,0 +1,192 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+# fillBy
+
+> Fill an input ndarray according to a callback function.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var fillBy = require( '@stdlib/ndarray/base/fill-by' );
+```
+
+#### fillBy( x, fcn\[, thisArg] )
+
+Fills an input ndarray according to a callback function.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+function fcn( value ) {
+    return value * 10.0;
+}
+
+// Create a data buffer:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+// Define the shape of the input array:
+var shape = [ 3, 1, 2 ];
+
+// Define the array strides:
+var sx = [ 2, 2, 1 ];
+
+// Define the index offset:
+var ox = 0;
+
+// Create the input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+fillBy( x, fcn );
+
+console.log( x.data );
+// => <Float64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0 ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: array-like object containing an input ndarray.
+-   **fcn**: callback function.
+-   **thisArg**: callback function execution context (_optional_).
+
+To set the callback function execution context, provide a `thisArg`.
+
+<!-- eslint-disable no-invalid-this -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+function fcn( value ) {
+    return value * this.factor;
+}
+
+// Create a data buffer:
+var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+// Define the shape of the input array:
+var shape = [ 3, 1, 2 ];
+
+// Define the array strides:
+var sx = [ 2, 2, 1 ];
+
+// Define the index offset:
+var ox = 0;
+
+// Create the input ndarray-like object:
+var x = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+var ctx = {
+    'factor': 10.0
+};
+fillBy( x, fcn, ctx );
+
+console.log( x.data );
+// => <Float64Array>[ 10.0, 20.0, 30.0, 40.0, 50.0, 60.0 ]
+```
+
+A provided ndarray should be an object with the following properties:
+
+-   **dtype**: data type.
+-   **data**: data buffer.
+-   **shape**: dimensions.
+-   **strides**: stride lengths.
+-   **offset**: index offset.
+-   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The function **mutates** the input ndarray.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var fillBy = require( '@stdlib/ndarray/base/fill-by' );
+
+// Create a zero-filled ndarray:
+var x = zeros( [ 5, 2 ], {
+    'dtype': 'generic'
+});
+console.log( ndarray2array( x ) );
+
+// Fill the ndarray with random values:
+fillBy( x, discreteUniform( -100, 100 ) );
+console.log( ndarray2array( x ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->