@stdlib/ndarray-base-nullary-strided1d 0.1.0

package/lib/0d.js

@@ -0,0 +1,117 @@
+/**
+* @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 //
+
+/**
+* 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 {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 = [ 4.0, 3.0, 2.0, 1.0 ];
+*
+* // Define an array shape:
+* var xsh = [ 2, 2 ];
+*
+* // Define the array strides:
+* var sx = [ 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': [ 3 ],
+*     'strides': [ 0 ],
+*     'offset': 0,
+*     'order': 'row-major'
+* };
+*
+* // 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:
+* nullary0d( wrapper, [ x, sortOrder ], strategy, {} );
+*
+* var v = x.data;
+* // returns [ 1.0, 2.0, 3.0, 4.0 ]
+*/
+function nullary0d( fcn, arrays, strategyX, opts ) {
+	arrays[ 0 ] = strategyX.input( arrays[ 0 ] );
+	fcn( arrays, opts );
+	strategyX.output( arrays[ 0 ] );
+}
+
+
+// EXPORTS //
+
+module.exports = nullary0d;

package/lib/10d.js

@@ -0,0 +1,338 @@
+/**
+* @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.
+*/
+
+/* eslint-disable max-depth, max-len */
+
+'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, 1, 1, 1, 1, 1, 1, 1, 3, 2, 2 ];
+*
+* // Define the array strides:
+* var sx = [ 12, 12, 12, 12, 12, 12, 12, 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, 1, 1, 1, 1, 1, 1, 1, 3 ],
+*     'strides': [ 0, 0, 0, 0, 0, 0, 0, 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:
+* nullary10d( wrapper, [ x, sortOrder ], views, [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 3 ], [ 12, 12, 12, 12, 12, 12, 12, 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 nullary10d( fcn, arrays, views, shape, stridesX, isRowMajor, strategyX, opts ) { // eslint-disable-line max-statements
+	var dv0;
+	var dv1;
+	var dv2;
+	var dv3;
+	var dv4;
+	var dv5;
+	var dv6;
+	var dv7;
+	var dv8;
+	var dv9;
+	var S0;
+	var S1;
+	var S2;
+	var S3;
+	var S4;
+	var S5;
+	var S6;
+	var S7;
+	var S8;
+	var S9;
+	var sv;
+	var iv;
+	var i0;
+	var i1;
+	var i2;
+	var i3;
+	var i4;
+	var i5;
+	var i6;
+	var i7;
+	var i8;
+	var i9;
+	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[ 9 ];
+		S1 = shape[ 8 ];
+		S2 = shape[ 7 ];
+		S3 = shape[ 6 ];
+		S4 = shape[ 5 ];
+		S5 = shape[ 4 ];
+		S6 = shape[ 3 ];
+		S7 = shape[ 2 ];
+		S8 = shape[ 1 ];
+		S9 = shape[ 0 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[9]
+		];
+		dv1 = [
+			stridesX[8] - ( S0*stridesX[9] )
+		];
+		dv2 = [
+			stridesX[7] - ( S1*stridesX[8] )
+		];
+		dv3 = [
+			stridesX[6] - ( S2*stridesX[7] )
+		];
+		dv4 = [
+			stridesX[5] - ( S3*stridesX[6] )
+		];
+		dv5 = [
+			stridesX[4] - ( S4*stridesX[5] )
+		];
+		dv6 = [
+			stridesX[3] - ( S5*stridesX[4] )
+		];
+		dv7 = [
+			stridesX[2] - ( S6*stridesX[3] )
+		];
+		dv8 = [
+			stridesX[1] - ( S7*stridesX[2] )
+		];
+		dv9 = [                                   // offset increment for outermost loop
+			stridesX[0] - ( S8*stridesX[1] )
+		];
+		for ( i = 1; i < arrays.length; i++ ) {
+			sv = arrays[ i ].strides;
+			dv0.push( sv[9] );
+			dv1.push( sv[8] - ( S0*sv[9] ) );
+			dv2.push( sv[7] - ( S1*sv[8] ) );
+			dv3.push( sv[6] - ( S2*sv[7] ) );
+			dv4.push( sv[5] - ( S3*sv[6] ) );
+			dv5.push( sv[4] - ( S4*sv[5] ) );
+			dv6.push( sv[3] - ( S5*sv[4] ) );
+			dv7.push( sv[2] - ( S6*sv[3] ) );
+			dv8.push( sv[1] - ( S7*sv[2] ) );
+			dv9.push( sv[0] - ( S8*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 ];
+		S3 = shape[ 3 ];
+		S4 = shape[ 4 ];
+		S5 = shape[ 5 ];
+		S6 = shape[ 6 ];
+		S7 = shape[ 7 ];
+		S8 = shape[ 8 ];
+		S9 = shape[ 9 ];
+		dv0 = [                                   // offset increment for innermost loop
+			stridesX[0]
+		];
+		dv1 = [
+			stridesX[1] - ( S0*stridesX[0] )
+		];
+		dv2 = [
+			stridesX[2] - ( S1*stridesX[1] )
+		];
+		dv3 = [
+			stridesX[3] - ( S2*stridesX[2] )
+		];
+		dv4 = [
+			stridesX[4] - ( S3*stridesX[3] )
+		];
+		dv5 = [
+			stridesX[5] - ( S4*stridesX[4] )
+		];
+		dv6 = [
+			stridesX[6] - ( S5*stridesX[5] )
+		];
+		dv7 = [
+			stridesX[7] - ( S6*stridesX[6] )
+		];
+		dv8 = [
+			stridesX[8] - ( S7*stridesX[7] )
+		];
+		dv9 = [                                   // offset increment for outermost loop
+			stridesX[9] - ( S8*stridesX[8] )
+		];
+		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] ) );
+			dv3.push( sv[3] - ( S2*sv[2] ) );
+			dv4.push( sv[4] - ( S3*sv[3] ) );
+			dv5.push( sv[5] - ( S4*sv[4] ) );
+			dv6.push( sv[6] - ( S5*sv[5] ) );
+			dv7.push( sv[7] - ( S6*sv[6] ) );
+			dv8.push( sv[8] - ( S7*sv[7] ) );
+			dv9.push( sv[9] - ( S8*sv[8] ) );
+		}
+	}
+	// 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 ( i9 = 0; i9 < S9; i9++ ) {
+		for ( i8 = 0; i8 < S8; i8++ ) {
+			for ( i7 = 0; i7 < S7; i7++ ) {
+				for ( i6 = 0; i6 < S6; i6++ ) {
+					for ( i5 = 0; i5 < S5; i5++ ) {
+						for ( i4 = 0; i4 < S4; i4++ ) {
+							for ( i3 = 0; i3 < S3; i3++ ) {
+								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 );
+								}
+								incrementOffsets( iv, dv3 );
+							}
+							incrementOffsets( iv, dv4 );
+						}
+						incrementOffsets( iv, dv5 );
+					}
+					incrementOffsets( iv, dv6 );
+				}
+				incrementOffsets( iv, dv7 );
+			}
+			incrementOffsets( iv, dv8 );
+		}
+		incrementOffsets( iv, dv9 );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = nullary10d;