Skip to content

Commit 8a2f7e2

Browse files
committed
feat: add 6d 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 f51b7b2 commit 8a2f7e2

File tree

1 file changed

+339
-0
lines changed

1 file changed

+339
-0
lines changed
Lines changed: 339 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,339 @@
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, max-len, max-statements, max-lines-per-function */
20+
21+
'use strict';
22+
23+
// MODULES //
24+
25+
var loopOrder = require( '@stdlib/ndarray/base/binary-loop-interchange-order' );
26+
var blockSize = require( '@stdlib/ndarray/base/binary-tiling-block-size' );
27+
28+
29+
// MAIN //
30+
31+
/**
32+
* Applies a binary callback to elements in six-dimensional input ndarrays and assigns results to elements in an equivalently shaped output ndarray via loop blocking.
33+
*
34+
* @private
35+
* @param {Object} x - object containing input ndarray meta data
36+
* @param {string} x.dtype - data type
37+
* @param {Collection} x.data - data buffer
38+
* @param {NonNegativeIntegerArray} x.shape - dimensions
39+
* @param {IntegerArray} x.strides - stride lengths
40+
* @param {NonNegativeInteger} x.offset - index offset
41+
* @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
42+
* @param {Object} y - object containing input ndarray meta data
43+
* @param {string} y.dtype - data type
44+
* @param {Collection} y.data - data buffer
45+
* @param {NonNegativeIntegerArray} y.shape - dimensions
46+
* @param {IntegerArray} y.strides - stride lengths
47+
* @param {NonNegativeInteger} y.offset - index offset
48+
* @param {string} y.order - specifies whether `y` is row-major (C-style) or column-major (Fortran-style)
49+
* @param {Object} z - object containing output ndarray meta data
50+
* @param {string} z.dtype - data type
51+
* @param {Collection} z.data - data buffer
52+
* @param {NonNegativeIntegerArray} z.shape - dimensions
53+
* @param {IntegerArray} z.strides - stride lengths
54+
* @param {NonNegativeInteger} z.offset - index offset
55+
* @param {string} z.order - specifies whether `z` is row-major (C-style) or column-major (Fortran-style)
56+
* @param {Callback} fcn - binary callback
57+
*
58+
* @example
59+
* var Float64Array = require( '@stdlib/array/float64' );
60+
*
61+
* function fcn( x, y ) {
62+
* return x + y;
63+
* }
64+
*
65+
* // Create data buffers:
66+
* 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 ] );
67+
* var ybuf = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
68+
* var zbuf = new Float64Array( 12 );
69+
*
70+
* // Define the shape of the input and output arrays:
71+
* var shape = [ 1, 1, 1, 3, 2, 2 ];
72+
*
73+
* // Define the array strides:
74+
* var sx = [ 12, 12, 12, 4, 2, 1 ];
75+
* var sy = [ 12, 12, 12, 4, 2, 1 ];
76+
* var sz = [ 12, 12, 12, 4, 2, 1 ];
77+
*
78+
* // Define the index offsets:
79+
* var ox = 0;
80+
* var oy = 0;
81+
* var oz = 0;
82+
*
83+
* // Create the input and output ndarray-like objects:
84+
* var x = {
85+
* 'dtype': 'float64',
86+
* 'data': xbuf,
87+
* 'shape': shape,
88+
* 'strides': sx,
89+
* 'offset': ox,
90+
* 'order': 'row-major'
91+
* };
92+
* var y = {
93+
* 'dtype': 'float64',
94+
* 'data': ybuf,
95+
* 'shape': shape,
96+
* 'strides': sy,
97+
* 'offset': oy,
98+
* 'order': 'row-major'
99+
* };
100+
* var z = {
101+
* 'dtype': 'float64',
102+
* 'data': zbuf,
103+
* 'shape': shape,
104+
* 'strides': sz,
105+
* 'offset': oz,
106+
* 'order': 'row-major'
107+
* };
108+
*
109+
* // Apply the binary function:
110+
* blockedbinary6d( x, y, z, fcn );
111+
*
112+
* console.log( z.data );
113+
* // => <Float64Array>[ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0 ]
114+
*/
115+
function blockedbinary6d( x, y, z, fcn ) {
116+
var bsize;
117+
var xbuf;
118+
var ybuf;
119+
var zbuf;
120+
var dx0;
121+
var dx1;
122+
var dx2;
123+
var dx3;
124+
var dx4;
125+
var dx5;
126+
var dy0;
127+
var dy1;
128+
var dy2;
129+
var dy3;
130+
var dy4;
131+
var dy5;
132+
var dz0;
133+
var dz1;
134+
var dz2;
135+
var dz3;
136+
var dz4;
137+
var dz5;
138+
var ox1;
139+
var ox2;
140+
var ox3;
141+
var ox4;
142+
var ox5;
143+
var oy1;
144+
var oy2;
145+
var oy3;
146+
var oy4;
147+
var oy5;
148+
var oz1;
149+
var oz2;
150+
var oz3;
151+
var oz4;
152+
var oz5;
153+
var sh;
154+
var s0;
155+
var s1;
156+
var s2;
157+
var s3;
158+
var s4;
159+
var s5;
160+
var sx;
161+
var sy;
162+
var sz;
163+
var ox;
164+
var oy;
165+
var oz;
166+
var ix;
167+
var iy;
168+
var iz;
169+
var i0;
170+
var i1;
171+
var i2;
172+
var i3;
173+
var i4;
174+
var i5;
175+
var j0;
176+
var j1;
177+
var j2;
178+
var j3;
179+
var j4;
180+
var j5;
181+
var o;
182+
183+
// Note on variable naming convention: s#, dx#, dy#, dz#, i#, j# where # corresponds to the loop number, with `0` being the innermost loop...
184+
185+
// Resolve the loop interchange order:
186+
o = loopOrder( x.shape, x.strides, y.strides, z.strides );
187+
sh = o.sh;
188+
sx = o.sx;
189+
sy = o.sy;
190+
sz = o.sz;
191+
192+
// Determine the block size:
193+
bsize = blockSize( x.dtype, y.dtype, z.dtype );
194+
195+
// Cache the indices of the first indexed elements in the respective ndarrays...
196+
ox = x.offset;
197+
oy = y.offset;
198+
oz = z.offset;
199+
200+
// Cache references to the input and output ndarray buffers...
201+
xbuf = x.data;
202+
ybuf = y.data;
203+
zbuf = z.data;
204+
205+
// Cache offset increments for the innermost loop...
206+
dx0 = sx[0];
207+
dy0 = sy[0];
208+
dz0 = sz[0];
209+
210+
// Iterate over blocks...
211+
for ( j5 = sh[5]; j5 > 0; ) {
212+
if ( j5 < bsize ) {
213+
s5 = j5;
214+
j5 = 0;
215+
} else {
216+
s5 = bsize;
217+
j5 -= bsize;
218+
}
219+
ox5 = ox + ( j5*sx[5] );
220+
oy5 = oy + ( j5*sy[5] );
221+
oz5 = oz + ( j5*sz[5] );
222+
for ( j4 = sh[4]; j4 > 0; ) {
223+
if ( j4 < bsize ) {
224+
s4 = j4;
225+
j4 = 0;
226+
} else {
227+
s4 = bsize;
228+
j4 -= bsize;
229+
}
230+
dx5 = sx[5] - ( s4*sx[4] );
231+
dy5 = sy[5] - ( s4*sy[4] );
232+
dz5 = sz[5] - ( s4*sz[4] );
233+
ox4 = ox5 + ( j4*sx[4] );
234+
oy4 = oy5 + ( j4*sy[4] );
235+
oz4 = oz5 + ( j4*sz[4] );
236+
for ( j3 = sh[3]; j3 > 0; ) {
237+
if ( j3 < bsize ) {
238+
s3 = j3;
239+
j3 = 0;
240+
} else {
241+
s3 = bsize;
242+
j3 -= bsize;
243+
}
244+
dx4 = sx[4] - ( s3*sx[3] );
245+
dy4 = sy[4] - ( s3*sy[3] );
246+
dz4 = sz[4] - ( s3*sz[3] );
247+
ox3 = ox4 + ( j3*sx[3] );
248+
oy3 = oy4 + ( j3*sy[3] );
249+
oz3 = oz4 + ( j3*sz[3] );
250+
for ( j2 = sh[2]; j2 > 0; ) {
251+
if ( j2 < bsize ) {
252+
s2 = j2;
253+
j2 = 0;
254+
} else {
255+
s2 = bsize;
256+
j2 -= bsize;
257+
}
258+
dx3 = sx[3] - ( s2*sx[2] );
259+
dy3 = sy[3] - ( s2*sy[2] );
260+
dz3 = sz[3] - ( s2*sz[2] );
261+
ox2 = ox3 + ( j2*sx[2] );
262+
oy2 = oy3 + ( j2*sy[2] );
263+
oz2 = oz3 + ( j2*sz[2] );
264+
for ( j1 = sh[1]; j1 > 0; ) {
265+
if ( j1 < bsize ) {
266+
s1 = j1;
267+
j1 = 0;
268+
} else {
269+
s1 = bsize;
270+
j1 -= bsize;
271+
}
272+
dx2 = sx[2] - ( s1*sx[1] );
273+
dy2 = sy[2] - ( s1*sy[1] );
274+
dz2 = sz[2] - ( s1*sz[1] );
275+
ox1 = ox2 + ( j1*sx[1] );
276+
oy1 = oy2 + ( j1*sy[1] );
277+
oz1 = oz2 + ( j1*sz[1] );
278+
for ( j0 = sh[0]; j0 > 0; ) {
279+
if ( j0 < bsize ) {
280+
s0 = j0;
281+
j0 = 0;
282+
} else {
283+
s0 = bsize;
284+
j0 -= bsize;
285+
}
286+
// Compute index offsets for the first input and output ndarray elements in the current block...
287+
ix = ox1 + ( j0*sx[0] );
288+
iy = oy1 + ( j0*sy[0] );
289+
iz = oz1 + ( j0*sz[0] );
290+
291+
// Compute loop offset increments...
292+
dx1 = sx[1] - ( s0*sx[0] );
293+
dy1 = sy[1] - ( s0*sy[0] );
294+
dz1 = sz[1] - ( s0*sz[0] );
295+
296+
// Iterate over the ndarray dimensions...
297+
for ( i5 = 0; i5 < s5; i5++ ) {
298+
for ( i4 = 0; i4 < s4; i4++ ) {
299+
for ( i3 = 0; i3 < s3; i3++ ) {
300+
for ( i2 = 0; i2 < s2; i2++ ) {
301+
for ( i1 = 0; i1 < s1; i1++ ) {
302+
for ( i0 = 0; i0 < s0; i0++ ) {
303+
zbuf[ iz ] = fcn( xbuf[ ix ], ybuf[ iy ] );
304+
ix += dx0;
305+
iy += dy0;
306+
iz += dz0;
307+
}
308+
ix += dx1;
309+
iy += dy1;
310+
iz += dz1;
311+
}
312+
ix += dx2;
313+
iy += dy2;
314+
iz += dz2;
315+
}
316+
ix += dx3;
317+
iy += dy3;
318+
iz += dz3;
319+
}
320+
ix += dx4;
321+
iy += dy4;
322+
iz += dz4;
323+
}
324+
ix += dx5;
325+
iy += dy5;
326+
iz += dz5;
327+
}
328+
}
329+
}
330+
}
331+
}
332+
}
333+
}
334+
}
335+
336+
337+
// EXPORTS //
338+
339+
module.exports = blockedbinary6d;

0 commit comments

Comments
 (0)