Skip to content

Commit ac735b1

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add ndarray/for-each
PR-URL: #3926 Ref: #2656 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent af07f7b commit ac735b1

File tree

11 files changed

+1641
-0
lines changed

11 files changed

+1641
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/for-each/README.md

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# forEach
22+
23+
> Invoke a callback function once for each [ndarray][@stdlib/ndarray/ctor] element.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var forEach = require( '@stdlib/ndarray/for-each' );
37+
```
38+
39+
#### forEach( x, fcn\[, thisArg] )
40+
41+
Invokes a callback function once for each [ndarray][@stdlib/ndarray/ctor] element.
42+
43+
<!-- eslint-disable max-len -->
44+
45+
```javascript
46+
var Float64Array = require( '@stdlib/array/float64' );
47+
var ndarray = require( '@stdlib/ndarray/ctor' );
48+
var naryFunction = require( '@stdlib/utils/nary-function' );
49+
var log = require( '@stdlib/console/log' );
50+
51+
var buffer = 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 ] );
52+
var shape = [ 2, 3 ];
53+
var strides = [ 6, 1 ];
54+
var offset = 1;
55+
56+
var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
57+
// returns <ndarray>
58+
59+
forEach( x, naryFunction( log, 1 ) );
60+
```
61+
62+
The function accepts the following arguments:
63+
64+
- **x**: input [ndarray][@stdlib/ndarray/ctor].
65+
- **fcn**: callback to apply.
66+
- **thisArg**: callback execution context _(optional)_.
67+
68+
To set the callback function execution context, provide a `thisArg`.
69+
70+
<!-- eslint-disable no-invalid-this, max-len -->
71+
72+
```javascript
73+
var Float64Array = require( '@stdlib/array/float64' );
74+
var ndarray = require( '@stdlib/ndarray/ctor' );
75+
76+
function accumulate( z ) {
77+
this.sum += z;
78+
}
79+
80+
var buffer = 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 ] );
81+
var shape = [ 2, 3 ];
82+
var strides = [ 6, 1 ];
83+
var offset = 1;
84+
var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
85+
// returns <ndarray>
86+
87+
var ctx = {
88+
'sum': 0
89+
};
90+
91+
forEach( x, accumulate, ctx );
92+
var sum = ctx.sum;
93+
// returns 36
94+
```
95+
96+
The callback function is provided the following arguments:
97+
98+
- **value**: current array element.
99+
- **indices**: current array element indices.
100+
- **arr**: the input [ndarray][@stdlib/ndarray/ctor].
101+
102+
</section>
103+
104+
<!-- /.usage -->
105+
106+
<section class="notes">
107+
108+
## Notes
109+
110+
- For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before applying a callback function in order to achieve better performance.
111+
112+
</section>
113+
114+
<!-- /.notes -->
115+
116+
<section class="examples">
117+
118+
## Examples
119+
120+
<!-- eslint no-undef: "error" -->
121+
122+
```javascript
123+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
124+
var ndarray = require( '@stdlib/ndarray/ctor' );
125+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
126+
var naryFunction = require( '@stdlib/utils/nary-function' );
127+
var log = require( '@stdlib/console/log' );
128+
var forEach = require( '@stdlib/ndarray/for-each' );
129+
130+
var buffer = discreteUniform( 10, -100, 100, {
131+
'dtype': 'generic'
132+
});
133+
var shape = [ 5, 2 ];
134+
var strides = [ 2, 1 ];
135+
var offset = 0;
136+
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
137+
138+
log( ndarray2array( x ) );
139+
forEach( x, naryFunction( log, 2 ) );
140+
```
141+
142+
</section>
143+
144+
<!-- /.examples -->
145+
146+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
147+
148+
<section class="related">
149+
150+
</section>
151+
152+
<!-- /.related -->
153+
154+
<section class="links">
155+
156+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
157+
158+
<!-- <related-links> -->
159+
160+
<!-- </related-links> -->
161+
162+
</section>
163+
164+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/for-each/benchmark/benchmark.1d.js

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 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+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
27+
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
28+
var ndarray = require( '@stdlib/ndarray/ctor' );
29+
var pkg = require( './../package.json' ).name;
30+
var forEach = require( './../lib' );
31+
32+
33+
// VARIABLES //
34+
35+
var xtypes = [ 'generic' ];
36+
var orders = [ 'row-major', 'column-major' ];
37+
38+
39+
// FUNCTIONS //
40+
41+
/**
42+
* Callback invoked for each ndarray element.
43+
*
44+
* @private
45+
* @param {number} value - array element
46+
* @throws {Error} unexpected error
47+
*/
48+
function fcn( value ) {
49+
if ( isnan( value ) ) {
50+
throw new Error( 'unexpected error' );
51+
}
52+
}
53+
54+
/**
55+
* Creates a benchmark function.
56+
*
57+
* @private
58+
* @param {PositiveInteger} len - array length
59+
* @param {NonNegativeIntegerArray} shape - ndarray shape
60+
* @param {string} xtype - input ndarray data type
61+
* @param {string} order - ndarray memory layout
62+
* @returns {Function} benchmark function
63+
*/
64+
function createBenchmark( len, shape, xtype, order ) {
65+
var strides;
66+
var xbuf;
67+
var x;
68+
69+
xbuf = discreteUniform( len, -100, 100, {
70+
'dtype': xtype
71+
});
72+
strides = shape2strides( shape, order );
73+
x = ndarray( xtype, xbuf, shape, strides, 0, order );
74+
75+
return benchmark;
76+
77+
/**
78+
* Benchmark function.
79+
*
80+
* @private
81+
* @param {Benchmark} b - benchmark instance
82+
*/
83+
function benchmark( b ) {
84+
var i;
85+
86+
b.tic();
87+
for ( i = 0; i < b.iterations; i++ ) {
88+
forEach( x, fcn );
89+
if ( isnan( x.data[ i%len ] ) ) {
90+
b.fail( 'should not return NaN' );
91+
}
92+
}
93+
b.toc();
94+
if ( isnan( x.data[ i%len ] ) ) {
95+
b.fail( 'should not return NaN' );
96+
}
97+
b.pass( 'benchmark finished' );
98+
b.end();
99+
}
100+
}
101+
102+
103+
// MAIN //
104+
105+
/**
106+
* Main execution sequence.
107+
*
108+
* @private
109+
*/
110+
function main() {
111+
var len;
112+
var min;
113+
var max;
114+
var ord;
115+
var sh;
116+
var t1;
117+
var f;
118+
var i;
119+
var j;
120+
var k;
121+
122+
min = 1; // 10^min
123+
max = 6; // 10^max
124+
125+
for ( k = 0; k < orders.length; k++ ) {
126+
ord = orders[ k ];
127+
for ( j = 0; j < xtypes.length; j++ ) {
128+
t1 = xtypes[ j ];
129+
for ( i = min; i <= max; i++ ) {
130+
len = pow( 10, i );
131+
132+
sh = [ len ];
133+
f = createBenchmark( len, sh, t1, ord );
134+
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+ord+',xtype='+t1, f );
135+
}
136+
}
137+
}
138+
}
139+
140+
main();

0 commit comments

Comments
 (0)