Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -820,6 +820,13 @@ A total of 45 issues were closed in this release:
 
 <details>
 
+-   [`f52054e`](https://github.com/stdlib-js/stdlib/commit/f52054eb695447bf801c822da2e86bfb36a28699) - **docs:** fix comments _(by Athan Reines)_
+-   [`ef8dc22`](https://github.com/stdlib-js/stdlib/commit/ef8dc22cb842e83aa870936e525bfcc3cd47473c) - **refactor:** use already defined variable _(by Athan Reines)_
+-   [`acd37d9`](https://github.com/stdlib-js/stdlib/commit/acd37d96627bf8febcdc2668e5f5ba2a1fd17c55) - **refactor:** use already defined variable _(by Athan Reines)_
+-   [`d2a810a`](https://github.com/stdlib-js/stdlib/commit/d2a810a7a940c8182ed3c9870cf26cb901091e89) - **refactor:** use already defined variable _(by Athan Reines)_
+-   [`89a6d62`](https://github.com/stdlib-js/stdlib/commit/89a6d62754b818bc87f80800443b1d65a40c41dd) - **refactor:** use already defined variable _(by Athan Reines)_
+-   [`e45d3fc`](https://github.com/stdlib-js/stdlib/commit/e45d3fc18c0eea98593e3edfe0d3c2970e02b81d) - **refactor:** use already defined variable _(by Athan Reines)_
+-   [`9457f9f`](https://github.com/stdlib-js/stdlib/commit/9457f9f060948f55ed3355c649a456d2267fd8b6) - **refactor:** add support for ancillary ndarray arguments having trailing dimensions _(by Athan Reines)_
 -   [`1a45821`](https://github.com/stdlib-js/stdlib/commit/1a458218a5e319ee00c0d3ddb4e065ad64edef4c) - **docs:** update examples to use accessor functions _(by Athan Reines)_
 -   [`e835a44`](https://github.com/stdlib-js/stdlib/commit/e835a4459def3255aa112790371508f6d9b7d16b) - **docs:** update examples to use accessor functions _(by Athan Reines)_
 -   [`887f9ca`](https://github.com/stdlib-js/stdlib/commit/887f9caca4ebe0bca507718b2f0ac26f063298c3) - **docs:** update examples and benchmarks _(by Athan Reines)_

base/binary-reduce-strided1d/README.md

@@ -128,7 +128,11 @@ Each provided ndarray should be an object with the following properties:
 
 ## Notes
 
--   The output ndarray and any additional ndarray arguments are expected to have the same dimensions as the non-reduced dimensions of the input ndarrays. When calling the reduction function, any additional ndarray arguments are provided as zero-dimensional ndarray-like objects.
+-   The output ndarray is expected to have the same dimensions as the non-reduced dimensions of the input ndarrays.
+
+-   Any additional ndarray arguments are expected to have the same leading dimensions as the non-reduced dimensions of the input ndarrays.
+
+-   When calling the reduction function, any additional ndarray arguments are provided as k-dimensional subarrays, where `k = M - N` with `M` being the number of dimensions in an ndarray argument and `N` being the number of non-reduced dimensions in the input ndarrays. For example, if an input ndarrays have three dimensions, the number of reduced dimensions is two, and an additional ndarray argument has one dimension, thus matching the number of non-reduced dimensions in the input ndarrays, the reduction function is provided a zero-dimensional subarray as an additional ndarray argument. In the same scenario but where an additional ndarray argument has two dimensions, thus exceeding the number of non-reduced dimensions in the input ndarrays, the reduction function is provided a one-dimensional subarray as an additional ndarray argument.
 
 -   The reduction function is expected to have the following signature:
 
@@ -138,7 +142,7 @@ Each provided ndarray should be an object with the following properties:
 
     where
 
-    -   **arrays**: array containing a one-dimensional subarray for each input ndarray and any additional ndarray arguments as zero-dimensional ndarrays.
+    -   **arrays**: array containing a one-dimensional subarray for each input ndarray and any additional ndarray arguments as subarrays.
     -   **options**: function options (_optional_).
 
 -   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing a reduction in order to achieve better performance.

base/binary-reduce-strided1d/docs/repl.txt

@@ -14,10 +14,24 @@
     - order: specifies whether an ndarray is row-major (C-style) or column-major
     (Fortran-style).
 
-    The output ndarray and any additional ndarray arguments are expected to have
-    the same dimensions as the non-reduced dimensions of the input ndarray. When
-    calling the reduction function, any additional ndarray arguments are
-    provided as zero-dimensional ndarray-like objects.
+    The output ndarray is expected to have the same dimensions as the non-
+    reduced dimensions of the input ndarrays.
+
+    Any additional ndarray arguments are expected to have the same leading
+    dimensions as the non-reduced dimensions of the input ndarrays.
+
+    When calling the reduction function, any additional ndarray arguments are
+    provided as k-dimensional subarrays, where `k = M - N` with `M` being the
+    number of dimensions in an ndarray argument and `N` being the number of non-
+    reduced dimensions in the input ndarrays. For example, if an input ndarrays
+    have three dimensions, the number of reduced dimensions is two, and an
+    additional ndarray argument has one dimension, thus matching the number of
+    non-reduced dimensions in the input ndarrays, the reduction function is
+    provided a zero-dimensional subarray as an additional ndarray argument. In
+    the same scenario but where an additional ndarray argument has two
+    dimensions, thus exceeding the number of non-reduced dimensions in the input
+    ndarrays, the reduction function is provided a one-dimensional subarray as
+    an additional ndarray argument.
 
     Parameters
     ----------
@@ -31,8 +45,7 @@
         where
 
         - arrays: array containing a one-dimensional subarrays for each input
-        ndarray and any additional ndarray arguments as zero-dimensional
-        ndarrays.
+        ndarray and any additional ndarray arguments as subarrays.
         - options: function options.
 
     arrays: ArrayLikeObject<ndarray>

base/binary-reduce-strided1d/lib/initialize_array_views.js

@@ -18,10 +18,15 @@
 
 'use strict';
 
+// MODULES //
+
+var slice = require( '@stdlib/array/base/slice' );
+
+
 // MAIN //
 
 /**
-* Initialize ndarray-like objects for representing zero-dimensional sub-array views of ancillary ndarray arguments.
+* Initialize ndarray-like objects for representing sub-array views of ancillary ndarray arguments.
 *
 * ## Notes
 *
@@ -30,20 +35,25 @@
 *
 * @private
 * @param {ArrayLikeObject<Object>} arrays - list of ndarray-like objects
+* @param {NonNegativeInteger} k - number of non-reduced dimensions
 * @param {Array<Object>} out - output array
 * @returns {Array<Object>} output array
 */
-function initializeViews( arrays, out ) {
+function initializeViews( arrays, k, out ) {
+	var sh;
+	var N;
 	var v;
 	var i;
 
 	for ( i = 3; i < arrays.length; i++ ) {
 		v = arrays[ i ];
+		sh = v.shape;
+		N = sh.length;
 		out.push({
 			'dtype': v.dtype,
 			'data': v.data,
-			'shape': [],
-			'strides': [ 0 ],
+			'shape': slice( sh, k, N ),
+			'strides': ( N === k ) ? [ 0 ] : slice( v.strides, k, N ),
 			'offset': v.offset,
 			'order': v.order
 		});

base/binary-reduce-strided1d/lib/main.js

@@ -418,7 +418,6 @@ function binaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable
 			throw new Error( format( 'invalid argument. Input arrays must have the same shape. First array shape: [%s]. Second array shape: [%s].', join( shx, ',' ), join( shy, ',' ) ) );
 		}
 	}
-
 	// Verify that we've been provided a list of unique dimension indices...
 	M = dims.length;
 	d = normalizeIndices( dims, ndims-1 );
@@ -433,12 +432,19 @@ function binaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable
 	if ( M > ndims ) {
 		throw new RangeError( format( 'invalid argument. Number of specified dimensions cannot exceed the number of dimensions in the input array. Number of dimensions: %d. Value: [%s].', ndims, join( dims, ',' ) ) );
 	}
-	// Verify that provided ndarrays have the expected number of dimensions...
+	// Compute the number of non-reduced dimensions:
 	K = ndims - M;
+
+	// Verify that the output ndarray has the expected number of dimensions...
 	if ( z.shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Output array must have the same number of non-reduced dimensions as input arrays. Input array shape: [%s]. Number of non-reduced dimensions: %d. Output array shape: [%s].', join( shx, ',' ), K, join( z.shape, ',' ) ) );
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( z.shape, ',' ), 2 ) );
+	}
+	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
+	for ( i = 3; i < N; i++ ) {
+		if ( arr[ i ].shape.length < K ) {
+			throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ i ].shape, ',' ), i ) );
+		}
 	}
-
 	// Resolve the non-reduced ("loop") dimensions and associated strides:
 	ldims = indicesComplement( shx.length, d );
 	tmpx = takeIndexed2( shx, x.strides, ldims );
@@ -495,7 +501,7 @@ function binaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable
 			'order': y.order
 		}
 	];
-	initializeViews( arr, views );
+	initializeViews( arr, K, views );
 
 	// Determine the strategy for reshaping sub-array views of the input arrays prior to performing a reduction:
 	strategyX = reshapeStrategy( views[ 0 ] );
@@ -515,8 +521,6 @@ function binaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable
 		}
 		return BINARY[ K ]( fcn, arr, views, slx, sly, strategyX, strategyY, opts ); // eslint-disable-line max-len
 	}
-	sz = z.strides;
-
 	// Determine whether the loop dimensions have only **one** non-singleton dimension (e.g., shape=[10,1,1,1]) so that we can treat loop iteration as being equivalent to one-dimensional iteration...
 	if ( ns === K-1 ) {
 		// Get the index of the non-singleton dimension...
@@ -536,6 +540,7 @@ function binaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable
 		}
 		return BINARY[ 1 ]( fcn, arr, views, slx, sly, strategyX, strategyY, opts ); // eslint-disable-line max-len
 	}
+	sz = z.strides;
 	iox = iterationOrder( slx ); // +/-1
 	ioy = iterationOrder( sly ); // +/-1
 	ioz = iterationOrder( sz ); // +/-1

base/unary-reduce-strided1d-assign-struct/lib/main.js

@@ -420,8 +420,8 @@ function unaryReduceStrided1d( fcn, arrays, dims, options ) {
 	K = ndims - M;
 
 	// Verify that the output ndarray has the expected number of dimensions...
-	if ( arr[ 1 ].shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ 1 ].shape, ',' ), 1 ) );
+	if ( y.shape.length !== K ) {
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( y.shape, ',' ), 1 ) );
 	}
 	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
 	for ( i = 2; i < N; i++ ) {

base/unary-reduce-strided1d-by/lib/main.js

@@ -395,8 +395,8 @@ function unaryReduceStrided1dBy( fcn, arrays, dims, options, clbk, thisArg ) { /
 	K = ndims - M;
 
 	// Verify that the output ndarray has the expected number of dimensions...
-	if ( arr[ 1 ].shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ 1 ].shape, ',' ), 1 ) );
+	if ( y.shape.length !== K ) {
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( y.shape, ',' ), 1 ) );
 	}
 	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
 	for ( i = 2; i < N; i++ ) {

base/unary-reduce-strided1d/lib/main.js

@@ -378,8 +378,8 @@ function unaryReduceStrided1d( fcn, arrays, dims, options ) { // eslint-disable-
 	K = ndims - M;
 
 	// Verify that the output ndarray has the expected number of dimensions...
-	if ( arr[ 1 ].shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ 1 ].shape, ',' ), 1 ) );
+	if ( y.shape.length !== K ) {
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( y.shape, ',' ), 1 ) );
 	}
 	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
 	for ( i = 2; i < N; i++ ) {

base/unary-reduce-subarray-by/lib/main.js

@@ -396,8 +396,8 @@ function unaryReduceSubarrayBy( fcn, arrays, dims, options, clbk, thisArg ) { //
 	K = ndims - M;
 
 	// Verify that the output ndarray has the expected number of dimensions...
-	if ( arr[ 1 ].shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ 1 ].shape, ',' ), 1 ) );
+	if ( y.shape.length !== K ) {
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( y.shape, ',' ), 1 ) );
 	}
 	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
 	for ( i = 2; i < N; i++ ) {

base/unary-reduce-subarray/lib/main.js

@@ -352,8 +352,8 @@ function unaryReduceSubarray( fcn, arrays, dims, options ) { // eslint-disable-l
 	K = ndims - M;
 
 	// Verify that the output ndarray has the expected number of dimensions...
-	if ( arr[ 1 ].shape.length !== K ) {
-		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( arr[ 1 ].shape, ',' ), 1 ) );
+	if ( y.shape.length !== K ) {
+		throw new Error( format( 'invalid argument. Arrays which are not being reduced must have the same number of non-reduced dimensions. Input array shape: [%s]. Number of non-reduced dimensions: %d. Array shape: [%s] (index: %d).', join( shx, ',' ), K, join( y.shape, ',' ), 1 ) );
 	}
 	// Verify that any ancillary ndarrays have at least the number of non-reduced dimensions...
 	for ( i = 2; i < N; i++ ) {