Skip to content

Commit 9942682

Browse files
committed
feat: add 3d blocked kernel
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 6f4f47e commit 9942682

File tree

1 file changed

+317
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base/unary-reduce-strided1d-to-struct/lib

1 file changed

+317
-0
lines changed
Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,317 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* eslint-disable max-depth */
20+
21+
'use strict';
22+
23+
// MODULES //
24+
25+
var loopOrder = require( '@stdlib/ndarray/base/unary-loop-interchange-order' );
26+
var blockSize = require( '@stdlib/ndarray/base/unary-tiling-block-size' );
27+
var takeIndexed = require( '@stdlib/array/base/take-indexed' );
28+
var copyIndexed = require( '@stdlib/array/base/copy-indexed' );
29+
var zeros = require( '@stdlib/array/base/zeros' );
30+
var incrementOffsets = require( './increment_offsets.js' );
31+
var setViewOffsets = require( './set_view_offsets.js' );
32+
var offsets = require( './offsets.js' );
33+
34+
35+
// MAIN //
36+
37+
/**
38+
* Performs a reduction over an input ndarray and assigns results to a provided output ndarray via loop blocking.
39+
*
40+
* @private
41+
* @param {Function} fcn - wrapper for a one-dimensional strided array reduction function
42+
* @param {Array<Object>} arrays - ndarrays
43+
* @param {Array<Object>} views - initialized ndarray-like objects representing sub-array views
44+
* @param {IntegerArray} strides - loop dimension strides for the input ndarray
45+
* @param {Function} strategy - input ndarray reshape strategy
46+
* @param {Options} opts - function options
47+
* @returns {void}
48+
*
49+
* @example
50+
* var Float64Array = require( '@stdlib/array/float64' );
51+
* var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
52+
* var Float64Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
53+
* var structFactory = require( '@stdlib/array/struct-factory' );
54+
* var ztest = require( '@stdlib/stats/base/ndarray/ztest' );
55+
*
56+
* var ResultsArray = structFactory( Float64Results );
57+
*
58+
* // Create data buffers:
59+
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
60+
* var ybuf = new ResultsArray( 3 );
61+
*
62+
* // Define the array shapes:
63+
* var xsh = [ 1, 1, 3, 2, 2 ];
64+
* var ysh = [ 1, 1, 3 ];
65+
*
66+
* // Define the array strides:
67+
* var sx = [ 12, 12, 4, 2, 1 ];
68+
* var sy = [ 3, 3, 1 ];
69+
*
70+
* // Define the index offsets:
71+
* var ox = 0;
72+
* var oy = 0;
73+
*
74+
* // Create an input ndarray-like object:
75+
* var x = {
76+
* 'dtype': 'float64',
77+
* 'data': xbuf,
78+
* 'shape': xsh,
79+
* 'strides': sx,
80+
* 'offset': ox,
81+
* 'order': 'row-major'
82+
* };
83+
*
84+
* // Create an output ndarray-like object:
85+
* var y = {
86+
* 'dtype': Float64Results,
87+
* 'data': ybuf,
88+
* 'shape': ysh,
89+
* 'strides': sy,
90+
* 'offset': oy,
91+
* 'order': 'row-major'
92+
* };
93+
*
94+
* // Create additional parameter ndarray-like objects:
95+
* var alternative = {
96+
* 'dtype': 'generic',
97+
* 'data': [ 'two-sided' ],
98+
* 'shape': ysh,
99+
* 'strides': [ 0, 0, 0 ],
100+
* 'offset': 0,
101+
* 'order': 'row-major'
102+
};
103+
* var alpha = {
104+
* 'dtype': 'float64',
105+
* 'data': [ 0.05 ],
106+
* 'shape': ysh,
107+
* 'strides': [ 0, 0, 0 ],
108+
* 'offset': 0,
109+
* 'order': 'row-major'
110+
};
111+
* var mu = {
112+
* 'dtype': 'float64',
113+
* 'data': [ 0.0 ],
114+
* 'shape': ysh,
115+
* 'strides': [ 0, 0, 0 ],
116+
* 'offset': 0,
117+
* 'order': 'row-major'
118+
};
119+
* var sigma = {
120+
* 'dtype': 'float64',
121+
* 'data': [ 1.0 ],
122+
* 'shape': ysh,
123+
* 'strides': [ 0, 0, 0 ],
124+
* 'offset': 0,
125+
* 'order': 'row-major'
126+
* };
127+
*
128+
* // Initialize ndarray-like objects representing sub-array views:
129+
* var views = [
130+
* {
131+
* 'dtype': x.dtype,
132+
* 'data': x.data,
133+
* 'shape': [ 2, 2 ],
134+
* 'strides': [ 2, 1 ],
135+
* 'offset': x.offset,
136+
* 'order': x.order
137+
* },
138+
* {
139+
* 'dtype': y.dtype,
140+
* 'data': y.data,
141+
* 'shape': [],
142+
* 'strides': [ 0 ],
143+
* 'offset': y.offset,
144+
* 'order': y.order
145+
* },
146+
* {
147+
* 'dtype': alternative.dtype,
148+
* 'data': alternative.data,
149+
* 'shape': [],
150+
* 'strides': [ 0 ],
151+
* 'offset': alternative.offset,
152+
* 'order': alternative.order
153+
* },
154+
* {
155+
* 'dtype': alpha.dtype,
156+
* 'data': alpha.data,
157+
* 'shape': [],
158+
* 'strides': [ 0 ],
159+
* 'offset': alpha.offset,
160+
* 'order': alpha.order
161+
* },
162+
* {
163+
* 'dtype': mu.dtype,
164+
* 'data': mu.data,
165+
* 'shape': [],
166+
* 'strides': [ 0 ],
167+
* 'offset': mu.offset,
168+
* 'order': mu.order
169+
* },
170+
* {
171+
* 'dtype': sigma.dtype,
172+
* 'data': sigma.data,
173+
* 'shape': [],
174+
* 'strides': [ 0 ],
175+
* 'offset': sigma.offset,
176+
* 'order': sigma.order
177+
* }
178+
* ];
179+
*
180+
* // Define a reshape strategy:
181+
* function strategy( x ) {
182+
* return {
183+
* 'dtype': x.dtype,
184+
* 'data': x.data,
185+
* 'shape': [ 4 ],
186+
* 'strides': [ 1 ],
187+
* 'offset': x.offset,
188+
* 'order': x.order
189+
* };
190+
* }
191+
*
192+
* // Perform a reduction:
193+
* blockedunary3d( ztest, [ x, y, alternative, alpha, mu, sigma ], views, [ 12, 12, 4 ], strategy, {} );
194+
*
195+
* var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
196+
* // returns [ [ [ <Float64Results>, <Float64Results>, <Float64Results> ] ] ]
197+
*/
198+
function blockedunary3d( fcn, arrays, views, strides, strategy, opts ) {
199+
var bsize;
200+
var dv0;
201+
var dv1;
202+
var dv2;
203+
var ov1;
204+
var ov2;
205+
var sh;
206+
var s0;
207+
var s1;
208+
var s2;
209+
var sv;
210+
var ov;
211+
var iv;
212+
var i0;
213+
var i1;
214+
var i2;
215+
var j0;
216+
var j1;
217+
var j2;
218+
var N;
219+
var x;
220+
var y;
221+
var v;
222+
var o;
223+
var k;
224+
225+
// Note on variable naming convention: S#, dv#, i#, j# where # corresponds to the loop number, with `0` being the innermost loop...
226+
227+
N = arrays.length;
228+
x = arrays[ 0 ];
229+
y = arrays[ 1 ];
230+
231+
// Resolve the loop interchange order:
232+
o = loopOrder( y.shape, strides, y.strides );
233+
sh = o.sh;
234+
sv = [ o.sx, o.sy ];
235+
for ( k = 2; k < N; k++ ) {
236+
sv.push( takeIndexed( arrays[k].strides, o.idx ) );
237+
}
238+
// Determine the block size:
239+
bsize = blockSize( x.dtype, y.dtype );
240+
241+
// Resolve a list of pointers to the first indexed elements in the respective ndarrays:
242+
ov = offsets( arrays );
243+
244+
// Cache offset increments for the innermost loop...
245+
dv0 = [];
246+
for ( k = 0; k < N; k++ ) {
247+
dv0.push( sv[k][0] );
248+
}
249+
// Initialize loop variables...
250+
ov1 = zeros( N );
251+
ov2 = zeros( N );
252+
dv1 = zeros( N );
253+
dv2 = zeros( N );
254+
iv = zeros( N );
255+
256+
// 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:
257+
v = copyIndexed( views );
258+
259+
// Iterate over blocks...
260+
for ( j2 = sh[2]; j2 > 0; ) {
261+
if ( j2 < bsize ) {
262+
s2 = j2;
263+
j2 = 0;
264+
} else {
265+
s2 = bsize;
266+
j2 -= bsize;
267+
}
268+
for ( k = 0; k < N; k++ ) {
269+
ov2[ k ] = ov[k] + ( j2*sv[k][2] );
270+
}
271+
for ( j1 = sh[1]; j1 > 0; ) {
272+
if ( j1 < bsize ) {
273+
s1 = j1;
274+
j1 = 0;
275+
} else {
276+
s1 = bsize;
277+
j1 -= bsize;
278+
}
279+
for ( k = 0; k < N; k++ ) {
280+
ov1[ k ] = ov2[k] + ( j1*sv[k][1] );
281+
dv2[ k ] = sv[k][2] - ( s1*sv[k][1] );
282+
}
283+
for ( j0 = sh[0]; j0 > 0; ) {
284+
if ( j0 < bsize ) {
285+
s0 = j0;
286+
j0 = 0;
287+
} else {
288+
s0 = bsize;
289+
j0 -= bsize;
290+
}
291+
// Compute index offsets and loop offset increments for the first ndarray elements in the current block...
292+
for ( k = 0; k < N; k++ ) {
293+
iv[ k ] = ov1[k] + ( j0*sv[k][0] );
294+
dv1[ k ] = sv[k][1] - ( s0*sv[k][0] );
295+
}
296+
// Iterate over the non-reduced ndarray dimensions...
297+
for ( i2 = 0; i2 < s2; i2++ ) {
298+
for ( i1 = 0; i1 < s1; i1++ ) {
299+
for ( i0 = 0; i0 < s0; i0++ ) {
300+
setViewOffsets( views, iv );
301+
v[ 0 ] = strategy( views[ 0 ] );
302+
fcn( v, opts );
303+
incrementOffsets( iv, dv0 );
304+
}
305+
incrementOffsets( iv, dv1 );
306+
}
307+
incrementOffsets( iv, dv2 );
308+
}
309+
}
310+
}
311+
}
312+
}
313+
314+
315+
// EXPORTS //
316+
317+
module.exports = blockedunary3d;

0 commit comments

Comments
 (0)