Skip to content
Open
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
303 changes: 303 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/znone/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,303 @@
<!--

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

-->

# znone

> Test whether every element in a double-precision complex floating-point strided array is falsy.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

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

#### znone( N, x, strideX )

Tests whether every element in a double-precision complex floating-point strided array is falsy.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

var x = new Complex128Array( [ 0.0, 0.0, 1.0, 1.0 ] );

var v = znone( x.length, x, 1 );
// returns false
```

The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Complex128Array`][@stdlib/array/complex128].
- **strideX**: stride length.

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element:

<!-- eslint-disable max-len -->

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0 ] );

var v = znone( 3, x, 2 );
// returns false
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

<!-- eslint-disable stdlib/capitalized-comments, max-len -->

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

var x0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0 ] );
var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var v = znone( 3, x1, 2 );
// returns false
```

#### znone.ndarray( N, x, strideX, offsetX )

Tests whether every element in a double-precision complex floating-point strided array is falsy using alternative indexing semantics.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

var x = new Complex128Array( [ 0.0, 0.0, 1.0, 1.0 ] );

var v = znone.ndarray( x.length, x, 1, 0 );
// returns false
```

The function has the following additional parameters:

- **offsetX**: starting index.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to test every other element starting from the second element:

<!-- eslint-disable max-len -->

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );

var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0 ] );

var v = znone.ndarray( 3, x, 2, 1 );
// returns false
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N <= 0`, both functions return `true`.
- A complex number is considered falsy when both its real and imaginary components are falsy.
- Both functions explicitly treat `NaN` values as falsy.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var Complex128Array = require( '@stdlib/array/complex128' );
var logEach = require( '@stdlib/console/log-each' );
var znone = require( '@stdlib/blas/ext/base/znone' );

var buf = bernoulli( 10*2, 0.3, {
'dtype': 'float64'
});
var x = new Complex128Array( buf.buffer );
logEach( '%s', x );

var out = znone( x.length, x, 1 );
console.log( out );
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/blas/ext/base/znone.h"
```

#### stdlib_strided_znone( N, \*X, strideX )

Tests whether every element in a double-precision complex floating-point strided array is falsy.

```c
#include "stdlib/complex/float64/ctor.h"

const double x[] = { 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0 };

bool result = stdlib_strided_znone( 4, (const stdlib_complex128_t *)x, 1 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] stdlib_complex128_t*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.

```c
bool stdlib_strided_znone( const CBLAS_INT N, const stdlib_complex128_t *X, const CBLAS_INT strideX );
```

#### stdlib_strided_znone_ndarray( N, \*X, strideX, offsetX )

Tests whether every element in a double-precision complex floating-point strided array is falsy using alternative indexing semantics.

```c
#include "stdlib/complex/float64/ctor.h"

const double x[] = { 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0 };

bool result = stdlib_strided_znone_ndarray( 4, (const stdlib_complex128_t *)x, 1, 0 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] stdlib_complex128_t*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.
- **offsetX**: `[in] CBLAS_INT` starting index.

```c
bool stdlib_strided_znone_ndarray( const CBLAS_INT N, const stdlib_complex128_t *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

- A complex number is considered falsy when both its real and imaginary components are falsy.
- Both functions explicitly treat `NaN` values as falsy.

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/blas/ext/base/znone.h"
#include "stdlib/complex/float64/ctor.h"
#include <stdbool.h>
#include <stdio.h>

int main( void ) {
// Create a strided array (interleaved real and imaginary components):
const double x[] = { 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0 };

// Specify the number of indexed elements:
const int N = 4;

// Specify a stride:
const int strideX = 1;

// Test whether every element is falsy:
bool result = stdlib_strided_znone( N, (const stdlib_complex128_t *)x, strideX );

// Print the result:
printf( "Result: %s\n", result ? "true" : "false" );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
/**
* @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 zeros = require( '@stdlib/array/zeros' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var znone = require( './../lib/znone.js' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = zeros( len, 'complex128' );
return benchmark;

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = znone( len, x, 1 );
if ( typeof out !== 'boolean' ) {
b.fail( 'should return a boolean' );
}
}
b.toc();
if ( typeof out !== 'boolean' ) {
b.fail( 'should return a boolean' );
}
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();
Loading