feat: add array/base/mskbinary3d

lib/node_modules/@stdlib/array/base/mskbinary3d/benchmark/benchmark.js

@@ -0,0 +1,124 @@
+/**
+* @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 filled3dBy = require( '@stdlib/array/base/filled3d-by' );
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var pkg = require( './../package.json' ).name;
+var mskbinary3d = 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 = filled3dBy( shape, uniform( -100.0, 100.0 ) );
+	y = filled3dBy( shape, uniform( -100.0, 100.0 ) );
+	m = filled3dBy( shape, bernoulli( 0.5 ) );
+	z = zeros3d( 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 i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			mskbinary3d( arrays, shape, add );
+			i2 = i % shape[ 0 ];
+			i1 = i % shape[ 1 ];
+			i0 = i % shape[ 2 ];
+			if ( isnan( arrays[ 3 ][ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i2 = i % shape[ 0 ];
+		i1 = i % shape[ 1 ];
+		i0 = i % shape[ 2 ];
+		if ( isnan( arrays[ 3 ][ 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/3.0 ) ); // Cube root for 3D arrays
+		sh = [ N, N, N ];
+		f = createBenchmark( sh );
+		bench( pkg+'::cube_matrix:size='+numel( sh ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/mskbinary3d/docs/repl.txt

@@ -0,0 +1,44 @@
+
+{{alias}}( arrays, shape, fcn )
+    Applies a binary callback to elements in two three-dimensional nested input
+    arrays according to elements in a three-dimensional nested mask array and
+    assigns results to elements in a three-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<integer>
+        Array shape.
+
+    fcn: Function
+        Binary callback.
+
+    Examples
+    --------
+    > var x = [ 
+    ...     [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+    ...     [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+    ... ];
+
+    > var y = [ 
+    ...     [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+    ...     [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+    ... ];
+    > var m = [ [ [ 0, 1 ], [ 0, 0 ] ], [ [ 1, 0 ], [ 0, 1 ] ] ];
+    > var z = [ 
+    ...     [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ],
+    ...     [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+    ... ];
+    > var shape = [ 2, 2, 2 ];
+    > {{alias}}( [ x, y, m, z ], shape, {{alias:@stdlib/math/base/ops/add}} );
+    > z
+    [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ], [ [ 0.0, 12.0 ], [ 14.0, 0.0 ] ] ]
+
+    See Also
+    --------

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

@@ -0,0 +1,76 @@
+/**
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { Array3D } from '@stdlib/types/array';
+import { Shape3D } from '@stdlib/types/ndarray';
+
+/**
+* Binary callback.
+*
+* @param v1 - element from first input array
+* @param v2 - element from second input array
+* @returns result
+*/
+type Binary<T, U, V> = ( v1: T, v2: U ) => V;
+
+/**
+* Applies a binary callback to elements in two three-dimensional nested input arrays according to elements in a three-dimensional nested mask array and assigns results to elements in a three-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 ones3d = require( '@stdlib/array/base/ones3d' );
+* var zeros3d = require( '@stdlib/array/base/zeros3d' );
+* var add = require( '@stdlib/math/base/ops/add' );
+*
+* var shape = [ 2, 2, 2 ];
+*
+* var x = ones3d( shape );
+* var y = ones3d( shape );
+* var z = zeros3d( shape );
+*
+* var mask = [
+*     [ [ 0, 1 ], [ 0, 0 ] ],
+*     [ [ 1, 0 ], [ 0, 1 ] ]
+* ];
+*
+* mskbinary3d( [ x, y, mask, z ], shape, add );
+*
+* console.log( z );
+* // => [
+* //      [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ],
+* //      [ [ 0.0, 2.0 ], [ 2.0, 0.0 ] ]
+* //    ]
+*/
+declare function mskbinary3d<T = unknown, U = unknown, V = unknown>( arrays: [ Array3D<T>, Array3D<U>, Array3D<number>, Array3D<V> ], shape: Shape3D, fcn: Binary<T, U, V> ): void;
+
+
+// EXPORTS //
+
+export = mskbinary3d;

lib/node_modules/@stdlib/array/base/mskbinary3d/docs/types/test.ts

@@ -0,0 +1,148 @@
+/**
+* @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 mskbinary3d = 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 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const y = [
+		[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const m = [
+		[ [ 0, 1 ], [ 0, 0 ] ],
+		[ [ 1, 0 ], [ 0, 1 ] ]
+	];
+	const z = [
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ],
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+	];
+
+	mskbinary3d( [ x, y, m, z ], [ 2, 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...
+{
+	mskbinary3d( 'abc', [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( 3.14, [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( true, [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( false, [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( null, [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( [ '1' ], [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( {}, [ 2, 2, 2 ], fcn ); // $ExpectError
+	mskbinary3d( ( x: number ): number => x, [ 2, 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 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const y = [
+		[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const m = [
+		[ [ 0, 1 ], [ 0, 0 ] ],
+		[ [ 1, 0 ], [ 0, 1 ] ]
+	];
+	const z = [
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ],
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+	];
+
+	mskbinary3d( [ x, y, m, z ], 'abc', fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], 3.14, fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], true, fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], false, fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], null, fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ '1' ], fcn ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], {}, fcn ); // $ExpectError
+	mskbinary3d( [ 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 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const y = [
+		[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const m = [
+		[ [ 0, 1 ], [ 0, 0 ] ],
+		[ [ 1, 0 ], [ 0, 1 ] ]
+	];
+	const z = [
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ],
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+	];
+
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], 'abc' ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], 3.14 ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], true ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], false ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], null ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], [ '1' ] ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 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 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const y = [
+		[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ],
+		[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+	];
+	const m = [
+		[ [ 0, 1 ], [ 0, 0 ] ],
+		[ [ 1, 0 ], [ 0, 1 ] ]
+	];
+	const z = [
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ],
+		[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+	];
+
+	mskbinary3d(); // $ExpectError
+	mskbinary3d( [ x, y, m, z ] ); // $ExpectError
+	mskbinary3d( [ x, y, m, z ], [ 2, 2, 2 ], fcn, {} ); // $ExpectError
+}