-
-
Notifications
You must be signed in to change notification settings - Fork 907
feat: add array/base/broadcasted-quinary4d
#3267
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
kgryte
merged 15 commits into
stdlib-js:develop
from
Neerajpathak07:broadcasted-quinary4d
Dec 13, 2024
Merged
Changes from 7 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
155335a
feat: add implementation for array/base/broadcasted-quinary4d
Neerajpathak07 3e1318e
fix: changing shape
Neerajpathak07 b3f8aef
fix: examples
Neerajpathak07 c88ebcb
fix: lib
Neerajpathak07 125a91d
fix: lib lint errors
Neerajpathak07 e9042aa
fix: test lint errors
Neerajpathak07 c0a893b
fix: benchmark lint errors
Neerajpathak07 ab60e8a
fix: markdown error
Neerajpathak07 e59478e
fix: lint errors
Neerajpathak07 6a193d7
fix: package.json lint errors
Neerajpathak07 b07e625
fix: repl lint errors
Neerajpathak07 fed120e
fix: CI errors
Neerajpathak07 234b710
fix: CI errors
Neerajpathak07 4dd8815
Merge remote-tracking branch 'upstream/develop' into broadcasted-quin…
stdlib-bot f4bae86
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
159 changes: 159 additions & 0 deletions
159
lib/node_modules/@stdlib/array/base/broadcasted-quinary4d/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,159 @@ | ||
<!-- | ||
|
||
@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. | ||
|
||
--> | ||
|
||
# bquinary4d | ||
|
||
> Apply a quinary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assign results to elements in a four-dimensional nested output array. | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var bquinary4d = require( '@stdlib/array/base/broadcasted-quinary4d' ); | ||
``` | ||
|
||
#### bquinary4d( arrays, shapes, fcn ) | ||
|
||
Applies a quinary callback to elements in four [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assigns results to elements in a four-dimensional nested output array. | ||
|
||
```javascript | ||
var zeros4d = require( '@stdlib/array/base/zeros4d' ); | ||
|
||
function add( x, y, z, w, v ) { | ||
return x + y + z + w + v; | ||
} | ||
|
||
var x = [ [ [ [ 1.0, 2.0 ] ] ] ]; | ||
var y = [ [ [ [ 3.0 ], [ 4.0 ] ] ] ]; | ||
var z = [ [ [ [ 5.0 ] ] ] ]; | ||
var w = [ [ [ [ 2.0 ] ] ] ]; | ||
var v = [ [ [ [ 1.0 ] ] ] ]; | ||
var out = zeros4d( [ 2, 2 ] ); | ||
|
||
var shapes = [ | ||
[ 1, 1, 1, 2 ], | ||
[ 1, 1, 2, 1 ], | ||
[ 1, 1, 2, 2 ], | ||
[ 1, 2, 1, 1 ], | ||
[ 2, 2, 2, 2 ], | ||
Neerajpathak07 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
[ 2, 2, 2, 2 ] | ||
]; | ||
|
||
bquinary4d( [ x, y, z, w, v, out ], shapes, add ); | ||
// out => [ [ [ [ 12.0, 13.0 ], [ 13.0, 14.0 ] ] ] ] | ||
``` | ||
|
||
The function accepts the following arguments: | ||
|
||
- **arrays**: array-like object containing five input nested arrays and one output nested array. | ||
- **shapes**: array shapes. | ||
- **fcn**: quinary 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 filled4dBy = require( '@stdlib/array/base/filled4d-by' ); | ||
var zeros4d = require( '@stdlib/array/base/zeros4d' ); | ||
var bquinary4d = require( '@stdlib/array/base/broadcasted-quinary4d' ); | ||
|
||
function add( x, y, z, w, v ) { | ||
return x + y + z + w + v; | ||
} | ||
|
||
var shapes = [ | ||
[ 1, 1, 1, 3 ], | ||
[ 1, 1, 3, 1 ], | ||
[ 1, 1, 3, 3 ], | ||
[ 1, 3, 1, 1 ], | ||
[ 3, 3, 3, 3 ], | ||
[ 3, 3, 3, 3 ] | ||
]; | ||
|
||
var x = filled4dBy( shapes[ 0 ], discreteUniform( -100, 100 ) ); | ||
console.log( x ); | ||
|
||
var y = filled4dBy( shapes[ 1 ], discreteUniform( -100, 100 ) ); | ||
console.log( y ); | ||
|
||
var z = filled4dBy( shapes[ 2 ], discreteUniform( -100, 100 ) ); | ||
console.log( z ); | ||
|
||
var w = filled4dBy( shapes[ 3 ], discreteUniform( -100, 100 ) ); | ||
console.log( w ); | ||
|
||
var v = filled4dBy( shapes[ 4 ], discreteUniform( -100, 100 ) ); | ||
console.log( v ); | ||
|
||
var out = zeros4d( shapes[ 5 ] ); | ||
console.log( out ); | ||
|
||
bquinary4d( [ x, y, z, w, v, 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 --> |
153 changes: 153 additions & 0 deletions
153
lib/node_modules/@stdlib/array/base/broadcasted-quinary4d/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,153 @@ | ||
/** | ||
* @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 filled4dBy = require( '@stdlib/array/base/filled4d-by' ); | ||
var zeros4d = require( '@stdlib/array/base/zeros4d' ); | ||
var numel = require( '@stdlib/ndarray/base/numel' ); | ||
var pkg = require( './../package.json' ).name; | ||
var bquinary4d = require( './../lib' ); | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Returns the sum. | ||
* | ||
* @private | ||
* @param {number} x - first value | ||
* @param {number} y - second value | ||
* @param {number} z - third value | ||
* @param {number} w - fourth value | ||
* @param {number} v - fifth value | ||
* @returns {number} sum | ||
*/ | ||
function add( x, y, z, w, v ) { | ||
return x + y + z + w + v; | ||
} | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {PositiveIntegerArray} shape - output array shape | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( shape ) { | ||
var arrays; | ||
var shapes; | ||
var out; | ||
var x; | ||
var y; | ||
var z; | ||
var w; | ||
var v; | ||
|
||
shapes = [ | ||
[ 1, 1, 1, shape[ 0 ] ], | ||
[ 1, 1, shape[ 1 ], 1 ], | ||
[ 1, 1, shape[ 2 ], shape[ 3 ] ], | ||
[ 1, shape[ 3 ], 1, 1 ], | ||
[ shape[ 0 ], shape[ 1 ], shape[ 2 ], shape[ 3 ] ], | ||
shape | ||
]; | ||
x = filled4dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) ); | ||
y = filled4dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) ); | ||
z = filled4dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) ); | ||
w = filled4dBy( shapes[ 3 ], uniform( -100.0, 100.0 ) ); | ||
v = filled4dBy( shapes[ 4 ], uniform( -100.0, 100.0 ) ); | ||
out = zeros4d( shapes[ 5 ] ); | ||
|
||
arrays = [ x, y, z, w, v, out ]; | ||
|
||
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++ ) { | ||
bquinary4d( arrays, shapes, add ); | ||
i3 = i % shapes[ 1 ][ 0 ]; | ||
i2 = i % shapes[ 1 ][ 1 ]; | ||
i1 = i % shapes[ 1 ][ 2 ]; | ||
i0 = i % shapes[ 1 ][ 3 ]; | ||
if ( isnan( arrays[ 5 ][ i0 ][ i1 ][ i2 ][ i3 ] ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
|
||
i3 = i % shapes[ 1 ][ 0 ]; | ||
i2 = i % shapes[ 1 ][ 1 ]; | ||
i1 = i % shapes[ 1 ][ 2 ]; | ||
i0 = i % shapes[ 1 ][ 3 ]; | ||
if ( isnan( arrays[ 5 ][ i0 ][ i1 ][ i2 ][ i3 ] ) ) { | ||
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+'::square_matrix:size='+numel( sh ), f ); | ||
} | ||
} | ||
|
||
main(); |
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/array/base/broadcasted-quinary4d/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,33 @@ | ||
|
||
{{alias}}( arrays, shapes, fcn ) | ||
Applies a quinary callback to elements in four broadcasted input arrays | ||
and assigns results to elements in a four-dimensional nested output array. | ||
|
||
Parameters | ||
---------- | ||
arrays: ArrayLikeObject | ||
Array-like object containing five input nested arrays and one output | ||
nested array. | ||
|
||
shapes: Array<Array<integer>> | ||
Array shapes. | ||
|
||
fcn: Function | ||
Quinary callback. | ||
|
||
Examples | ||
-------- | ||
> function fcn( x, y, z, w, v ) { return x + y + z + w + v; }; | ||
> var x = [ 1.0, 2.0 ]; | ||
> var y = [ [ [ [ 3.0 ], [ 4.0 ] ] ] ]; | ||
> var z = [ [ [ [ 1.0 ] ] ] ]; | ||
> var w = [ 2.0 ]; | ||
> var v = [ 1.0 ]; | ||
> var out = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ]; | ||
> var shapes = [ [ [ [ 2 ], [ 2, 1 ], [ 1, 1 ], [ 1 ], [ 1 ], [ 2, 2 ] ] ] ]; | ||
Neerajpathak07 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
> {{alias}}( [ x, y, z, w, v, out ], shapes, fcn ); | ||
> out | ||
[ [ [ [ 8.0, 9.0 ], [ 9.0, 10.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.