-
-
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
ea263f9
commit a41b1cd
Showing
11 changed files
with
1,191 additions
and
3 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,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. | ||
| --> | ||
|
|
||
| # mskunary5d | ||
|
|
||
| > Apply a unary callback to elements in a five-dimensional nested input array according to elements in a five-dimensional nested mask array and assign results to elements in a five-dimensional nested output array. | ||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var mskunary5d = require( '@stdlib/array/base/mskunary5d' ); | ||
| ``` | ||
|
|
||
| #### mskunary5d( arrays, shape, fcn ) | ||
|
|
||
| Applies a unary callback to elements in a five-dimensional nested input array according to elements in a five-dimensional nested mask array and assigns results to elements in a five-dimensional nested output array. | ||
|
|
||
| ```javascript | ||
| var abs = require( '@stdlib/math/base/special/abs' ); | ||
|
|
||
| var x = [ [ [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ] ] ]; | ||
| var mask = [ [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ] ]; | ||
|
|
||
| var shape = [ 1, 1, 1, 2, 2 ]; | ||
|
|
||
| // Compute the absolute values in-place: | ||
| mskunary5d( [ x, mask, x ], shape, abs ); | ||
| // x => [ [ [ [ [ 1.0, -2.0 ], [ 3.0, 4.0 ] ] ] ] ] | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **arrays**: array-like object containing one input nested array, an input nested mask array, and one output nested array. | ||
| - **shape**: array shape. | ||
| - **fcn**: unary function to apply. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## 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. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; | ||
| var bernoulli = require( '@stdlib/random/base/bernoulli' ).factory; | ||
| var filled5dBy = require( '@stdlib/array/base/filled5d-by' ); | ||
| var zeros5d = require( '@stdlib/array/base/zeros5d' ); | ||
| var abs = require( '@stdlib/math/base/special/abs' ); | ||
| var mskunary5d = require( '@stdlib/array/base/mskunary5d' ); | ||
|
|
||
| var shape = [ 1, 2, 2, 3, 3 ]; | ||
|
|
||
| var x = filled5dBy( shape, discreteUniform( -100, 100 ) ); | ||
| console.log( x ); | ||
|
|
||
| var mask = filled5dBy( shape, bernoulli( 0.5 ) ); | ||
| console.log( mask ); | ||
|
|
||
| var y = zeros5d( shape ); | ||
| console.log( y ); | ||
|
|
||
| mskunary5d( [ x, mask, y ], shape, abs ); | ||
| console.log( y ); | ||
| ``` | ||
|
|
||
| </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"> | ||
|
|
||
| </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,128 @@ | ||
| /** | ||
| * @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 identity = require( '@stdlib/math/base/special/identity' ); | ||
| var floor = require( '@stdlib/math/base/special/floor' ); | ||
| var filled5dBy = require( './../../../base/filled5d-by' ); | ||
| var zeros5d = require( './../../../base/zeros5d' ); | ||
| var numel = require( '@stdlib/ndarray/base/numel' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var mskunary5d = 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 m; | ||
| var y; | ||
|
|
||
| x = filled5dBy( shape, uniform( -100.0, 100.0 ) ); | ||
| m = filled5dBy( shape, bernoulli( 0.5 ) ); | ||
| y = zeros5d( shape ); | ||
|
|
||
| arrays = [ x, m, y ]; | ||
|
|
||
| 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++ ) { | ||
| mskunary5d( arrays, shape, identity ); | ||
| i4 = i % shape[ 0 ]; | ||
| i3 = i % shape[ 1 ]; | ||
| i2 = i % shape[ 2 ]; | ||
| i1 = i % shape[ 3 ]; | ||
| i0 = i % shape[ 4 ]; | ||
| if ( isnan( arrays[ 2 ][ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
|
|
||
| i4 = i % shape[ 0 ]; | ||
| i3 = i % shape[ 1 ]; | ||
| i2 = i % shape[ 2 ]; | ||
| i1 = i % shape[ 3 ]; | ||
| i0 = i % shape[ 4 ]; | ||
| if ( isnan( arrays[ 2 ][ 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(); |
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,34 @@ | ||
|
|
||
| {{alias}}( arrays, shape, fcn ) | ||
| Applies a unary callback to elements in a five-dimensional nested input | ||
| array according to elements in a five-dimensional nested mask array and | ||
| assigns results to elements in a five-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 one input nested array, an input nested | ||
| mask array, and one output nested array. | ||
|
|
||
| shape: Array<integer> | ||
| Array shape. | ||
|
|
||
| fcn: Function | ||
| Unary callback. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var x = [ [ [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ] ] ]; | ||
| > var m = [ [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ] ]; | ||
| > var y = [ [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ] ]; | ||
| > var shape = [ 1, 1, 1, 2, 2 ]; | ||
| > {{alias}}( [ x, m, y ], shape, {{alias:@stdlib/math/base/special/abs}} ); | ||
| > y | ||
| [ [ [ [ [ 1.0, 0.0 ], [ 3.0, 4.0 ] ] ] ] ] | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
Oops, something went wrong.