Skip to content

feat: add array/base/mskbinary4d #3196

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 69 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
020951d
secant functionality added
AbhijitRaut04 Oct 20, 2024
cd658c7
test cases checked
AbhijitRaut04 Oct 21, 2024
61dd8a5
huge_negative.json unformat
AbhijitRaut04 Oct 21, 2024
1a3044c
Examples fixed
AbhijitRaut04 Oct 26, 2024
4f9cfcd
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Oct 26, 2024
20d3800
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Oct 26, 2024
a7396d8
Apply suggestions from code review
kgryte Oct 26, 2024
7a2c270
Spacing conventions followed and required changes made
AbhijitRaut04 Oct 27, 2024
d0ebc38
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Oct 27, 2024
2733e3e
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Oct 29, 2024
52900e0
necessary changes made
AbhijitRaut04 Oct 29, 2024
5ab6d39
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Oct 29, 2024
6f04f94
chore: apply suggestions from code review
Planeshifter Oct 29, 2024
a630f41
chore: update relative path
Planeshifter Oct 29, 2024
2cb28a7
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Oct 31, 2024
c30cdec
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 13, 2024
0735981
add c implementation for minmax
AbhijitRaut04 Nov 13, 2024
0d34bb5
example.out
AbhijitRaut04 Nov 13, 2024
cbaa9a0
add manifest.json
AbhijitRaut04 Nov 13, 2024
89d15a4
pyp files added
AbhijitRaut04 Nov 13, 2024
64bb538
dependency resolved
AbhijitRaut04 Nov 14, 2024
72be084
removed minmax dependency
AbhijitRaut04 Nov 14, 2024
8b45444
return datatype changed
AbhijitRaut04 Nov 14, 2024
0339052
licensce years corrected
AbhijitRaut04 Nov 14, 2024
8f1f317
years corrected
AbhijitRaut04 Nov 14, 2024
6ca0a3f
unary to binary converted
AbhijitRaut04 Nov 14, 2024
3346b22
update
AbhijitRaut04 Nov 14, 2024
dd3e865
removed cephes
AbhijitRaut04 Nov 14, 2024
d5b8312
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 15, 2024
67e9010
manifest update
AbhijitRaut04 Nov 15, 2024
bf6f9e0
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Nov 15, 2024
d800f25
manifest updated
AbhijitRaut04 Nov 15, 2024
9035a6c
_
AbhijitRaut04 Nov 15, 2024
c43128a
update package.json
AbhijitRaut04 Nov 15, 2024
674fdd0
''
AbhijitRaut04 Nov 15, 2024
da8bf36
add dynamic allocation for result
AbhijitRaut04 Nov 15, 2024
4be1efa
implementation changed
AbhijitRaut04 Nov 15, 2024
4f592a2
changes updated
AbhijitRaut04 Nov 15, 2024
0f722f7
void changed to double
AbhijitRaut04 Nov 15, 2024
fbe9c46
return
AbhijitRaut04 Nov 15, 2024
9e9c7fa
examples updated
AbhijitRaut04 Nov 15, 2024
3c8ec0e
wrapper added for minmax
AbhijitRaut04 Nov 15, 2024
0598ee5
wrapper modified
AbhijitRaut04 Nov 15, 2024
c89beac
benchs examples
AbhijitRaut04 Nov 15, 2024
1f95c46
return changed to double instead double *
AbhijitRaut04 Nov 16, 2024
a4dbf3c
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 16, 2024
6a0ad2f
native.js updated
AbhijitRaut04 Nov 16, 2024
1ebac1d
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Nov 16, 2024
8baa0ac
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 17, 2024
d44c982
Merge remote-tracking branch 'upstream/develop' into develop
stdlib-bot Nov 18, 2024
ab4c30f
changes made
AbhijitRaut04 Nov 18, 2024
480eca1
Merge branch 'develop' of https://github.com/AbhijitRaut04/stdlib int…
AbhijitRaut04 Nov 18, 2024
ce381ba
changes made
AbhijitRaut04 Nov 18, 2024
ea1137f
changes reverted
AbhijitRaut04 Nov 18, 2024
a84f7ee
native implementation updated
AbhijitRaut04 Nov 18, 2024
42e7d33
update native
AbhijitRaut04 Nov 18, 2024
6770168
revrt
AbhijitRaut04 Nov 18, 2024
47fe186
revert
AbhijitRaut04 Nov 18, 2024
0235838
addon.c
AbhijitRaut04 Nov 18, 2024
5618d1a
restored changes in develop branch
AbhijitRaut04 Nov 18, 2024
313a49b
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 18, 2024
27ab286
Merge branch 'stdlib-js:develop' into develop
AbhijitRaut04 Nov 19, 2024
719b951
add maskbinary4d implementation
AbhijitRaut04 Nov 20, 2024
9bded28
minor issue resolve
AbhijitRaut04 Nov 20, 2024
c7c88a8
minor issue resolved
AbhijitRaut04 Nov 20, 2024
3978bc6
suggested changes made
AbhijitRaut04 Nov 20, 2024
acfc45d
test.native.js updated
AbhijitRaut04 Nov 20, 2024
b6041a5
Merge branch 'stdlib-js:develop' into mskbinary4d
AbhijitRaut04 Nov 20, 2024
2fef3c4
Merge branch 'stdlib-js:develop' into mskbinary4d
AbhijitRaut04 Nov 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions lib/node_modules/@stdlib/array/base/mskbinary4d/README.md
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.

-->

# mskbinary4d

> Apply a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assign results to elements in a four-dimensional nested output array.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

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

#### mskbinary4d( arrays, shape, fcn )

Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array.

```javascript
var add = require( '@stdlib/math/base/ops/add' );
var zeros4d = require( '@stdlib/array/base/zeros4d' );

var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
var z = zeros4d( [ 1, 1, 2, 2 ] );

var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];

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

mskbinary4d( [ x, x, mask, z ], shape, add );
// z => [ [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ] ] ]
```

The function accepts the following arguments:

- **arrays**: array-like object containing two input nested arrays, an input nested mask array, and one output nested array.
- **shape**: array shape.
- **fcn**: binary 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 bernoulli = require( '@stdlib/random/base/bernoulli' ).factory;
var filled4dBy = require( '@stdlib/array/base/filled4d-by' );
var zeros4d = require( '@stdlib/array/base/zeros4d' );
var add = require( '@stdlib/math/base/ops/add' );
var mskbinary4d = require( '@stdlib/array/base/mskbinary4d' );

var shape = [ 2, 1, 3, 3 ];

var x = filled4dBy( shape, discreteUniform( -100, 100 ) );
console.log( x );

var y = filled4dBy( shape, discreteUniform( -100, 100 ) );
console.log( y );

var mask = filled4dBy( shape, bernoulli( 0.5 ) );
console.log( mask );

var z = zeros4d( shape );
console.log( z );

mskbinary4d( [ x, y, mask, z ], shape, add );
console.log( z );
```

</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 -->
127 changes: 127 additions & 0 deletions lib/node_modules/@stdlib/array/base/mskbinary4d/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
/**
* @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 floor = require( '@stdlib/math/base/special/floor' );
var add = require( '@stdlib/math/base/ops/add' );
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 mskbinary4d = 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;
var z;
var m;

x = filled4dBy( shape, uniform( -100.0, 100.0 ) );
y = filled4dBy( shape, uniform( -100.0, 100.0 ) );
m = filled4dBy( shape, bernoulli( 0.5 ) );
z = zeros4d( shape );

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

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++ ) {
mskbinary4d( arrays, shape, add );
i3 = i % shape[ 0 ];
i2 = i % shape[ 1 ];
i1 = i % shape[ 2 ];
i0 = i % shape[ 3 ];
if ( isnan( arrays[ 3 ][ i3 ][ i2 ][ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();

i3 = i % shape[ 0 ];
i2 = i % shape[ 1 ];
i1 = i % shape[ 2 ];
i0 = i % shape[ 3 ];
if ( isnan( arrays[ 3 ][ 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/4.0 ) );
sh = [ N, N, N, N ];
f = createBenchmark( sh );
bench( pkg+'::equidimensional:size='+numel( sh ), f );

Check warning on line 123 in lib/node_modules/@stdlib/array/base/mskbinary4d/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unknown word: "equidimensional"
}
}

main();
35 changes: 35 additions & 0 deletions lib/node_modules/@stdlib/array/base/mskbinary4d/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

{{alias}}( arrays, shape, fcn )
Applies a binary callback to elements in two four-dimensional nested input
arrays according to elements in a four-dimensional nested mask array and
assigns results to elements in a four-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 two input nested arrays, an input nested
mask array, and one output nested array.

shape: Array<integer>
Array shape.

fcn: Function
Binary callback.

Examples
--------
> var x = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
> var y = [ [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] ];
> var m = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
> var z = [ [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ] ];
> var shape = [ 1, 1, 2, 2 ];
> {{alias}}( [ x, y, m, z ], shape, {{alias:@stdlib/math/base/ops/add}} );
> z
[ [ [ [ 2.0, 0.0 ], [ 6.0, 8.0 ] ] ] ]

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* @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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { Array4D } from '@stdlib/types/array';
import { Shape4D } from '@stdlib/types/ndarray';

/**
* Binary callback.
*
* @param v1 - element from first input array
* @param v2 - element from second input array
* @returns result
*/
type Binary<T, U, V> = ( v1: T, v2: U ) => V;

/**
* Applies a binary callback to elements in two four-dimensional nested input arrays according to elements in a four-dimensional nested mask array and assigns results to elements in a four-dimensional nested output array.
*
* ## 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.
*
* @param arrays - array containing two input nested arrays, an input nested mask array, and one output nested array
* @param shape - array shape
* @param fcn - binary callback
*
* @example
* var ones4d = require( '@stdlib/array/base/ones4d' );
* var zeros4d = require( '@stdlib/array/base/zeros4d' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var shape = [ 1, 1, 2, 2 ];
*
* var x = ones4d( shape );
* var y = ones4d( shape );
* var z = zeros4d( shape );
*
* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
*
* mskbinary2d( [ x, y, mask, z ], shape, add );
*
* console.log( z );
* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ]
*/
declare function mskbinary4d<T = unknown, U = unknown, V = unknown>( arrays: [ Array4D<T>, Array4D<U>, Array4D<number>, Array4D<V> ], shape: Shape4D, fcn: Binary<T, U, V> ): void;


// EXPORTS //

export = mskbinary4d;
Loading