Skip to content

Commit 09a48fc

Browse files
kgrytekgryte
committed
feat: add array/base/mskunary3d 
1 parent 3c3d856 commit 09a48fc

File tree

10 files changed

+925
-0
lines changed

10 files changed

+925
-0
lines changed

‎lib/node_modules/@stdlib/array/base/mskunary3d/README.md

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2023 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+
# mskunary3d
22+
23+
> Apply a unary callback to elements in a three-dimensional nested input array according to elements in a three-dimensional nested mask array and assign results to elements in a three-dimensional nested output array.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var mskunary3d = require( '@stdlib/array/base/mskunary3d' );
37+
```
38+
39+
#### mskunary3d( arrays, shape, fcn )
40+
41+
Applies a unary callback to elements in a three-dimensional nested input array according to elements in a three-dimensional nested mask array and assigns results to elements in a three-dimensional nested output array.
42+
43+
```javascript
44+
var abs = require( '@stdlib/math/base/special/abs' );
45+
46+
var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ];
47+
var mask = [ [ [ 0, 1 ], [ 0, 0 ] ] ];
48+
49+
var shape = [ 1, 2, 2 ];
50+
51+
// Compute the absolute values in-place:
52+
mskunary3d( [ x, mask, x ], shape, abs );
53+
// x => [ [ [ 1.0, -2.0 ], [ 3.0, 4.0 ] ] ]
54+
```
55+
56+
The function accepts the following arguments:
57+
58+
- **arrays**: array-like object containing one input nested array, an input nested mask array, and one output nested array.
59+
- **shape**: array shape.
60+
- **fcn**: unary function to apply.
61+
62+
</section>
63+
64+
<!-- /.usage -->
65+
66+
<section class="notes">
67+
68+
## Notes
69+
70+
- The function assumes that the input and output arrays have the same shape.
71+
- An element in an input array is "masked" if the corresponding element in the mask array is non-zero.
72+
73+
</section>
74+
75+
<!-- /.notes -->
76+
77+
<section class="examples">
78+
79+
## Examples
80+
81+
<!-- eslint no-undef: "error" -->
82+
83+
```javascript
84+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
85+
var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory;
86+
var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
87+
var zeros3d = require( '@stdlib/array/base/zeros3d' );
88+
var abs = require( '@stdlib/math/base/special/abs' );
89+
var mskunary3d = require( '@stdlib/array/base/mskunary3d' );
90+
91+
var shape = [ 3, 3, 3 ];
92+
93+
var x = filled3dBy( shape, discreteUniform( -100, 100 ) );
94+
console.log( x );
95+
96+
var mask = filled3dBy( shape, bernoulli( 0.5 ) );
97+
console.log( mask );
98+
99+
var y = zeros3d( shape );
100+
console.log( y );
101+
102+
mskunary3d( [ x, mask, y ], shape, abs );
103+
console.log( y );
104+
```
105+
106+
</section>
107+
108+
<!-- /.examples -->
109+
110+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
111+
112+
<section class="related">
113+
114+
</section>
115+
116+
<!-- /.related -->
117+
118+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
119+
120+
<section class="links">
121+
122+
</section>
123+
124+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/mskunary3d/benchmark/benchmark.js

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 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 uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory;
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var floor = require( '@stdlib/math/base/special/floor' );
29+
var identity = require( '@stdlib/math/base/special/identity' );
30+
var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
31+
var zeros3d = require( '@stdlib/array/base/zeros3d' );
32+
var numel = require( '@stdlib/ndarray/base/numel' );
33+
var pkg = require( './../package.json' ).name;
34+
var mskunary3d = require( './../lib' );
35+
36+
37+
// FUNCTIONS //
38+
39+
/**
40+
* Creates a benchmark function.
41+
*
42+
* @private
43+
* @param {PositiveIntegerArray} shape - array shape
44+
* @returns {Function} benchmark function
45+
*/
46+
function createBenchmark( shape ) {
47+
var arrays;
48+
var x;
49+
var m;
50+
var y;
51+
52+
x = filled3dBy( shape, uniform( -100.0, 100.0 ) );
53+
m = filled3dBy( shape, bernoulli( 0.5 ) );
54+
y = zeros3d( shape );
55+
56+
arrays = [ x, m, y ];
57+
58+
return benchmark;
59+
60+
/**
61+
* Benchmark function.
62+
*
63+
* @private
64+
* @param {Benchmark} b - benchmark instance
65+
*/
66+
function benchmark( b ) {
67+
var i0;
68+
var i1;
69+
var i2;
70+
var i;
71+
72+
b.tic();
73+
for ( i = 0; i < b.iterations; i++ ) {
74+
mskunary3d( arrays, shape, identity );
75+
i2 = i % shape[ 0 ];
76+
i1 = i % shape[ 1 ];
77+
i0 = i % shape[ 2 ];
78+
if ( isnan( arrays[ 2 ][ i2 ][ i1 ][ i0 ] ) ) {
79+
b.fail( 'should not return NaN' );
80+
}
81+
}
82+
b.toc();
83+
84+
i2 = i % shape[ 0 ];
85+
i1 = i % shape[ 1 ];
86+
i0 = i % shape[ 2 ];
87+
if ( isnan( arrays[ 2 ][ i2 ][ i1 ][ i0 ] ) ) {
88+
b.fail( 'should not return NaN' );
89+
}
90+
b.pass( 'benchmark finished' );
91+
b.end();
92+
}
93+
}
94+
95+
96+
// MAIN //
97+
98+
/**
99+
* Main execution sequence.
100+
*
101+
* @private
102+
*/
103+
function main() {
104+
var min;
105+
var max;
106+
var sh;
107+
var N;
108+
var f;
109+
var i;
110+
111+
min = 1; // 10^min
112+
max = 6; // 10^max
113+
114+
for ( i = min; i <= max; i++ ) {
115+
N = floor( pow( pow( 10, i ), 1.0/3.0 ) );
116+
sh = [ N, N, N ];
117+
f = createBenchmark( sh );
118+
bench( pkg+'::equidimensional:size='+numel( sh ), f );
119+
}
120+
}
121+
122+
main();

‎lib/node_modules/@stdlib/array/base/mskunary3d/docs/repl.txt

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
{{alias}}( arrays, shape, fcn )
3+
Applies a unary callback to elements in a three-dimensional nested input
4+
array according to elements in a three-dimensional nested mask array and
5+
assigns results to elements in a three-dimensional nested output array.
6+
7+
An element in an input array is "masked" if the corresponding element in the
8+
mask array is non-zero.
9+
10+
Parameters
11+
----------
12+
arrays: ArrayLikeObject
13+
Array-like object containing one input nested array, an input nested
14+
mask array, and one output nested array.
15+
16+
shape: Array<integer>
17+
Array shape.
18+
19+
fcn: Function
20+
Unary callback.
21+
22+
Examples
23+
--------
24+
> var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ];
25+
> var m = [ [ [ 0, 1 ], [ 0, 0 ] ] ];
26+
> var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ];
27+
> var shape = [ 1, 2, 2 ];
28+
> {{alias}}( [ x, m, y ], shape, {{alias:@stdlib/math/base/special/abs}} );
29+
> y
30+
[ [ [ 1.0, 0.0 ], [ 3.0, 4.0 ] ] ]
31+
32+
See Also
33+
--------
34+

‎lib/node_modules/@stdlib/array/base/mskunary3d/docs/types/index.d.ts

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { Array3D } from '@stdlib/types/array';
24+
import { Shape3D } from '@stdlib/types/ndarray';
25+
26+
/**
27+
* Unary callback.
28+
*
29+
* @param value - input value
30+
* @returns result
31+
*/
32+
type Unary<T, U> = ( value: T ) => U;
33+
34+
/**
35+
* Applies a unary callback to elements in a three-dimensional nested input array according to elements in a three-dimensional nested mask array and assigns results to elements in a three-dimensional nested output array.
36+
*
37+
* ## Notes
38+
*
39+
* - The function assumes that the input and output arrays have the same shape.
40+
* - An element in an input array is "masked" if the corresponding element in the mask array is non-zero.
41+
*
42+
* @param arrays - array containing one input nested array, an input nested mask array, and one output nested array
43+
* @param shape - array shape
44+
* @param fcn - unary callback
45+
*
46+
* @example
47+
* var ones3d = require( `@stdlib/array/base/ones3d` );
48+
* var zeros3d = require( `@stdlib/array/base/zeros3d` );
49+
*
50+
* function scale( x ) {
51+
* return x * 10.0;
52+
* }
53+
*
54+
* var shape = [ 1, 2, 2 ];
55+
*
56+
* var x = ones3d( shape );
57+
* var y = zeros3d( shape );
58+
*
59+
* var mask = [ [ [ 0, 1 ], [ 0, 0 ] ] ];
60+
*
61+
* mskunary3d( [ x, mask, y ], shape, scale );
62+
*
63+
* console.log( y );
64+
* // => [ [ [ 10.0, 0.0 ], [ 10.0, 10.0 ] ] ]
65+
*/
66+
declare function mskunary3d<T = unknown, U = unknown>( arrays: [ Array3D<T>, Array3D<number>, Array3D<U> ], shape: Shape3D, fcn: Unary<T, U> ): void;
67+
68+
69+
// EXPORTS //
70+
71+
export = mskunary3d;

0 commit comments

Comments
 (0)