Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
61 changes: 61 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/where/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# Where

> Apply a condition to elements in two input ndarrays and assign results to elements in an output ndarray.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">


</section>

<!-- /.usage -->

<section class="examples">

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. -->

* * *

<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 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 discreteUniform = require( '@stdlib/random/base/discrete-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 sqrt = require( '@stdlib/math/base/special/sqrt' );
var filledarray = require( '@stdlib/array/filled' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
var pkg = require( './../package.json' ).name;
var where2d = require( './../lib/2d.js' );


// VARIABLES //

var types = [ 'float64' ];
var order = 'column-major';


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - ndarray length
* @param {NonNegativeIntegerArray} shape - ndarray shape
* @param {string} xtype - first input ndarray data type
* @param {string} ytype - second input ndarray data type
* @returns {Function} benchmark function
*/
function createBenchmark( len, shape, xtype, ytype ) {
var condition;
var out;
var x;
var y;
condition = filledarrayBy( len, 'uint8', bernoulli( 0.5 ) );
x = filledarrayBy( len, xtype, discreteUniform( -100, 100 ) );
y = filledarrayBy( len, ytype, discreteUniform( -100, 100 ) );
out = filledarray( 0.0, len, xtype );

condition = {
'dtype': 'uint8',
'data': condition,
'shape': shape,
'strides': shape2strides( shape, order ),
'offset': 0,
'order': order
};
x = {
'dtype': xtype,
'data': x,
'shape': shape,
'strides': shape2strides( shape, order ),
'offset': 0,
'order': order
};
y = {
'dtype': ytype,
'data': y,
'shape': shape,
'strides': shape2strides( shape, order ),
'offset': 0,
'order': order
};
out = {
'dtype': xtype,
'data': out,
'shape': shape,
'strides': shape2strides( shape, order ),
'offset': 0,
'order': order
};
return benchmark;

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
where2d( condition, x, y, out, false );
if ( isnan( out.data[ i%len ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( out.data[ i%len ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var sh;
var t1;
var t2;
var f;
var i;
var j;

min = 1; // 10^min
max = 6; // 10^max

for ( j = 0; j < types.length; j++ ) {
t1 = types[ j ];
t2 = types[ j ];
for ( i = min; i <= max; i++ ) {
len = pow( 10, i );

sh = [ len/2, 2 ];
f = createBenchmark( len, sh, t1, t2 );
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',xtype='+t1+',ytype='+t2, f );

sh = [ 2, len/2 ];
f = createBenchmark( len, sh, t1, t2 );
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',xtype='+t1+',ytype='+t2, f );

len = floor( sqrt( len ) );
sh = [ len, len ];
len *= len;
f = createBenchmark( len, sh, t1, t2 );
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],order='+order+',xtype='+t1+',ytype='+t2, f );
}
}
}

main();
Loading