-
-
Notifications
You must be signed in to change notification settings - Fork 859
feat: add array/base/broadcasted-ternary5d
#3251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
36c333a
feat: add array/base/broadcasted-ternary5d
Vinit-Pandit 9854a28
fix: fix space between parens
Vinit-Pandit 3cda0f3
fix: fix spacing
Vinit-Pandit 8386f92
fix: fix spacing
Vinit-Pandit 74a0717
fix: clean up
Vinit-Pandit 7eea62d
fix: adding decimals
Vinit-Pandit a626398
fix: removing extra line
Vinit-Pandit df06f58
chore: clean-up
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
141 changes: 141 additions & 0 deletions
141
lib/node_modules/@stdlib/array/base/broadcasted-ternary5d/README.md
This file contains hidden or 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. | ||
|
||
--> | ||
|
||
# bternary5d | ||
|
||
> Apply a ternary callback to elements in three [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assign results to elements in a five-dimensional nested output array. | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var bternary5d = require( '@stdlib/array/base/broadcasted-ternary5d' ); | ||
``` | ||
|
||
#### bternary5d( 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 five-dimensional nested output array. | ||
|
||
```javascript | ||
var add = require( '@stdlib/math/base/ops/add3' ); | ||
var zeros5d = require( '@stdlib/array/base/zeros5d' ); | ||
|
||
var x = [ [ [ 1.0, 2.0 ] ] ]; | ||
var y = [ [ [ 3.0 ], [ 4.0 ] ] ]; | ||
var z = [ [ [ [ 4.0, 5.0 ] ], [ [ 4.0, 5.0 ] ] ] ]; | ||
var out = zeros5d( [ 1, 1, 2, 2 ] ); | ||
|
||
var shapes = [ | ||
[ 1, 1, 2 ], | ||
[ 1, 2, 1 ], | ||
[ 1, 2, 1, 2 ], | ||
[ 1, 1, 2, 2, 2 ] | ||
]; | ||
|
||
bternary5d( [ x, y, z, out ], shapes, add ); | ||
// out => [ [ [ [ [ 8, 10 ], [ 9, 11 ] ], [ [ 8, 10 ], [ 9, 11 ] ] ] ] ] | ||
Vinit-Pandit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
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 filled5dBy = require( '@stdlib/array/base/filled5d-by' ); | ||
var zeros5d = require( '@stdlib/array/base/zeros5d' ); | ||
var add = require( '@stdlib/math/base/ops/add3' ); | ||
var bternary5d = require( '@stdlib/array/base/broadcasted-ternary5d' ); | ||
|
||
var shapes = [ | ||
[ 1, 1, 1, 1, 3 ], | ||
[ 1, 1, 3, 1, 1 ], | ||
[ 1, 1, 1, 3, 1 ], | ||
[ 1, 1, 3, 3, 3 ] | ||
]; | ||
|
||
var x = filled5dBy( shapes[ 0 ], discreteUniform( -100, 100 ) ); | ||
console.log( x ); | ||
|
||
var y = filled5dBy( shapes[ 1 ], discreteUniform( -100, 100 ) ); | ||
console.log( y ); | ||
|
||
var z = filled5dBy( shapes[ 2 ], discreteUniform( -100, 100 ) ); | ||
console.log( z ); | ||
|
||
var out = zeros5d( shapes[ 3 ] ); | ||
console.log( out ); | ||
|
||
bternary5d( [ 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/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/broadcast-array | ||
|
||
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
136 changes: 136 additions & 0 deletions
136
lib/node_modules/@stdlib/array/base/broadcasted-ternary5d/benchmark/benchmark.js
This file contains hidden or 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,136 @@ | ||
/** | ||
* @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 filled5dBy = require( '@stdlib/array/base/filled5d-by' ); | ||
var zeros5d = require( '@stdlib/array/base/zeros5d' ); | ||
var numel = require( '@stdlib/ndarray/base/numel' ); | ||
var pkg = require( './../package.json' ).name; | ||
var bternary5d = 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 = [ | ||
[ shape[ 0 ], 1, 1, 1, 1 ], | ||
[ 1, 1, 1, 1, shape[ 1 ] ], | ||
[ 1, 1, shape[ 2 ], 1, 1 ], | ||
shape | ||
]; | ||
x = filled5dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) ); | ||
y = filled5dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) ); | ||
z = filled5dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) ); | ||
w = zeros5d( 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 i3; | ||
var i4; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
bternary5d( arrays, shapes, add ); | ||
i4 = i % shapes[ 1 ][ 0 ]; | ||
i3 = i % shapes[ 1 ][ 1 ]; | ||
i2 = i % shapes[ 1 ][ 2 ]; | ||
i1 = i % shapes[ 1 ][ 3 ]; | ||
i0 = i % shapes[ 1 ][ 4 ]; | ||
if ( isnan( arrays[ 3 ][ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
|
||
i4 = i % shapes[ 1 ][ 0 ]; | ||
i3 = i % shapes[ 1 ][ 1 ]; | ||
i2 = i % shapes[ 1 ][ 2 ]; | ||
i1 = i % shapes[ 1 ][ 3 ]; | ||
i0 = i % shapes[ 1 ][ 4 ]; | ||
if ( isnan(arrays[ 3 ][ i4 ][ 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 / 5.0 ) ); | ||
sh = [ N, N, N, N, N ]; | ||
f = createBenchmark( sh ); | ||
bench( pkg + '::equidimensional:size=' + numel( sh ), f ); | ||
} | ||
} | ||
|
||
main(); |
32 changes: 32 additions & 0 deletions
32
lib/node_modules/@stdlib/array/base/broadcasted-ternary5d/docs/repl.txt
This file contains hidden or 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 five-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, 2.0 ], [ 3.0, 3.0 ] ]; | ||
> var z = [ [ [ [ [ 2.0 ], [ 3.0 ] ] ] ] ]; | ||
> var out = [ [ [ [ [ 0.0 ,0.0 ], [ 0.0 ,0.0 ] ] ] ] ]; | ||
> var shapes = [ [ 1 ], [ 2, 2 ], [ 1, 1, 1, 2, 1 ], [ 1, 1, 1, 2, 2 ] ]; | ||
> {{alias}}( [ x, y, z, out ], shapes, fcn ); | ||
> out | ||
[ [ [ [ [ 5.0, 5.0 ], [ 7.0, 7.0 ] ] ] ] ] | ||
|
||
See Also | ||
-------- | ||
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.