@stdlib/ndarray-base-binary-reduce-strided1d 0.1.0

package/lib/index.js

@@ -0,0 +1,175 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+/**
+* Perform a reduction over a list of specified dimensions in two input ndarrays via a one-dimensional strided array binary reduction function and assign results to a provided output ndarray.
+*
+* @module @stdlib/ndarray-base-binary-reduce-strided1d
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+* var ndarray2array = require( '@stdlib/ndarray-base-to-array' );
+* var getStride = require( '@stdlib/ndarray-base-stride' );
+* var getOffset = require( '@stdlib/ndarray-base-offset' );
+* var getData = require( '@stdlib/ndarray-base-data-buffer' );
+* var numelDimension = require( '@stdlib/ndarray-base-numel-dimension' );
+* var gdot = require( '@stdlib/blas-base-ndarray-gdot' );
+* var binaryReduceStrided1d = require( '@stdlib/ndarray-base-binary-reduce-strided1d' );
+*
+* // Create data buffers:
+* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var ybuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var zbuf = new Float64Array( [ 0.0, 0.0, 0.0 ] );
+*
+* // Define the array shapes:
+* var xsh = [ 1, 3, 2, 2 ];
+* var ysh = [ 1, 3, 2, 2 ];
+* var zsh = [ 1, 3 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 4, 2, 1 ];
+* var sy = [ 12, 4, 2, 1 ];
+* var sz = [ 3, 1 ];
+*
+* // Define the index offsets:
+* var ox = 0;
+* var oy = 0;
+* var oz = 0;
+*
+* // Create input ndarray-like objects:
+* var x = {
+*     'dtype': 'float64',
+*     'data': xbuf,
+*     'shape': xsh,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+* var y = {
+*     'dtype': 'float64',
+*     'data': ybuf,
+*     'shape': ysh,
+*     'strides': sy,
+*     'offset': oy,
+*     'order': 'row-major'
+* };
+*
+* // Create an output ndarray-like object:
+* var z = {
+*     'dtype': 'float64',
+*     'data': zbuf,
+*     'shape': zsh,
+*     'strides': sz,
+*     'offset': oz,
+*     'order': 'row-major'
+* };
+*
+* // Perform a reduction:
+* binaryReduceStrided1d( gdot, [ x, y, z ], [ 2, 3 ] );
+*
+* var arr = ndarray2array( z.data, z.shape, z.strides, z.offset, z.order );
+* // returns [ [ 30.0, 174.0, 446.0 ] ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+* var ndarray2array = require( '@stdlib/ndarray-base-to-array' );
+* var getStride = require( '@stdlib/ndarray-base-stride' );
+* var getOffset = require( '@stdlib/ndarray-base-offset' );
+* var getData = require( '@stdlib/ndarray-base-data-buffer' );
+* var numelDimension = require( '@stdlib/ndarray-base-numel-dimension' );
+* var gdot = require( '@stdlib/blas-base-ndarray-gdot' );
+* var binaryReduceStrided1d = require( '@stdlib/ndarray-base-binary-reduce-strided1d' );
+*
+* // Create data buffers:
+* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var ybuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var zbuf = new Float64Array( [ 0.0, 0.0, 0.0 ] );
+*
+* // Define the array shapes:
+* var xsh = [ 1, 3, 2, 2 ];
+* var ysh = [ 1, 3, 2, 2 ];
+* var zsh = [ 1, 3 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 4, 2, 1 ];
+* var sy = [ 12, 4, 2, 1 ];
+* var sz = [ 3, 1 ];
+*
+* // Define the index offsets:
+* var ox = 0;
+* var oy = 0;
+* var oz = 0;
+*
+* // Create input ndarray-like objects:
+* var x = {
+*     'dtype': 'float64',
+*     'data': xbuf,
+*     'shape': xsh,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+* var y = {
+*     'dtype': 'float64',
+*     'data': ybuf,
+*     'shape': ysh,
+*     'strides': sy,
+*     'offset': oy,
+*     'order': 'row-major'
+* };
+*
+* // Create an output ndarray-like object:
+* var z = {
+*     'dtype': 'float64',
+*     'data': zbuf,
+*     'shape': zsh,
+*     'strides': sz,
+*     'offset': oz,
+*     'order': 'row-major'
+* };
+*
+* // Create a function for performing a reduction over subarrays:
+* var dot = binaryReduceStrided1d.factory( gdot );
+* // returns <Function>
+*
+* // Perform a reduction:
+* dot( [ x, y, z ], [ 2, 3 ] );
+*
+* var arr = ndarray2array( z.data, z.shape, z.strides, z.offset, z.order );
+* // returns [ [ 30.0, 174.0, 446.0 ] ]
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var factory = require( './factory.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'factory', factory );
+
+
+// EXPORTS //
+
+module.exports = main;
+
+// exports: { "factory": "main.factory" }

package/lib/initialize_array_views.js

@@ -0,0 +1,57 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Initialize ndarray-like objects for representing zero-dimensional sub-array views of ancillary ndarray arguments.
+*
+* ## Notes
+*
+* -   This function ignores the first three ndarray-like objects, which are assumed to be two input ndarrays and one output ndarray, respectively.
+* -   This function mutates the provided output array.
+*
+* @private
+* @param {ArrayLikeObject<Object>} arrays - list of ndarray-like objects
+* @param {Array<Object>} out - output array
+* @returns {Array<Object>} output array
+*/
+function initializeViews( arrays, out ) {
+	var v;
+	var i;
+
+	for ( i = 3; i < arrays.length; i++ ) {
+		v = arrays[ i ];
+		out.push({
+			'dtype': v.dtype,
+			'data': v.data,
+			'shape': [],
+			'strides': [ 0 ],
+			'offset': v.offset,
+			'order': v.order
+		});
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = initializeViews;