-
-
Notifications
You must be signed in to change notification settings - Fork 447
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
Showing
10 changed files
with
1,173 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<!-- | ||
@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. | ||
--> | ||
|
||
# unary5d | ||
|
||
> Apply a unary callback to elements in a five-dimensional nested input array and assign results to elements in a five-dimensional nested output array. | ||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var unary5d = require( '@stdlib/array/base/unary5d' ); | ||
``` | ||
|
||
#### unary5d( arrays, shape, fcn ) | ||
|
||
Applies a unary callback to elements in a five-dimensional nested input 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 shape = [ 1, 1, 1, 2, 2 ]; | ||
|
||
// Compute the absolute values in-place: | ||
unary5d( [ x, 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 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. | ||
|
||
</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 abs = require( '@stdlib/math/base/special/abs' ); | ||
var unary5d = require( '@stdlib/array/base/unary5d' ); | ||
|
||
var shape = [ 2, 1, 2, 3, 3 ]; | ||
|
||
var x = filled5dBy( shape, discreteUniform( -100, 100 ) ); | ||
console.log( x ); | ||
|
||
var y = zeros5d( shape ); | ||
console.log( y ); | ||
|
||
unary5d( [ x, 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 --> |
125 changes: 125 additions & 0 deletions
125
lib/node_modules/@stdlib/array/base/unary5d/benchmark/benchmark.js
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,125 @@ | ||
/** | ||
* @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 identity = require( '@stdlib/math/base/special/identity' ); | ||
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 unary5d = 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 y; | ||
|
||
x = filled5dBy( shape, uniform( -100.0, 100.0 ) ); | ||
y = zeros5d( shape ); | ||
|
||
arrays = [ x, 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++ ) { | ||
unary5d( 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[ 1 ][ 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[ 1 ][ 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,30 @@ | ||
|
||
{{alias}}( arrays, shape, fcn ) | ||
Applies a unary callback to elements in a five-dimensional nested input | ||
array and assigns results to elements in a five-dimensional nested output | ||
array. | ||
|
||
Parameters | ||
---------- | ||
arrays: ArrayLikeObject | ||
Array-like object containing one input nested 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 y = [ [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ] ]; | ||
> var shape = [ 1, 1, 1, 2, 2 ]; | ||
> {{alias}}( [ x, y ], shape, {{alias:@stdlib/math/base/special/abs}} ); | ||
> y | ||
[ [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ] ] | ||
|
||
See Also | ||
-------- | ||
|
68 changes: 68 additions & 0 deletions
68
lib/node_modules/@stdlib/array/base/unary5d/docs/types/index.d.ts
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,68 @@ | ||
/* | ||
* @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 { Array5D } from '@stdlib/types/array'; | ||
import { Shape5D } from '@stdlib/types/ndarray'; | ||
|
||
/** | ||
* Unary callback. | ||
* | ||
* @param value - input value | ||
* @returns result | ||
*/ | ||
type Unary<T, U> = ( value: T ) => U; | ||
|
||
/** | ||
* Applies a unary callback to elements in a five-dimensional nested input array and assigns results to elements in a five-dimensional nested output array. | ||
* | ||
* ## Notes | ||
* | ||
* - The function assumes that the input and output arrays have the same shape. | ||
* | ||
* @param arrays - array containing one input nested array and one output nested array | ||
* @param shape - array shape | ||
* @param fcn - unary callback | ||
* | ||
* @example | ||
* var ones5d = require( `@stdlib/array/base/ones5d` ); | ||
* var zeros5d = require( `@stdlib/array/base/zeros5d` ); | ||
* | ||
* function scale( x ) { | ||
* return x * 10.0; | ||
* } | ||
* | ||
* var shape = [ 1, 1, 1, 2, 2 ]; | ||
* | ||
* var x = ones5d( shape ); | ||
* var y = zeros5d( shape ); | ||
* | ||
* unary5d( [ x, y ], shape, scale ); | ||
* | ||
* console.log( y ); | ||
* // => [ [ [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] ] ] | ||
*/ | ||
declare function unary5d<T = unknown, U = unknown>( arrays: [ Array5D<T>, Array5D<U> ], shape: Shape5D, fcn: Unary<T, U> ): void; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = unary5d; |
Oops, something went wrong.