@stdlib/ndarray-base-nullary-strided1d 0.1.0

package/lib/2d.js

@@ -0,0 +1,208 @@
+/**
+* @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';
+
+// MODULES //
+
+var copyIndexed = require( '@stdlib/array-base-copy-indexed' );
+var incrementOffsets = require( './increment_offsets.js' );
+var setViewOffsets = require( './set_view_offsets.js' );
+var offsets = require( './offsets.js' );
+
+
+// MAIN //
+
+/**
+* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
+*
+* @private
+* @param {Function} fcn - wrapper for a one-dimensional strided array function
+* @param {Array<Object>} arrays - ndarrays
+* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
+* @param {NonNegativeIntegerArray} shape - loop dimensions
+* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
+* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
+* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
+* @param {Options} opts - function options
+* @returns {void}
+*
+* @example
+* 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 ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' );
+* var gsorthp = require( '@stdlib/blas-ext-base-gsorthp' ).ndarray;
+*
+* function wrapper( arrays ) {
+*     var x = arrays[ 0 ];
+*     var o = arrays[ 1 ];
+*     return gsorthp( numelDimension( x, 0 ), ndarraylike2scalar( o ), getData( x ), getStride( x, 0 ), getOffset( x ) );
+* }
+*
+* // Create a data buffer:
+* var xbuf = [ 12.0, 11.0, 10.0, 9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ];
+*
+* // Define an array shape:
+* var xsh = [ 1, 3, 2, 2 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 4, 2, 1 ];
+*
+* // Define the index offset:
+* var ox = 0;
+*
+* // Create an ndarray-like object:
+* var x = {
+*     'dtype': 'generic',
+*     'data': xbuf,
+*     'shape': xsh,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+*
+* // Create an ndarray-like object for the sort order:
+* var sortOrder = {
+*     'dtype': 'generic',
+*     'data': [ 1.0 ],
+*     'shape': [ 1, 3 ],
+*     'strides': [ 0, 0 ],
+*     'offset': 0,
+*     'order': 'row-major'
+* };
+*
+* // Initialize ndarray-like objects representing sub-array views:
+* var views = [
+*     {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 2, 2 ],
+*         'strides': [ 2, 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     },
+*     {
+*         'dtype': sortOrder.dtype,
+*         'data': sortOrder.data,
+*         'shape': [],
+*         'strides': [ 0 ],
+*         'offset': sortOrder.offset,
+*         'order': sortOrder.order
+*     }
+* ];
+*
+* // Define an input strategy:
+* function inputStrategy( x ) {
+*     return {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 4 ],
+*         'strides': [ 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     };
+* }
+*
+* // Define an output strategy:
+* function outputStrategy( x ) {
+*     return x;
+* }
+*
+* var strategy = {
+*     'input': inputStrategy,
+*     'output': outputStrategy
+* }
+*
+* // Apply strided function:
+* nullary2d( wrapper, [ x, sortOrder ], views, [ 1, 3 ], [ 12, 4 ], true, strategy, {} );
+*
+* var arr = ndarray2array( x.data, x.shape, x.strides, x.offset, x.order );
+* // returns [ [ [ [ 9.0, 10.0 ], [ 11.0, 12.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]
+*/
+function nullary2d( fcn, arrays, views, shape, stridesX, isRowMajor, strategyX, opts ) { // eslint-disable-line max-len
+	var dv0;
+	var dv1;
+	var S0;
+	var S1;
+	var sv;
+	var iv;
+	var i0;
+	var i1;
+	var v;
+	var i;
+
+	// Note on variable naming convention: S#, dv#, i# where # corresponds to the loop number, with `0` being the innermost loop...
+
+	// Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments...
+	if ( isRowMajor ) {
+		// For row-major ndarrays, the last dimensions have the fastest changing indices...
+		S0 = shape[ 1 ];
+		S1 = shape[ 0 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[1]
+		];
+		dv1 = [                                   // offset increment for outermost loop
+			stridesX[0] - ( S0*stridesX[1] )
+		];
+		for ( i = 1; i < arrays.length; i++ ) {
+			sv = arrays[ i ].strides;
+			dv0.push( sv[1] );
+			dv1.push( sv[0] - ( S0*sv[1] ) );
+		}
+	} else { // order === 'column-major'
+		// For column-major ndarrays, the first dimensions have the fastest changing indices...
+		S0 = shape[ 0 ];
+		S1 = shape[ 1 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[0]
+		];
+		dv1 = [                                   // offset increment for outermost loop
+			stridesX[1] - ( S0*stridesX[0] )
+		];
+		for ( i = 1; i < arrays.length; i++ ) {
+			sv = arrays[ i ].strides;
+			dv0.push( sv[0] );
+			dv1.push( sv[1] - ( S0*sv[0] ) );
+		}
+	}
+	// Resolve a list of pointers to the first indexed elements in the respective ndarrays:
+	iv = offsets( arrays );
+
+	// Shallow copy the list of views to an internal array so that we can update with reshaped views without impacting the original list of views:
+	v = copyIndexed( views );
+
+	// Iterate over the loop dimensions...
+	for ( i1 = 0; i1 < S1; i1++ ) {
+		for ( i0 = 0; i0 < S0; i0++ ) {
+			setViewOffsets( views, iv );
+			v[ 0 ] = strategyX.input( views[ 0 ] );
+			fcn( v, opts );
+			strategyX.output( views[ 0 ]);
+			incrementOffsets( iv, dv0 );
+		}
+		incrementOffsets( iv, dv1 );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = nullary2d;

package/lib/2d_blocked.js

@@ -0,0 +1,238 @@
+/**
+* @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';
+
+// MODULES //
+
+var loopOrder = require( '@stdlib/ndarray-base-nullary-loop-interchange-order' );
+var blockSize = require( '@stdlib/ndarray-base-nullary-tiling-block-size' );
+var takeIndexed = require( '@stdlib/array-base-take-indexed' );
+var copyIndexed = require( '@stdlib/array-base-copy-indexed' );
+var zeros = require( '@stdlib/array-base-zeros' );
+var incrementOffsets = require( './increment_offsets.js' );
+var setViewOffsets = require( './set_view_offsets.js' );
+var offsets = require( './offsets.js' );
+
+
+// MAIN //
+
+/**
+* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray via loop-blocking.
+*
+* @private
+* @param {Function} fcn - wrapper for a one-dimensional strided array function
+* @param {Array<Object>} arrays - ndarrays
+* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
+* @param {NonNegativeIntegerArray} shape - loop dimensions
+* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
+* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
+* @param {Options} opts - function options
+* @returns {void}
+*
+* @example
+* 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 ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' );
+* var gsorthp = require( '@stdlib/blas-ext-base-gsorthp' ).ndarray;
+*
+* function wrapper( arrays ) {
+*     var x = arrays[ 0 ];
+*     var o = arrays[ 1 ];
+*     return gsorthp( numelDimension( x, 0 ), ndarraylike2scalar( o ), getData( x ), getStride( x, 0 ), getOffset( x ) );
+* }
+*
+* // Create a data buffer:
+* var xbuf = [ 12.0, 11.0, 10.0, 9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ];
+*
+* // Define an array shape:
+* var xsh = [ 1, 3, 2, 2 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 4, 2, 1 ];
+*
+* // Define the index offset:
+* var ox = 0;
+*
+* // Create an ndarray-like object:
+* var x = {
+*     'dtype': 'generic',
+*     'data': xbuf,
+*     'shape': xsh,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+*
+* // Create an ndarray-like object for the sort order:
+* var sortOrder = {
+*     'dtype': 'generic',
+*     'data': [ 1.0 ],
+*     'shape': [ 1, 3 ],
+*     'strides': [ 0, 0 ],
+*     'offset': 0,
+*     'order': 'row-major'
+* };
+*
+* // Initialize ndarray-like objects representing sub-array views:
+* var views = [
+*     {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 2, 2 ],
+*         'strides': [ 2, 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     },
+*     {
+*         'dtype': sortOrder.dtype,
+*         'data': sortOrder.data,
+*         'shape': [],
+*         'strides': [ 0 ],
+*         'offset': sortOrder.offset,
+*         'order': sortOrder.order
+*     }
+* ];
+*
+* // Define an input strategy:
+* function inputStrategy( x ) {
+*     return {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 4 ],
+*         'strides': [ 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     };
+* }
+*
+* // Define an output strategy:
+* function outputStrategy( x ) {
+*     return x;
+* }
+*
+* var strategy = {
+*     'input': inputStrategy,
+*     'output': outputStrategy
+* }
+*
+* // Apply strided function:
+* blockednullary2d( wrapper, [ x, sortOrder ], views, [ 1, 3 ], [ 12, 4 ], strategy, {} );
+*
+* var arr = ndarray2array( x.data, x.shape, x.strides, x.offset, x.order );
+* // returns [ [ [ [ 9.0, 10.0 ], [ 11.0, 12.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]
+*/
+function blockednullary2d( fcn, arrays, views, shape, stridesX, strategyX, opts ) { // eslint-disable-line max-len
+	var bsize;
+	var dv0;
+	var dv1;
+	var ov1;
+	var sh;
+	var s0;
+	var s1;
+	var sv;
+	var ov;
+	var iv;
+	var i0;
+	var i1;
+	var j0;
+	var j1;
+	var N;
+	var x;
+	var v;
+	var o;
+	var k;
+
+	// Note on variable naming convention: S#, dv#, i#, j# where # corresponds to the loop number, with `0` being the innermost loop...
+
+	N = arrays.length;
+	x = arrays[ 0 ];
+
+	// Resolve the loop interchange order:
+	o = loopOrder( shape, stridesX );
+	sh = o.sh;
+	sv = [ o.sx ];
+	for ( k = 1; k < N; k++ ) {
+		sv.push( takeIndexed( arrays[k].strides, o.idx ) );
+	}
+	// Determine the block size:
+	bsize = blockSize( x.dtype );
+
+	// Resolve a list of pointers to the first indexed elements in the respective ndarrays:
+	ov = offsets( arrays );
+
+	// Cache offset increments for the innermost loop...
+	dv0 = [];
+	for ( k = 0; k < N; k++ ) {
+		dv0.push( sv[k][0] );
+	}
+	// Initialize loop variables...
+	ov1 = zeros( N );
+	dv1 = zeros( N );
+	iv = zeros( N );
+
+	// Shallow copy the list of views to an internal array so that we can update with reshaped views without impacting the original list of views:
+	v = copyIndexed( views );
+
+	// Iterate over blocks...
+	for ( j1 = sh[1]; j1 > 0; ) {
+		if ( j1 < bsize ) {
+			s1 = j1;
+			j1 = 0;
+		} else {
+			s1 = bsize;
+			j1 -= bsize;
+		}
+		for ( k = 0; k < N; k++ ) {
+			ov1[ k ] = ov[k] + ( j1*sv[k][1] );
+		}
+		for ( j0 = sh[0]; j0 > 0; ) {
+			if ( j0 < bsize ) {
+				s0 = j0;
+				j0 = 0;
+			} else {
+				s0 = bsize;
+				j0 -= bsize;
+			}
+			// Compute index offsets and loop offset increments for the first ndarray elements in the current block...
+			for ( k = 0; k < N; k++ ) {
+				iv[ k ] = ov1[k] + ( j0*sv[k][0] );
+				dv1[ k ] = sv[k][1] - ( s0*sv[k][0] );
+			}
+			// Iterate over the loop dimensions...
+			for ( i1 = 0; i1 < s1; i1++ ) {
+				for ( i0 = 0; i0 < s0; i0++ ) {
+					setViewOffsets( views, iv );
+					v[ 0 ] = strategyX.input( views[ 0 ] );
+					fcn( v, opts );
+					strategyX.output( views[ 0 ] );
+					incrementOffsets( iv, dv0 );
+				}
+				incrementOffsets( iv, dv1 );
+			}
+		}
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = blockednullary2d;

package/lib/3d.js

@@ -0,0 +1,224 @@
+/**
+* @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';
+
+// MODULES //
+
+var copyIndexed = require( '@stdlib/array-base-copy-indexed' );
+var incrementOffsets = require( './increment_offsets.js' );
+var setViewOffsets = require( './set_view_offsets.js' );
+var offsets = require( './offsets.js' );
+
+
+// MAIN //
+
+/**
+* Applies a one-dimensional strided array function to a list of specified dimensions in an ndarray.
+*
+* @private
+* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
+* @param {Array<Object>} arrays - ndarrays
+* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
+* @param {NonNegativeIntegerArray} shape - loop dimensions
+* @param {IntegerArray} stridesX - loop dimension strides for the ndarray
+* @param {boolean} isRowMajor - boolean indicating if provided arrays are in row-major order
+* @param {Object} strategyX - strategy for marshaling data to and from an ndarray view
+* @param {Options} opts - function options
+* @returns {void}
+*
+* @example
+* 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 ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' );
+* var gsorthp = require( '@stdlib/blas-ext-base-gsorthp' ).ndarray;
+*
+* function wrapper( arrays ) {
+*     var x = arrays[ 0 ];
+*     var o = arrays[ 1 ];
+*     return gsorthp( numelDimension( x, 0 ), ndarraylike2scalar( o ), getData( x ), getStride( x, 0 ), getOffset( x ) );
+* }
+*
+* // Create a data buffer:
+* var xbuf = [ 12.0, 11.0, 10.0, 9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ];
+*
+* // Define an array shape:
+* var xsh = [ 1, 1, 3, 2, 2 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 12, 4, 2, 1 ];
+*
+* // Define the index offset:
+* var ox = 0;
+*
+* // Create an ndarray-like object:
+* var x = {
+*     'dtype': 'generic',
+*     'data': xbuf,
+*     'shape': xsh,
+*     'strides': sx,
+*     'offset': ox,
+*     'order': 'row-major'
+* };
+*
+* // Create an ndarray-like object for the sort order:
+* var sortOrder = {
+*     'dtype': 'generic',
+*     'data': [ 1.0 ],
+*     'shape': [ 1, 1, 3 ],
+*     'strides': [ 0, 0, 0 ],
+*     'offset': 0,
+*     'order': 'row-major'
+* };
+*
+* // Initialize ndarray-like objects representing sub-array views:
+* var views = [
+*     {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 2, 2 ],
+*         'strides': [ 2, 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     },
+*     {
+*         'dtype': sortOrder.dtype,
+*         'data': sortOrder.data,
+*         'shape': [],
+*         'strides': [ 0 ],
+*         'offset': sortOrder.offset,
+*         'order': sortOrder.order
+*     }
+* ];
+*
+* // Define an input strategy:
+* function inputStrategy( x ) {
+*     return {
+*         'dtype': x.dtype,
+*         'data': x.data,
+*         'shape': [ 4 ],
+*         'strides': [ 1 ],
+*         'offset': x.offset,
+*         'order': x.order
+*     };
+* }
+*
+* // Define an output strategy:
+* function outputStrategy( x ) {
+*     return x;
+* }
+*
+* var strategy = {
+*     'input': inputStrategy,
+*     'output': outputStrategy
+* }
+*
+* // Apply strided function:
+* nullary3d( wrapper, [ x, sortOrder ], views, [ 1, 1, 3 ], [ 12, 12, 4 ], true, strategy, {} );
+*
+* var arr = ndarray2array( x.data, x.shape, x.strides, x.offset, x.order );
+* // returns [ [ [ [ [ 9.0, 10.0 ], [ 11.0, 12.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ]
+*/
+function nullary3d( fcn, arrays, views, shape, stridesX, isRowMajor, strategyX, opts ) { // eslint-disable-line max-len
+	var dv0;
+	var dv1;
+	var dv2;
+	var S0;
+	var S1;
+	var S2;
+	var sv;
+	var iv;
+	var i0;
+	var i1;
+	var i2;
+	var v;
+	var i;
+
+	// Note on variable naming convention: S#, dv#, i# where # corresponds to the loop number, with `0` being the innermost loop...
+
+	// Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments...
+	if ( isRowMajor ) {
+		// For row-major ndarrays, the last dimensions have the fastest changing indices...
+		S0 = shape[ 2 ];
+		S1 = shape[ 1 ];
+		S2 = shape[ 0 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[2]
+		];
+		dv1 = [
+			stridesX[1] - ( S0*stridesX[2] )
+		];
+		dv2 = [                                   // offset increment for outermost loop
+			stridesX[0] - ( S1*stridesX[1] )
+		];
+		for ( i = 1; i < arrays.length; i++ ) {
+			sv = arrays[ i ].strides;
+			dv0.push( sv[2] );
+			dv1.push( sv[1] - ( S0*sv[2] ) );
+			dv2.push( sv[0] - ( S1*sv[1] ) );
+		}
+	} else { // order === 'column-major'
+		// For column-major ndarrays, the first dimensions have the fastest changing indices...
+		S0 = shape[ 0 ];
+		S1 = shape[ 1 ];
+		S2 = shape[ 2 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[0]
+		];
+		dv1 = [
+			stridesX[1] - ( S0*stridesX[0] )
+		];
+		dv2 = [                                   // offset increment for outermost loop
+			stridesX[2] - ( S1*stridesX[1] )
+		];
+		for ( i = 1; i < arrays.length; i++ ) {
+			sv = arrays[ i ].strides;
+			dv0.push( sv[0] );
+			dv1.push( sv[1] - ( S0*sv[0] ) );
+			dv2.push( sv[2] - ( S1*sv[1] ) );
+		}
+	}
+	// Resolve a list of pointers to the first indexed elements in the respective ndarrays:
+	iv = offsets( arrays );
+
+	// Shallow copy the list of views to an internal array so that we can update with reshaped views without impacting the original list of views:
+	v = copyIndexed( views );
+
+	// Iterate over the loop dimensions...
+	for ( i2 = 0; i2 < S2; i2++ ) {
+		for ( i1 = 0; i1 < S1; i1++ ) {
+			for ( i0 = 0; i0 < S0; i0++ ) {
+				setViewOffsets( views, iv );
+				v[ 0 ] = strategyX.input( views[ 0 ] );
+				fcn( v, opts );
+				strategyX.output( views[ 0 ] );
+				incrementOffsets( iv, dv0 );
+			}
+			incrementOffsets( iv, dv1 );
+		}
+		incrementOffsets( iv, dv2 );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = nullary3d;