Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/blas/ext/base/ndarray/swhere/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<!--

@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.

-->

# swhere

> Take elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var swhere = require( '@stdlib/blas/ext/base/ndarray/swhere' );
```

#### swhere( arrays )

Takes elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition.

```javascript
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
var Float32Vector = require( '@stdlib/ndarray/vector/float32' );

var condition = new BooleanVector( [ true, false, true, false, true ] );
var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float32Vector( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
var out = new Float32Vector( 5 );

swhere( [ condition, x, y, out ] );
// out => <ndarray>[ 1.0, 7.0, 3.0, 9.0, 5.0 ]
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional condition ndarray.
- first one-dimensional input ndarray.
- second one-dimensional input ndarray.
- a one-dimensional output ndarray.

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var swhere = require( '@stdlib/blas/ext/base/ndarray/swhere' );

var opts = {
'dtype': 'float32'
};

var cbuf = bernoulli( 10, 0.5, {
'dtype': 'uint8'
});
var condition = new BooleanVector( cbuf.buffer );
console.log( ndarray2array( condition ) );

var x = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( x ) );

var y = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( y ) );

var out = discreteUniform( [ 10 ], -100, 100, opts );

swhere( [ condition, x, y, out ] );
console.log( ndarray2array( 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">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/**
* @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 bernoulli = require( '@stdlib/random/array/bernoulli' );
var uniform = require( '@stdlib/random/uniform' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var swhere = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - ndarray length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var condition;
var cbuf;
var out;
var x;
var y;

cbuf = bernoulli( len, 0.5, {
'dtype': 'uint8'
});
condition = new BooleanVector( cbuf.buffer );
out = uniform( [ len ], -100.0, 100.0, options );
x = uniform( [ len ], -100.0, 100.0, options );
y = uniform( [ len ], -100.0, 100.0, options );
return benchmark;

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = swhere( [ condition, x, y, out ] );
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( typeof v !== 'object' ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

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

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

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

{{alias}}( arrays )
Takes elements from one of two one-dimensional single-precision floating-
point ndarrays depending on a condition.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional condition ndarray.
- first one-dimensional input ndarray.
- second one-dimensional input ndarray.
- a one-dimensional output ndarray.

Returns
-------
out: ndarray
Output ndarray.

Examples
--------
> var c = new {{alias:@stdlib/ndarray/vector/bool}}( [ true, false, true, false ] );
> var x = new {{alias:@stdlib/ndarray/vector/float32}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var y = new {{alias:@stdlib/ndarray/vector/float32}}( [ 5.0, 6.0, 7.0, 8.0 ] );
> var out = new {{alias:@stdlib/ndarray/vector/float32}}( 4 );
> {{alias}}( [ c, x, y, out ] )
<ndarray>[ 1.0, 6.0, 3.0, 8.0 ]

See Also
--------

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

// TypeScript Version: 4.1

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

import { float32ndarray, boolndarray } from '@stdlib/types/ndarray';

/**
* Takes elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional condition ndarray.
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var BooleanVector = require( '@stdlib/ndarray/vector/bool' );
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var condition = new BooleanVector( [ true, false, true, false, true ] );
* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Vector( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var out = new Float32Vector( 5 );
*
* var v = swhere( [ condition, x, y, out ] );
* // returns <ndarray>[ 1.0, 7.0, 3.0, 9.0, 5.0 ]
*/
declare function swhere( arrays: [ boolndarray, float32ndarray, float32ndarray, float32ndarray ] ): float32ndarray;


// EXPORTS //

export = swhere;
Loading
Loading