-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
889cecf
commit 8cc18e4
Showing
11 changed files
with
1,167 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| <!-- | ||
| @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. | ||
| --> | ||
|
|
||
| # bternary3d | ||
|
|
||
| > Apply a ternary callback to elements in three [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 bternary3d = require( '@stdlib/array/base/broadcasted-ternary3d' ); | ||
| ``` | ||
|
|
||
| #### bternary3d( arrays, shapes, fcn ) | ||
|
|
||
| Applies a ternary callback to elements in three [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assigns results to elements in a three-dimensional nested output array. | ||
|
|
||
| ```javascript | ||
| var add = require( '@stdlib/math/base/ops/add3' ); | ||
| var zeros3d = require( '@stdlib/array/base/zeros3d' ); | ||
|
|
||
| var x = [ [ [ 1.0 ], [ 2.0 ] ] ]; | ||
| var y = [ [ [ 3.0 ] ], [ [ 4.0 ] ] ]; | ||
| var z = [ [ [ 5.0, 6.0 ] ] ]; | ||
| var out = zeros3d( [ 2, 2, 2 ] ); | ||
|
|
||
| var shapes = [ | ||
| [ 1, 2, 1 ], | ||
| [ 2, 1, 1 ], | ||
| [ 1, 1, 2 ], | ||
| [ 2, 2, 2 ] | ||
| ]; | ||
|
|
||
| bternary3d( [ x, y, z, out ], shapes, add ); | ||
| // out => [ [ [ 9.0, 10.0 ], [ 10.0, 11.0 ] ], [ [ 10.0, 11.0 ], [ 11.0, 12.0 ] ] ] | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **arrays**: array-like object containing three input nested arrays and one output nested array. | ||
| - **shapes**: array shapes. | ||
| - **fcn**: ternary 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/add3' ); | ||
| var bternary3d = require( '@stdlib/array/base/broadcasted-ternary3d' ); | ||
|
|
||
| var shapes = [ | ||
| [ 1, 3, 1 ], | ||
| [ 3, 1, 1 ], | ||
| [ 1, 1, 3 ], | ||
| [ 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 = filled3dBy( shapes[ 2 ], discreteUniform( -100, 100 ) ); | ||
| console.log( z ); | ||
|
|
||
| var out = zeros3d( shapes[ 3 ] ); | ||
| console.log( out ); | ||
|
|
||
| bternary3d( [ x, y, z, out ], shapes, add ); | ||
| console.log( out ); | ||
| ``` | ||
|
|
||
| </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 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /** | ||
| * @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 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/add3' ); | ||
| 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 bternary3d = 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; | ||
| var w; | ||
|
|
||
| shapes = [ | ||
| [ 1, 1, shape[ 2 ] ], | ||
| [ shape[ 0 ], 1, 1 ], | ||
| [ 1, shape[ 1 ], 1 ], | ||
| shape | ||
| ]; | ||
| x = filled3dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) ); | ||
| y = filled3dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) ); | ||
| z = filled3dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) ); | ||
| w = zeros3d( shapes[ 3 ] ); | ||
|
|
||
| arrays = [ x, y, z, w ]; | ||
|
|
||
| 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++ ) { | ||
| bternary3d( arrays, shapes, add ); | ||
| i2 = i % shapes[ 1 ][ 0 ]; | ||
| i1 = i % shapes[ 1 ][ 1 ]; | ||
| i0 = i % shapes[ 1 ][ 2 ]; | ||
| if ( isnan( arrays[ 3 ][ 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[ 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 ) ); | ||
| sh = [ N, N, N ]; | ||
| f = createBenchmark( sh ); | ||
| bench( pkg + '::equidimensional:size=' + numel( sh ), f ); | ||
| } | ||
| } | ||
|
|
||
| main(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
|
|
||
| {{alias}}( arrays, shapes, fcn ) | ||
| Applies a ternary callback to elements in three broadcasted input arrays and | ||
| assigns results to elements in a three-dimensional nested output array. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| arrays: ArrayLikeObject | ||
| Array-like object containing three input nested arrays and one output | ||
| nested array. | ||
|
|
||
| shapes: Array<Array<integer>> | ||
| Array shapes. | ||
|
|
||
| fcn: Function | ||
| Ternary callback. | ||
|
|
||
| Examples | ||
| -------- | ||
| > function fcn( x, y, z ) { return x + y + z }; | ||
| > var x = [ 1.0 ]; | ||
| > var y = [ [ 2.0 ], [ 3.0 ] ]; | ||
| > var z = [ [ [ 4.0 ], [ 6.0 ] ] ]; | ||
| > var out = [ [ [ 0.0 ], [ 0.0 ] ], [ [ 0.0 ], [ 0.0 ] ] ]; | ||
| > var shapes = [ [ 1 ], [ 2, 1 ], [ 1, 2, 1 ], [ 2, 2, 1 ] ]; | ||
| > {{alias}}( [ x, y, z, out ], shapes, fcn ); | ||
| > out | ||
| [ [ [ 7.0 ], [ 10.0 ] ], [ [ 7.0 ], [ 10.0 ] ] ] | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
Oops, something went wrong.