Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ var offsets = require( './offsets.js' );
* ];
*
* // Perform a reduction:
* unary2d( base, [ x, y ], views, [ 12, 12, 4 ], {} );
* unary3d( base, [ x, y ], views, [ 12, 12, 4 ], {} );
*
* var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
* // returns [ [ [ true, false, true ] ] ]
*/
function unary2d( fcn, arrays, views, strides, opts ) {
function unary3d( fcn, arrays, views, strides, opts ) {
var ybuf;
var dv0;
var dv1;
Expand Down Expand Up @@ -175,4 +175,4 @@ function unary2d( fcn, arrays, views, strides, opts ) {

// EXPORTS //

module.exports = unary2d;
module.exports = unary3d;
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
/**
* @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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var incrementOffsets = require( './increment_offsets.js' );
var setViewOffsets = require( './set_view_offsets.js' );
var offsets = require( './offsets.js' );


// MAIN //

/**
* Performs a reduction over an input ndarray and assigns results to a provided output ndarray.
*
* @private
* @param {Function} fcn - reduction function
* @param {Array<Object>} arrays - ndarrays
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
* @param {IntegerArray} strides - loop dimension strides for the input ndarray
* @param {Options} opts - function options
* @returns {void}
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var accessors = require( '@stdlib/array/base/accessors' );
* var Float64Array = require( '@stdlib/array/float64' );
* var filled = require( '@stdlib/array/base/filled' );
* var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
* var base = require( '@stdlib/ndarray/base/every' );
*
* // Create data buffers:
* var xbuf = toAccessorArray( new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ) );
* var ybuf = toAccessorArray( filled( false, 3 ) );
*
* // Define the array shapes:
* var xsh = [ 1, 1, 3, 2, 2 ];
* var ysh = [ 1, 1, 3 ];
*
* // Define the array strides:
* var sx = [ 12, 12, 4, 2, 1 ];
* var sy = [ 3, 3, 1 ];
*
* // Define the index offsets:
* var ox = 0;
* var oy = 0;
*
* // Create an input ndarray-like object:
* var x = {
* 'dtype': 'float64',
* 'data': xbuf,
* 'shape': xsh,
* 'strides': sx,
* 'offset': ox,
* 'order': 'row-major',
* 'accessors': accessors( xbuf ).accessors
* };
*
* // Create an output ndarray-like object:
* var y = {
* 'dtype': 'generic',
* 'data': ybuf,
* 'shape': ysh,
* 'strides': sy,
* 'offset': oy,
* 'order': 'row-major',
* 'accessors': accessors( ybuf ).accessors
* };
*
* // 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
* }
* ];
*
* // Perform a reduction:
* unary3d( base, [ x, y ], views, [ 12, 12, 4 ], {} );
*
* var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
* // returns [ [ [ true, false, true ] ] ]
*/
function unary3d( fcn, arrays, views, strides, opts ) {
var ybuf;
var set;
var dv0;
var dv1;
var dv2;
var sh;
var S0;
var S1;
var S2;
var sv;
var iv;
var i0;
var i1;
var i2;
var y;
var i;

// Note on variable naming convention: S#, dv#, i# where # corresponds to the loop number, with `0` being the innermost loop...

// Resolve the output ndarray and associated shape:
y = arrays[ 1 ];
sh = y.shape;

// Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments...
if ( isRowMajor( y.order ) ) {
// For row-major ndarrays, the last dimensions have the fastest changing indices...
S0 = sh[ 2 ];
S1 = sh[ 1 ];
S2 = sh[ 0 ];
dv0 = [ strides[2] ];
dv1 = [ strides[1] - ( S0*strides[2] ) ];
dv2 = [ strides[0] - ( S1*strides[1] ) - ( S0*strides[2] ) ];
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] ) - ( S0*sv[2] ) );
}
} else {
// For column-major ndarrays, the first dimensions have the fastest changing indices...
S0 = sh[ 0 ];
S1 = sh[ 1 ];
S2 = sh[ 2 ];
dv0 = [ strides[0] ];
dv1 = [ strides[1] - ( S0*strides[0] ) ];
dv2 = [ strides[2] - ( S1*strides[1] ) - ( S0*strides[2] ) ];
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] ) - ( S0*sv[2] ) );
}
}
// Resolve a list of pointers to the first indexed elements in the respective ndarrays:
iv = offsets( arrays );

// Cache a reference to the output ndarray buffer:
ybuf = y.data;

// Cache accessors:
set = y.accessors[ 1 ];

// Iterate over the non-reduced ndarray dimensions...
for ( i2 = 0; i2 < S2; i2++ ) {
for ( i1 = 0; i1 < S1; i1++ ) {
for ( i0 = 0; i0 < S0; i0++ ) {
setViewOffsets( views, iv );
set( ybuf, iv[ 1 ], fcn( views, opts ) );
incrementOffsets( iv, dv0 );
}
incrementOffsets( iv, dv1 );
}
incrementOffsets( iv, dv2 );
}
}


// EXPORTS //

module.exports = unary3d;
Loading