Auto-generated commit

base/broadcasted-binary3d/README.md

@@ -0,0 +1,135 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# bbinary3d
+
+> Apply a binary callback to elements in [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assign results to elements in a three-dimensional nested output array.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var bbinary3d = require( '@stdlib/array/base/broadcasted-binary3d' );
+```
+
+#### bbinary3d( arrays, shapes, fcn )
+
+Applies a binary callback to elements in [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assigns results to elements in a three-dimensional nested output array.
+
+```javascript
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+var add = require( '@stdlib/math/base/ops/add' );
+
+var x = [ [ 1.0, 2.0 ] ];
+var y = [ [ 3.0 ], [ 4.0 ] ];
+var z = zeros3d( [ 2, 2, 2 ] );
+
+var shapes = [
+    [ 1, 2 ],
+    [ 2, 1 ],
+    [ 2, 2, 2 ]
+];
+
+bbinary3d( [ x, y, z ], shapes, add );
+// z => [ [ [ 4.0, 5.0 ], [ 5.0, 6.0 ] ], [ [ 4.0, 5.0 ], [ 5.0, 6.0 ] ] ]
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing two input nested arrays and one output nested array.
+-   **shapes**: array shapes.
+-   **fcn**: binary function to apply.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The input and output array shapes must be broadcast [compatible][@stdlib/ndarray/base/broadcast-shapes].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
+var zeros3d = require( '@stdlib/array/base/zeros3d' );
+var add = require( '@stdlib/math/base/ops/add' );
+var bbinary3d = require( '@stdlib/array/base/broadcasted-binary3d' );
+
+var shapes = [
+    [ 1, 1, 3 ],
+    [ 3, 1, 1 ],
+    [ 3, 3, 3 ]
+];
+
+var x = filled3dBy( shapes[ 0 ], discreteUniform( -100, 100 ) );
+console.log( x );
+
+var y = filled3dBy( shapes[ 1 ], discreteUniform( -100, 100 ) );
+console.log( y );
+
+var z = zeros3d( shapes[ 2 ] );
+console.log( z );
+
+bbinary3d( [ x, y, z ], shapes, add );
+console.log( z );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/array/base/broadcast-array]: https://github.com/stdlib-js/array/tree/main/base/broadcast-array
+
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes
+
+</section>
+
+<!-- /.links -->

base/broadcasted-binary3d/benchmark/benchmark.js

@@ -0,0 +1,127 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 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( './../../../base/filled3d-by' );
+var zeros3d = require( './../../../base/zeros3d' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var pkg = require( './../package.json' ).name;
+var bbinary3d = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveIntegerArray} shape - output array shape
+* @returns {Function} benchmark function
+*/
+function createBenchmark( shape ) {
+	var arrays;
+	var shapes;
+	var x;
+	var y;
+	var z;
+
+	shapes = [
+		[ 1, 1, shape[ 2 ] ],
+		[ shape[ 0 ], 1, 1 ],
+		shape
+	];
+	x = filled3dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) );
+	y = filled3dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) );
+	z = zeros3d( shapes[ 2 ] );
+
+	arrays = [ x, y, 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++ ) {
+			bbinary3d( arrays, shapes, add );
+			i2 = i % shapes[ 1 ][ 0 ];
+			i1 = i % shapes[ 1 ][ 1 ];
+			i0 = i % shapes[ 1 ][ 2 ];
+			if ( isnan( arrays[ 2 ][ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i2 = i % shapes[ 1 ][ 0 ];
+		i1 = i % shapes[ 1 ][ 1 ];
+		i0 = i % shapes[ 1 ][ 2 ];
+		if ( isnan( arrays[ 2 ][ 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 ) );
+		sh = [ N, N, N ];
+		f = createBenchmark( sh );
+		bench( pkg+'::equidimensional:size='+numel( sh ), f );
+	}
+}
+
+main();

base/broadcasted-binary3d/docs/repl.txt

@@ -0,0 +1,30 @@
+
+{{alias}}( arrays, shapes, fcn )
+    Applies a binary callback to elements in broadcasted input arrays and
+    assigns results to elements in a three-dimensional nested output array.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject
+        Array-like object containing two input nested arrays and one output
+        nested array.
+
+    shapes: Array<Array<integer>>
+        Array shapes.
+
+    fcn: Function
+        Binary callback.
+
+    Examples
+    --------
+    > var x = [ 1.0, 2.0 ];
+    > var y = [ [ 3.0 ], [ 4.0 ] ];
+    > var z = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ];
+    > var shapes = [ [ 2 ], [ 2, 1 ], [ 1, 2, 2 ] ];
+    > {{alias}}( [ x, y, z ], shapes, {{alias:@stdlib/math/base/ops/add}} );
+    > z
+    [ [ [ 4.0, 5.0 ], [ 5.0, 6.0 ] ] ]
+
+    See Also
+    --------
+

base/broadcasted-binary3d/docs/types/index.d.ts

@@ -0,0 +1,90 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 { Array1D, Array2D, Array3D } from '@stdlib/types/array';
+import { Shape1D, Shape2D, Shape3D } from '@stdlib/types/ndarray';
+
+/**
+* Binary callback.
+*
+* @param value - input value
+* @returns result
+*/
+type Binary<T, U, V> = ( v1: T, v2: U ) => V;
+
+/**
+* Input array.
+*/
+type InputArray<T> = Array1D<T> | Array2D<T> | Array3D<T>;
+
+/**
+* Input array shape.
+*/
+type InputArrayShape = Shape1D | Shape2D | Shape3D;
+
+/**
+* Output array.
+*/
+type OutputArray<T> = Array3D<T>;
+
+/**
+* Output array shape.
+*/
+type OutputArrayShape = Shape3D;
+
+/**
+* Applies a binary callback to elements in broadcasted input arrays and assigns results to elements in a three-dimensional nested output array.
+*
+* ## Notes
+*
+* -   The input array shapes must be broadcast compatible with the output array shape.
+*
+* @param arrays - array containing two input nested arrays and one output nested array
+* @param shapes - array shapes
+* @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 shapes = [
+*     [ 1, 1, 2 ],
+*     [ 2, 1, 1 ],
+*     [ 2, 2, 2 ]
+* ];
+*
+* var x = ones3d( shapes[ 0 ] );
+* var y = ones3d( shapes[ 1 ] );
+* var z = zeros3d( shapes[ 2 ] );
+*
+* bbinary3d( [ x, y, z ], shapes, add );
+*
+* console.log( z );
+* // => [ [ [ 2.0, 2.0 ], [ 2.0, 2.0 ] ],  [ [ 2.0, 2.0 ], [ 2.0, 2.0 ] ] ]
+*/
+declare function bbinary3d<T = unknown, U = unknown, V = unknown>( arrays: [ InputArray<T>, InputArray<U>, OutputArray<V> ], shapes: [ InputArrayShape, InputArrayShape, OutputArrayShape ], fcn: Binary<T, U, V> ): void;
+
+
+// EXPORTS //
+
+export = bbinary3d;