From c120bb088e274ce4245c019388d4d4d25ca4c6c9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 25 Nov 2024 00:42:39 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 15 +- CONTRIBUTORS | 1 + base/mskbinary4d/README.md | 128 ++++++++++ base/mskbinary4d/benchmark/benchmark.js | 127 ++++++++++ base/mskbinary4d/docs/repl.txt | 35 +++ base/mskbinary4d/docs/types/index.d.ts | 70 ++++++ base/mskbinary4d/docs/types/test.ts | 100 ++++++++ base/mskbinary4d/examples/index.js | 43 ++++ base/mskbinary4d/lib/index.js | 53 ++++ base/mskbinary4d/lib/main.js | 118 +++++++++ base/mskbinary4d/package.json | 73 ++++++ base/mskbinary4d/test/test.js | 306 ++++++++++++++++++++++++ 12 files changed, 1063 insertions(+), 6 deletions(-) create mode 100644 base/mskbinary4d/README.md create mode 100644 base/mskbinary4d/benchmark/benchmark.js create mode 100644 base/mskbinary4d/docs/repl.txt create mode 100644 base/mskbinary4d/docs/types/index.d.ts create mode 100644 base/mskbinary4d/docs/types/test.ts create mode 100644 base/mskbinary4d/examples/index.js create mode 100644 base/mskbinary4d/lib/index.js create mode 100644 base/mskbinary4d/lib/main.js create mode 100644 base/mskbinary4d/package.json create mode 100644 base/mskbinary4d/test/test.js diff --git a/CHANGELOG.md b/CHANGELOG.md index d4bc7b56..4cc72ebe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@
-## Unreleased (2024-11-22) +## Unreleased (2024-11-25)
@@ -264,6 +264,7 @@ ##### Features +- [`cb27ec4`](https://github.com/stdlib-js/stdlib/commit/cb27ec42bd7e65c46877e57064d36ff9b38b502b) - add `array/base/mskbinary4d` [(#3196)](https://github.com/stdlib-js/stdlib/pull/3196) - [`c328fc5`](https://github.com/stdlib-js/stdlib/commit/c328fc515fc925ee717ed9cd844cca83a61da806) - add `array/base/mskbinary3d` [(#3193)](https://github.com/stdlib-js/stdlib/pull/3193)
@@ -274,9 +275,9 @@ ##### Closed Issues -This release closes the following issue: +A total of 2 issues were closed in this release: -[#3178](https://github.com/stdlib-js/stdlib/issues/3178) +[#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179)
@@ -410,9 +411,9 @@ A total of 2 issues were closed in this release: ### Closed Issues -A total of 3 issues were closed in this release: +A total of 4 issues were closed in this release: -[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3178](https://github.com/stdlib-js/stdlib/issues/3178) +[#3135](https://github.com/stdlib-js/stdlib/issues/3135), [#3138](https://github.com/stdlib-js/stdlib/issues/3138), [#3178](https://github.com/stdlib-js/stdlib/issues/3178), [#3179](https://github.com/stdlib-js/stdlib/issues/3179) @@ -422,9 +423,10 @@ A total of 3 issues were closed in this release: ### Contributors -A total of 4 people contributed to this release. Thank you to the following contributors: +A total of 5 people contributed to this release. Thank you to the following contributors: - Aayush Khanna +- Abhijit - Athan Reines - Philipp Burckhardt - Rylan Yang @@ -439,6 +441,7 @@ A total of 4 people contributed to this release. Thank you to the following cont
+- [`cb27ec4`](https://github.com/stdlib-js/stdlib/commit/cb27ec42bd7e65c46877e57064d36ff9b38b502b) - **feat:** add `array/base/mskbinary4d` [(#3196)](https://github.com/stdlib-js/stdlib/pull/3196) _(by Abhijit, Athan Reines)_ - [`e3a2173`](https://github.com/stdlib-js/stdlib/commit/e3a2173a24bd8634f333cace626fc2d71740ebd3) - **feat:** add `every` method to `array/fixed-endian-factory` [(#3200)](https://github.com/stdlib-js/stdlib/pull/3200) _(by Aayush Khanna, Athan Reines)_ - [`c328fc5`](https://github.com/stdlib-js/stdlib/commit/c328fc515fc925ee717ed9cd844cca83a61da806) - **feat:** add `array/base/mskbinary3d` [(#3193)](https://github.com/stdlib-js/stdlib/pull/3193) _(by Rylan Yang, Athan Reines, stdlib-bot)_ - [`9ba0dbd`](https://github.com/stdlib-js/stdlib/commit/9ba0dbd839707695a05fda5d4f50d67c5aba52f7) - **chore:** use relative paths to load main package export _(by Philipp Burckhardt)_ diff --git a/CONTRIBUTORS b/CONTRIBUTORS index f09b30e6..50a3cade 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -83,6 +83,7 @@ Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com> Rutam <138517416+performant23@users.noreply.github.com> Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com> Ryan Seal +Rylan Yang <137365285+rylany27@users.noreply.github.com> Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com> SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com> Saurabh Singh diff --git a/base/mskbinary4d/README.md b/base/mskbinary4d/README.md new file mode 100644 index 00000000..39325582 --- /dev/null +++ b/base/mskbinary4d/README.md @@ -0,0 +1,128 @@ + + +# mskbinary4d + +> Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array. + +
+ +
+ + + +
+ +## Usage + +```javascript +var mskbinary4d = require( '@stdlib/array/base/mskbinary4d' ); +``` + +#### mskbinary4d( arrays, shape, fcn ) + +Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array. + +```javascript +var add = require( '@stdlib/math/base/ops/add' ); +var zeros4d = require( '@stdlib/array/base/zeros4d' ); + +var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; +var z = zeros4d( [ 1, 1, 2, 2 ] ); + +var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + +var shape = [ 1, 1, 2, 2 ]; + +mskbinary4d( [ x, x, mask, z ], shape, add ); +// z => [ [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ] ] ] +``` + +The function accepts the following arguments: + +- **arrays**: array-like object containing two input nested arrays, an input nested mask array, and one output nested array. +- **shape**: array shape. +- **fcn**: binary function to apply. + +
+ + + +
+ +## Notes + +- The function assumes that the input and output arrays have the same shape. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory; +var filled4dBy = require( '@stdlib/array/base/filled4d-by' ); +var zeros4d = require( '@stdlib/array/base/zeros4d' ); +var add = require( '@stdlib/math/base/ops/add' ); +var mskbinary4d = require( '@stdlib/array/base/mskbinary4d' ); + +var shape = [ 2, 1, 3, 3 ]; + +var x = filled4dBy( shape, discreteUniform( -100, 100 ) ); +console.log( x ); + +var y = filled4dBy( shape, discreteUniform( -100, 100 ) ); +console.log( y ); + +var mask = filled4dBy( shape, bernoulli( 0.5 ) ); +console.log( mask ); + +var z = zeros4d( shape ); +console.log( z ); + +mskbinary4d( [ x, y, mask, z ], shape, add ); +console.log( z ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/base/mskbinary4d/benchmark/benchmark.js b/base/mskbinary4d/benchmark/benchmark.js new file mode 100644 index 00000000..bfecf0f1 --- /dev/null +++ b/base/mskbinary4d/benchmark/benchmark.js @@ -0,0 +1,127 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ).factory; +var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory; +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var floor = require( '@stdlib/math/base/special/floor' ); +var add = require( '@stdlib/math/base/ops/add' ); +var filled4dBy = require( './../../../base/filled4d-by' ); +var zeros4d = require( './../../../base/zeros4d' ); +var numel = require( '@stdlib/ndarray/base/numel' ); +var pkg = require( './../package.json' ).name; +var mskbinary4d = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveIntegerArray} shape - array shape +* @returns {Function} benchmark function +*/ +function createBenchmark( shape ) { + var arrays; + var x; + var y; + var z; + var m; + + x = filled4dBy( shape, uniform( -100.0, 100.0 ) ); + y = filled4dBy( shape, uniform( -100.0, 100.0 ) ); + m = filled4dBy( shape, bernoulli( 0.5 ) ); + z = zeros4d( shape ); + + arrays = [ x, y, m, z ]; + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i0; + var i1; + var i2; + var i3; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mskbinary4d( arrays, shape, add ); + i3 = i % shape[ 0 ]; + i2 = i % shape[ 1 ]; + i1 = i % shape[ 2 ]; + i0 = i % shape[ 3 ]; + if ( isnan( arrays[ 3 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + + i3 = i % shape[ 0 ]; + i2 = i % shape[ 1 ]; + i1 = i % shape[ 2 ]; + i0 = i % shape[ 3 ]; + if ( isnan( arrays[ 3 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var min; + var max; + var sh; + var N; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + N = floor( pow( pow( 10, i ), 1.0/4.0 ) ); + sh = [ N, N, N, N ]; + f = createBenchmark( sh ); + bench( pkg+'::equidimensional:size='+numel( sh ), f ); + } +} + +main(); diff --git a/base/mskbinary4d/docs/repl.txt b/base/mskbinary4d/docs/repl.txt new file mode 100644 index 00000000..9e7eb78f --- /dev/null +++ b/base/mskbinary4d/docs/repl.txt @@ -0,0 +1,35 @@ + +{{alias}}( arrays, shape, fcn ) + Applies a binary callback to elements in two four-dimensional nested input + arrays according to elements in a four-dimensional nested mask array and + assigns results to elements in a four-dimensional nested output array. + + An element in an input array is "masked" if the corresponding element in the + mask array is non-zero. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing two input nested arrays, an input nested + mask array, and one output nested array. + + shape: Array + Array shape. + + fcn: Function + Binary callback. + + Examples + -------- + > var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + > var y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + > var m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + > var z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; + > var shape = [ 1, 1, 2, 2 ]; + > {{alias}}( [ x, y, m, z ], shape, {{alias:@stdlib/math/base/ops/add}} ); + > z + [ [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ] ] ] + + See Also + -------- + diff --git a/base/mskbinary4d/docs/types/index.d.ts b/base/mskbinary4d/docs/types/index.d.ts new file mode 100644 index 00000000..6b39ad77 --- /dev/null +++ b/base/mskbinary4d/docs/types/index.d.ts @@ -0,0 +1,70 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Array4D } from '@stdlib/types/array'; +import { Shape4D } from '@stdlib/types/ndarray'; + +/** +* Binary callback. +* +* @param v1 - element from first input array +* @param v2 - element from second input array +* @returns result +*/ +type Binary = ( v1: T, v2: U ) => V; + +/** +* Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array. +* +* ## Notes +* +* - The function assumes that the input and output arrays have the same shape. +* - An element in an input array is "masked" if the corresponding element in the mask array is non-zero. +* +* @param arrays - array containing two input nested arrays, an input nested mask array, and one output nested array +* @param shape - array shape +* @param fcn - binary callback +* +* @example +* var ones4d = require( '@stdlib/array/base/ones4d' ); +* var zeros4d = require( '@stdlib/array/base/zeros4d' ); +* var add = require( '@stdlib/math/base/ops/add' ); +* +* var shape = [ 1, 1, 2, 2 ]; +* +* var x = ones4d( shape ); +* var y = ones4d( shape ); +* var z = zeros4d( shape ); +* +* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; +* +* mskbinary2d( [ x, y, mask, z ], shape, add ); +* +* console.log( z ); +* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ] +*/ +declare function mskbinary4d( arrays: [ Array4D, Array4D, Array4D, Array4D ], shape: Shape4D, fcn: Binary ): void; + + +// EXPORTS // + +export = mskbinary4d; diff --git a/base/mskbinary4d/docs/types/test.ts b/base/mskbinary4d/docs/types/test.ts new file mode 100644 index 00000000..7917dc6e --- /dev/null +++ b/base/mskbinary4d/docs/types/test.ts @@ -0,0 +1,100 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +import mskbinary4d = require( './index' ); + +/** +* Binary function. +* +* @param x - input value +* @param y - input value +* @returns result +*/ +function fcn( x: number, y: number ): number { + return x + y; +} + + +// TESTS // + +// The function returns undefined... +{ + const x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + const z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; + + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], fcn ); // $ExpectType void +} + +// The compiler throws an error if the function is provided a first argument which is not an array of nested arrays... +{ + mskbinary4d( 'abc', [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( 3.14, [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( true, [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( false, [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( null, [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( [ '1' ], [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( {}, [ 1, 1, 2, 2 ], fcn ); // $ExpectError + mskbinary4d( ( x: number ): number => x, [ 1, 1, 2, 2 ], fcn ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not an array of numbers... +{ + const x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + const z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; + + mskbinary4d( [ x, y, m, z ], 'abc', fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], 3.14, fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], true, fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], false, fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], null, fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ '1' ], fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], {}, fcn ); // $ExpectError + mskbinary4d( [ x, y, m, z ], ( x: number ): number => x, fcn ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a valid callback... +{ + const x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + const z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; + + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], 'abc' ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], 3.14 ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], true ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], false ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], null ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], [ '1' ] ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], {} ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ]; + const m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; + const z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; + + mskbinary4d(); // $ExpectError + mskbinary4d( [ x, y, m, z ] ); // $ExpectError + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 2 ], fcn, {} ); // $ExpectError +} diff --git a/base/mskbinary4d/examples/index.js b/base/mskbinary4d/examples/index.js new file mode 100644 index 00000000..94098646 --- /dev/null +++ b/base/mskbinary4d/examples/index.js @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory; +var filled4dBy = require( './../../../base/filled4d-by' ); +var zeros4d = require( './../../../base/zeros4d' ); +var add = require( '@stdlib/math/base/ops/add' ); +var mskbinary4d = require( './../lib' ); + +var shape = [ 2, 1, 3, 3 ]; + +var x = filled4dBy( shape, discreteUniform( -100, 100 ) ); +console.log( x ); + +var y = filled4dBy( shape, discreteUniform( -100, 100 ) ); +console.log( y ); + +var mask = filled4dBy( shape, bernoulli( 0.5 ) ); +console.log( mask ); + +var z = zeros4d( shape ); +console.log( z ); + +mskbinary4d( [ x, y, mask, z ], shape, add ); +console.log( z ); diff --git a/base/mskbinary4d/lib/index.js b/base/mskbinary4d/lib/index.js new file mode 100644 index 00000000..48ea7b22 --- /dev/null +++ b/base/mskbinary4d/lib/index.js @@ -0,0 +1,53 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +/** +* Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array. +* +* @module @stdlib/array/base/mskbinary4d +* +* @example +* var ones4d = require( '@stdlib/array/base/ones4d' ); +* var zeros4d = require( '@stdlib/array/base/zeros4d' ); +* var add = require( '@stdlib/math/base/ops/add' ); +* var mskbinary4d = require( '@stdlib/array/base/mskbinary4d' ); +* +* var shape = [ 1, 1, 2, 2 ]; +* +* var x = ones4d( shape ); +* var y = ones4d( shape ); +* var z = zeros4d( shape ); +* +* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; +* +* mskbinary4d( [ x, y, mask, z ], shape, add ); +* +* console.log( z ); +* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/base/mskbinary4d/lib/main.js b/base/mskbinary4d/lib/main.js new file mode 100644 index 00000000..16900ca2 --- /dev/null +++ b/base/mskbinary4d/lib/main.js @@ -0,0 +1,118 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +// MAIN // + +/** +* Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array. +* +* ## Notes +* +* - The function assumes that the input and output arrays have the same shape. +* +* @param {ArrayLikeObject>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array +* @param {NonNegativeIntegerArray} shape - array shape +* @param {Callback} fcn - unary callback +* @returns {void} +* +* @example +* var ones4d = require( '@stdlib/array/base/ones4d' ); +* var zeros4d = require( '@stdlib/array/base/zeros4d' ); +* var add = require( '@stdlib/math/base/ops/add' ); +* +* var shape = [ 1, 1, 2, 2 ]; +* +* var x = ones4d( shape ); +* var y = ones4d( shape ); +* var z = zeros4d( shape ); +* +* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ]; +* +* mskbinary4d( [ x, y, mask, z ], shape, add ); +* +* console.log( z ); +* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ] +*/ +function mskbinary4d( arrays, shape, fcn ) { + var S0; + var S1; + var S2; + var S3; + var i0; + var i1; + var i2; + var i3; + var x0; + var x1; + var x2; + var y0; + var y1; + var y2; + var z0; + var z1; + var z2; + var m0; + var m1; + var m2; + var x; + var y; + var z; + var m; + + S0 = shape[ 3 ]; + S1 = shape[ 2 ]; + S2 = shape[ 1 ]; + S3 = shape[ 0 ]; + if ( S0 <= 0 || S1 <= 0 || S2 <= 0 || S3 <= 0 ) { + return; + } + x = arrays[ 0 ]; + y = arrays[ 1 ]; + m = arrays[ 2 ]; + z = arrays[ 3 ]; + for ( i3 = 0; i3 < S3; i3++ ) { + x2 = x[ i3 ]; + y2 = y[ i3 ]; + z2 = z[ i3 ]; + m2 = m[ i3 ]; + for ( i2 = 0; i2 < S2; i2++ ) { + x1 = x2[ i2 ]; + y1 = y2[ i2 ]; + z1 = z2[ i2 ]; + m1 = m2[ i2 ]; + for ( i1 = 0; i1 < S1; i1++ ) { + x0 = x1[ i1 ]; + y0 = y1[ i1 ]; + z0 = z1[ i1 ]; + m0 = m1[ i1 ]; + for ( i0 = 0; i0 < S0; i0++ ) { + if ( m0[ i0 ] === 0 ) { + z0[ i0 ] = fcn( x0[ i0 ], y0[ i0 ] ); + } + } + } + } + } +} + + +// EXPORTS // + +module.exports = mskbinary4d; diff --git a/base/mskbinary4d/package.json b/base/mskbinary4d/package.json new file mode 100644 index 00000000..6bd215c2 --- /dev/null +++ b/base/mskbinary4d/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/array/base/mskbinary4d", + "version": "0.0.0", + "description": "Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "base", + "array", + "multidimensional", + "ndarray", + "matrix", + "4d", + "binary", + "apply", + "foreach", + "map", + "transform", + "masked", + "mask", + "skip", + "skipped", + "missing", + "missing values", + "na" + ], + "__stdlib__": {} +} diff --git a/base/mskbinary4d/test/test.js b/base/mskbinary4d/test/test.js new file mode 100644 index 00000000..4da71c5e --- /dev/null +++ b/base/mskbinary4d/test/test.js @@ -0,0 +1,306 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 tape = require( 'tape' ); +var add = require( '@stdlib/math/base/ops/add' ); +var zeros4d = require( './../../../base/zeros4d' ); +var mskbinary4d = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof mskbinary4d, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function applies a provided callback to nested input arrays and assigns results to a nested output array', function test( t ) { + var expected; + var shape; + var x; + var y; + var z; + var m; + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 0, 1 ], + [ 0, 0 ] + ] + ] + ]; + + expected = [ + [ + [ + [ 6.0, 0.0 ], + [ 10.0, 12.0 ] + ] + ] + ]; + mskbinary4d( [ x, y, m, z ], shape, add ); + + t.deepEqual( z, expected, 'returns expected value' ); + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 1, 0 ], + [ 1, 0 ] + ] + ] + ]; + + expected = [ + [ + [ + [ 0.0, 8.0 ], + [ 0.0, 12.0 ] + ] + ] + ]; + mskbinary4d( [ x, y, m, z ], shape, add ); + + t.deepEqual( z, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { + var expected; + var shape; + var x; + var y; + var z; + var m; + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 0, 1 ], + [ 0, 0 ] + ] + ] + ]; + + expected = zeros4d( shape ); + mskbinary4d( [ x, y, m, z ], [ 0, 1, 2, 2 ], clbk ); + + t.deepEqual( z, expected, 'returns expected value' ); + t.end(); + + function clbk() { + t.ok( false, 'should not invoke callback' ); + } +}); + +tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { + var expected; + var shape; + var x; + var y; + var z; + var m; + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 0, 1 ], + [ 0, 0 ] + ] + ] + ]; + + expected = zeros4d( shape ); + mskbinary4d( [ x, y, m, z ], [ 1, 0, 2, 2 ], clbk ); + + t.deepEqual( z, expected, 'returns expected value' ); + t.end(); + + function clbk() { + t.ok( false, 'should not invoke callback' ); + } +}); +tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { + var expected; + var shape; + var x; + var y; + var z; + var m; + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 0, 1 ], + [ 0, 0 ] + ] + ] + ]; + + expected = zeros4d( shape ); + mskbinary4d( [ x, y, m, z ], [ 1, 1, 0, 2 ], clbk ); + + t.deepEqual( z, expected, 'returns expected value' ); + t.end(); + + function clbk() { + t.ok( false, 'should not invoke callback' ); + } +}); + +tape( 'the function does not invoke a provided callback if provided a shape having a fourth element equal to zero', function test( t ) { + var expected; + var shape; + var x; + var y; + var z; + var m; + + shape = [ 1, 1, 2, 2 ]; + x = [ + [ + [ + [ 1.0, 2.0 ], + [ 3.0, 4.0 ] + ] + ] + ]; + y = [ + [ + [ + [ 5.0, 6.0 ], + [ 7.0, 8.0 ] + ] + ] + ]; + z = zeros4d( shape ); + m = [ + [ + [ + [ 0, 1 ], + [ 0, 0 ] + ] + ] + ]; + + expected = zeros4d( shape ); + mskbinary4d( [ x, y, m, z ], [ 1, 1, 2, 0 ], clbk ); + + t.deepEqual( z, expected, 'returns expected value' ); + t.end(); + + function clbk() { + t.ok( false, 'should not invoke callback' ); + } +});