All files 1d_accessors.js

100% Statements 225/225
100% Branches 3/3
100% Functions 1/1
100% Lines 225/225

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 2264x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 28x 28x 28x 28x 28x 28x 28x 7x 4x 4x 4x 4x 4x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 quaternary callback to elements in a one-dimensional input ndarrays and assigns results to elements in an equivalently shaped output ndarray.
*
* @private
* @param {Object} x - object containing input ndarray meta data
* @param {*} x.dtype - data type
* @param {Collection} x.data - data buffer
* @param {NonNegativeIntegerArray} x.shape - dimensions
* @param {IntegerArray} x.strides - stride lengths
* @param {NonNegativeInteger} x.offset - index offset
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} x.accessors - data buffer accessors
* @param {Object} y - object containing input ndarray meta data
* @param {*} y.dtype - data type
* @param {Collection} y.data - data buffer
* @param {NonNegativeIntegerArray} y.shape - dimensions
* @param {IntegerArray} y.strides - stride lengths
* @param {NonNegativeInteger} y.offset - index offset
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} y.accessors - data buffer accessors
* @param {Object} z - object containing input ndarray meta data
* @param {*} z.dtype - data type
* @param {Collection} z.data - data buffer
* @param {NonNegativeIntegerArray} z.shape - dimensions
* @param {IntegerArray} z.strides - stride lengths
* @param {NonNegativeInteger} z.offset - index offset
* @param {string} z.order - specifies whether `z` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} z.accessors - data buffer accessors
* @param {Object} w - object containing input ndarray meta data
* @param {*} w.dtype - data type
* @param {Collection} w.data - data buffer
* @param {NonNegativeIntegerArray} w.shape - dimensions
* @param {IntegerArray} w.strides - stride lengths
* @param {NonNegativeInteger} w.offset - index offset
* @param {string} w.order - specifies whether `w` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} w.accessors - data buffer accessors
* @param {Object} u - object containing output ndarray meta data
* @param {*} u.dtype - data type
* @param {Collection} u.data - data buffer
* @param {NonNegativeIntegerArray} u.shape - dimensions
* @param {IntegerArray} u.strides - stride lengths
* @param {NonNegativeInteger} u.offset - index offset
* @param {string} u.order - specifies whether `u` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} u.accessors - data buffer accessors
* @param {Callback} fcn - quaternary callback
* @returns {void}
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var accessors = require( '@stdlib/array/base/accessors' );
* var copy = require( '@stdlib/array/base/copy' );
*
* function fcn( a, b, c, d ) {
*     return a + b + c + d;
* }
*
* // Create data buffers:
* var xbuf = toAccessorArray( [ 1.0, 2.0, 3.0 ] );
* var ybuf = toAccessorArray( [ 1.0, 1.0, 1.0 ] );
* var zbuf = toAccessorArray( [ 2.0, 2.0, 2.0 ] );
* var wbuf = toAccessorArray( [ 3.0, 3.0, 3.0 ] );
* var ubuf = toAccessorArray( [ 0.0, 0.0, 0.0 ] );
*
* // Define the shape of the input and output arrays:
* var shape = [ 3 ];
*
* // Define the array strides:
* var sx = [ 1 ];
* var sy = [ 1 ];
* var sz = [ 1 ];
* var sw = [ 1 ];
* var su = [ 1 ];
*
* // Define the index offsets:
* var ox = 0;
* var oy = 0;
* var oz = 0;
* var ow = 0;
* var ou = 0;
*
* // Create the input and output ndarray-like objects:
* var x = {
*     'dtype': 'generic',
*     'data': xbuf,
*     'shape': shape,
*     'strides': sx,
*     'offset': ox,
*     'order': 'row-major',
*     'accessors': accessors( xbuf ).accessors
* };
* var y = {
*     'dtype': 'generic',
*     'data': ybuf,
*     'shape': shape,
*     'strides': sy,
*     'offset': oy,
*     'order': 'row-major',
*     'accessors': accessors( ybuf ).accessors
* };
* var z = {
*     'dtype': 'generic',
*     'data': zbuf,
*     'shape': shape,
*     'strides': sz,
*     'offset': oz,
*     'order': 'row-major',
*     'accessors': accessors( zbuf ).accessors
* };
* var w = {
*     'dtype': 'generic',
*     'data': wbuf,
*     'shape': shape,
*     'strides': sw,
*     'offset': ow,
*     'order': 'row-major',
*     'accessors': accessors( wbuf ).accessors
* };
* var u = {
*     'dtype': 'generic',
*     'data': ubuf,
*     'shape': shape,
*     'strides': su,
*     'offset': ou,
*     'order': 'row-major',
*     'accessors': accessors( ubuf ).accessors
* };
*
* // Apply the quaternary function:
* quaternary1d( x, y, z, w, u, fcn );
*
* console.log( copy( u.data ) );
* // => [ 7.0, 8.0, 9.0 ]
*/
function quaternary1d( x, y, z, w, u, fcn ) {
	var xbuf;
	var ybuf;
	var zbuf;
	var wbuf;
	var ubuf;
	var xget;
	var yget;
	var zget;
	var wget;
	var uset;
	var dx;
	var dy;
	var dz;
	var dw;
	var du;
	var S0;
	var ix;
	var iy;
	var iz;
	var iw;
	var iu;
	var i;
 
	// Note on variable naming convention: S#, where # corresponds to the loop number, with `0` being the innermost loop...
 
	// Extract loop variables: dimensions and loop offset (pointer) increments...
	S0 = x.shape[ 0 ];
	dx = x.strides[ 0 ];
	dy = y.strides[ 0 ];
	dz = z.strides[ 0 ];
	dw = w.strides[ 0 ];
	du = u.strides[ 0 ];
 
	// Set the pointers to the first indexed elements in the respective ndarrays...
	ix = x.offset;
	iy = y.offset;
	iz = z.offset;
	iw = w.offset;
	iu = u.offset;
 
	// Cache references to the input and output ndarray buffers...
	xbuf = x.data;
	ybuf = y.data;
	zbuf = z.data;
	wbuf = w.data;
	ubuf = u.data;
 
	// Cache accessors:
	xget = x.accessors[ 0 ];
	yget = y.accessors[ 0 ];
	zget = z.accessors[ 0 ];
	wget = w.accessors[ 0 ];
	uset = u.accessors[ 1 ];
 
	// Iterate over the ndarray dimensions...
	for ( i = 0; i < S0; i++ ) {
		uset( ubuf, iu, fcn( xget( xbuf, ix ), yget( ybuf, iy ), zget( zbuf, iz ), wget( wbuf, iw ) ) ); // eslint-disable-line max-len
		ix += dx;
		iy += dy;
		iz += dz;
		iw += dw;
		iu += du;
	}
}
 
 
// EXPORTS //
 
module.exports = quaternary1d;