Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Oct 31, 2023
1 parent 4083fd0 commit cae3de7
Show file tree
Hide file tree
Showing 13 changed files with 1,032 additions and 5 deletions.
147 changes: 147 additions & 0 deletions base/broadcasted-ternary2d/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!--
@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.
-->

# bternary2d

> Apply a ternary callback to elements in three [broadcasted][@stdlib/array/base/broadcast-array] nested input arrays and assign results to elements in a two-dimensional nested output array.
<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var bternary2d = require( '@stdlib/array/base/broadcasted-ternary2d' );
```

#### bternary2d( 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 two-dimensional nested output array.

```javascript
var zeros2d = require( '@stdlib/array/base/zeros2d' );

function add( x, y, z ) {
return x + y + z;
}

var x = [ [ 1.0, 2.0 ] ];
var y = [ [ 3.0 ], [ 4.0 ] ];
var z = [ [ 5.0 ] ];
var out = zeros2d( [ 2, 2 ] );

var shapes = [
[ 1, 2 ],
[ 2, 1 ],
[ 1, 1 ],
[ 2, 2 ]
];

bternary2d( [ x, y, z, out ], shapes, add );
// out => [ [ 9.0, 10.0 ], [ 10.0, 11.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 filled2dBy = require( '@stdlib/array/base/filled2d-by' );
var zeros2d = require( '@stdlib/array/base/zeros2d' );
var bternary2d = require( '@stdlib/array/base/broadcasted-ternary2d' );

function add( x, y, z ) {
return x + y + z;
}

var shapes = [
[ 1, 3 ],
[ 3, 1 ],
[ 1, 1 ],
[ 3, 3 ]
];

var x = filled2dBy( shapes[ 0 ], discreteUniform( -100, 100 ) );
console.log( x );

var y = filled2dBy( shapes[ 1 ], discreteUniform( -100, 100 ) );
console.log( y );

var z = filled2dBy( shapes[ 2 ], discreteUniform( -100, 100 ) );
console.log( z );

var out = zeros2d( shapes[ 3 ] );
console.log( out );

bternary2d( [ 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 -->
139 changes: 139 additions & 0 deletions base/broadcasted-ternary2d/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/**
* @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 filled2dBy = require( './../../../base/filled2d-by' );
var zeros2d = require( './../../../base/zeros2d' );
var numel = require( '@stdlib/ndarray/base/numel' );
var pkg = require( './../package.json' ).name;
var bternary2d = require( './../lib' );


// FUNCTIONS //

/**
* Returns the sum.
*
* @private
* @param {number} x - first value
* @param {number} y - second value
* @param {number} z - third value
* @returns {number} sum
*/
function add( x, y, z ) {
return x + y + z;
}

/**
* 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;

shapes = [
[ 1, shape[ 1 ] ],
[ shape[ 0 ], 1 ],
[ 1, 1 ],
shape
];
x = filled2dBy( shapes[ 0 ], uniform( -100.0, 100.0 ) );
y = filled2dBy( shapes[ 1 ], uniform( -100.0, 100.0 ) );
z = filled2dBy( shapes[ 2 ], uniform( -100.0, 100.0 ) );
out = zeros2d( shapes[ 3 ] );

arrays = [ x, y, z, out ];

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var i0;
var i1;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
bternary2d( arrays, shapes, add );
i1 = i % shapes[ 1 ][ 0 ];
i0 = i % shapes[ 1 ][ 1 ];
if ( isnan( arrays[ 3 ][ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();

i1 = i % shapes[ 1 ][ 0 ];
i0 = i % shapes[ 1 ][ 1 ];
if ( isnan( arrays[ 3 ][ 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/2.0 ) );
sh = [ N, N ];
f = createBenchmark( sh );
bench( pkg+'::square_matrix:size='+numel( sh ), f );
}
}

main();
32 changes: 32 additions & 0 deletions base/broadcasted-ternary2d/docs/repl.txt
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 two-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, 2.0 ];
> var y = [ [ 3.0 ], [ 4.0 ] ];
> var z = [ [ 1.0 ] ];
> var out = [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ];
> var shapes = [ [ 2 ], [ 2, 1 ], [ 1, 1 ], [ 2, 2 ] ];
> {{alias}}( [ x, y, z, out ], shapes, fcn );
> out
[ [ 5.0, 6.0 ], [ 6.0, 7.0 ] ]

See Also
--------

75 changes: 75 additions & 0 deletions base/broadcasted-ternary2d/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* @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 { Array1D, Array2D } from '@stdlib/types/array';
import { Shape1D, Shape2D } from '@stdlib/types/ndarray';

/**
* Ternary callback.
*
* @param value - input value
* @returns result
*/
type Ternary<T, U, V, W> = ( v1: T, v2: U, v3: V ) => W;

/**
* Applies a ternary callback to elements in three broadcasted input arrays and assigns results to elements in a two-dimensional nested output array.
*
* ## Notes
*
* - The input array shapes must be broadcast compatible with the output array shape.
*
* @param arrays - array containing three input nested arrays and one output nested array
* @param shapes - array shapes
* @param fcn - ternary callback
*
* @example
* var ones2d = require( `@stdlib/array/base/ones2d` );
* var zeros2d = require( `@stdlib/array/base/zeros2d` );
*
* function add( x, y, z ) {
* return x + y + z;
* }
*
* var shapes = [
* [ 1, 2 ],
* [ 2, 1 ],
* [ 1, 1 ],
* [ 2, 2 ]
* ];
*
* var x = ones2d( shapes[ 0 ] );
* var y = ones2d( shapes[ 1 ] );
* var z = ones2d( shapes[ 2 ] );
* var out = zeros2d( shapes[ 3 ] );
*
* bternary2d( [ x, y, z, out ], shapes, add );
*
* console.log( out );
* // => [ [ 3.0, 6.0 ], [ 9.0, 12.0 ] ]
*/
declare function bternary2d<T = unknown, U = unknown, V = unknown, W = unknown>( arrays: [ Array1D<T> | Array2D<T>, Array1D<U> | Array2D<U>, Array1D<V> | Array2D<V>, Array2D<W> ], shapes: [ Shape1D | Shape2D, Shape1D | Shape2D, Shape1D | Shape2D, Shape2D ], fcn: Ternary<T, U, V, W> ): void;


// EXPORTS //

export = bternary2d;
Loading

0 comments on commit cae3de7

Please sign in to comment.