All files nd_accessors.js

68.93% Statements 162/235
100% Branches 1/1
0% Functions 0/1
68.93% Lines 162/235

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 226 227 228 229 230 231 232 233 234 235 2365x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x                                                                                                                                                   5x 5x 5x 5x 5x  
/**
* @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';
 
// MODULES //
 
var numel = require( '@stdlib/ndarray/base/numel' );
var vind2bind = require( '@stdlib/ndarray/base/vind2bind' );
 
 
// VARIABLES //
 
var MODE = 'throw';
 
 
// MAIN //
 
/**
* Applies a condition to two n-dimensional input ndarrays according to a n-dimensional boolean ndarray and assigns results to elements in a n-dimensional output ndarray.
*
* @private
* @param {Object} condition - object containing boolean condition ndarray meta data
* @param {*} condition.dtype - data type
* @param {Collection} condition.data - data buffer
* @param {NonNegativeIntegerArray} condition.shape - dimensions
* @param {IntegerArray} condition.strides - stride lengths
* @param {NonNegativeInteger} condition.offset - index offset
* @param {string} condition.order - specifies whether `condition` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} condition.accessors - data buffer accessors
* @param {Object} x - object containing first 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 second 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} out - object containing output ndarray meta data
* @param {*} out.dtype - data type
* @param {Collection} out.data - data buffer
* @param {NonNegativeIntegerArray} out.shape - dimensions
* @param {IntegerArray} out.strides - stride lengths
* @param {NonNegativeInteger} out.offset - index offset
* @param {string} out.order - specifies whether `out` is row-major (C-style) or column-major (Fortran-style)
* @param {Array<Function>} out.accessors - data buffer accessors
* @returns {void}
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var BooleanArray = require( '@stdlib/array/bool' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* // Create data buffers:
* var cbuf = new BooleanArray( [ 1, 0, 0, 1, 0, 1, 1, 0 ] );
* var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var ybuf = new Complex64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 ] );
* var obuf = new Complex64Array( 4 );
*
* // Define the shape of the input and output arrays:
* var shape = [ 2, 2 ];
*
* // Define the array strides:
* var sc = [ 2, 1 ];
* var sx = [ 2, 1 ];
* var sy = [ 2, 1 ];
* var so = [ 2, 1 ];
*
* // Define the index offsets:
* var oc = 0;
* var ox = 0;
* var oy = 0;
* var oo = 0;
*
* // Define getters and setters:
* function getter( buf, idx ) {
*     return buf.get( idx );
* }
*
* function setter( buf, idx, value ) {
*     buf.set( value, idx );
* }
*
* // Create the input and output ndarray-like objects:
* var condition = {
*     'dtype': 'bool',
*     'data': cbuf,
*     'shape': shape,
*     'strides': sc,
*     'offset': oc,
*     'order': 'row-major',
*     'accessors': [ getter, setter ]
* };
* var x = {
*     'dtype': 'complex64',
*     'data': xbuf,
*     'shape': shape,
*     'strides': sx,
*     'offset': ox,
*     'order': 'row-major',
*     'accessors': [ getter, setter ]
* };
* var y = {
*     'dtype': 'complex64',
*     'data': ybuf,
*     'shape': shape,
*     'strides': sy,
*     'offset': oy,
*     'order': 'row-major',
*     'accessors': [ getter, setter ]
* };
* var out = {
*     'dtype': 'complex64',
*     'data': obuf,
*     'shape': shape,
*     'strides': so,
*     'offset': oo,
*     'order': 'row-major',
*     'accessors': [ getter, setter ]
* };
*
* // Apply condition:
* wherend( condition, x, y, out );
*
* var v = out.data.get( 0 );
*
* var re = realf( v );
* // returns 1.0
*
* var im = imagf( v );
* // returns 2.0
*/
function wherend( condition, x, y, out ) {
	var cbuf;
	var xbuf;
	var ybuf;
	var getc;
	var getx;
	var gety;
	var seto;
	var obuf;
	var ordc;
	var ordx;
	var ordy;
	var ordo;
	var len;
	var sh;
	var sc;
	var sx;
	var sy;
	var so;
	var oc;
	var ox;
	var oy;
	var oo;
	var ic;
	var ix;
	var iy;
	var io;
	var i;

	sh = condition.shape;

	// Compute the total number of elements over which to iterate:
	len = numel( sh );

	// Cache references to the input and output ndarray data buffers:
	cbuf = condition.data;
	xbuf = x.data;
	ybuf = y.data;
	obuf = out.data;

	// Cache references to the respective stride arrays:
	sc = condition.strides;
	sx = x.strides;
	sy = y.strides;
	so = out.strides;

	// Cache the indices of the first indexed elements in the respective ndarrays:
	oc = condition.offset;
	ox = x.offset;
	oy = y.offset;
	oo = out.offset;

	// Cache the respective array orders:
	ordc = condition.order;
	ordx = x.order;
	ordy = y.order;
	ordo = out.order;

	// Cache accessors:
	getc = condition.accessors[ 0 ];
	getx = x.accessors[ 0 ];
	gety = y.accessors[ 0 ];
	seto = out.accessors[ 1 ];

	// Iterate over each element based on the linear **view** index, regardless as to how the data is stored in memory...
	for ( i = 0; i < len; i++ ) {
		ic = vind2bind( sh, sc, oc, ordc, i, MODE );
		ix = vind2bind( sh, sx, ox, ordx, i, MODE );
		iy = vind2bind( sh, sy, oy, ordy, i, MODE );
		io = vind2bind( sh, so, oo, ordo, i, MODE );
		seto( obuf, io, ( getc( cbuf, ic ) ) ? getx( xbuf, ix ) : gety( ybuf, iy ) ); // eslint-disable-line max-len
	}
}
 
 
// EXPORTS //
 
module.exports = wherend;