Skip to content

feat: add blas/ext/base/zindex-of-not-equal #13958

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.

Sign up for GitHub

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

Open
headlessNode wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: add blas/ext/base/zindex-of-not-equal #13958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
347 changes: 347 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/zindex-of-not-equal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,347 @@
<!--

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

-->

# zindexOfNotEqual

> Return the first index of an element in a double-precision complex floating-point strided array which is not equal to a specified search element.

<!-- 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 -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var zindexOfNotEqual = require( '@stdlib/blas/ext/base/zindex-of-not-equal' );
```

#### zindexOfNotEqual( N, searchElement, x, strideX )

Returns the first index of an element in a double-precision complex floating-point strided array which is not equal to a specified search element.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

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

var idx = zindexOfNotEqual( x.length, new Complex128( 1.0, 2.0 ), x, 1 );
// returns 2
```

The function has the following parameters:

- **N**: number of indexed elements.
- **searchElement**: search element ([`Complex128`][@stdlib/complex/float64/ctor]).
- **x**: input [`Complex128Array`][@stdlib/array/complex128].
- **strideX**: stride length.

If all elements in the array are equal to the search element, the function returns `-1`.

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

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

var idx = zindexOfNotEqual( x.length, new Complex128( 1.0, 2.0 ), x, 1 );
// returns -1
```

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

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

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

var idx = zindexOfNotEqual( 2, new Complex128( 1.0, 2.0 ), x, 2 );
// returns 1
```

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

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

// Initial array...
var x0 = new Complex128Array( [ 1.0, 2.0, 1.0, 2.0, 1.0, 2.0, 0.0, 0.0 ] );

// Create an offset view...
var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

// Find index...
var idx = zindexOfNotEqual( 3, new Complex128( 1.0, 2.0 ), x1, 1 );
// returns 2
```

#### zindexOfNotEqual.ndarray( N, searchElement, x, strideX, offsetX )

Returns the first index of an element in a double-precision complex floating-point strided array which is not equal to a specified search element using alternative indexing semantics.

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

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

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

var idx = zindexOfNotEqual.ndarray( x.length, new Complex128( 1.0, 2.0 ), x, 1, 0 );
// returns 2
```

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 access only the last three elements of the strided array:

```javascript
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

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

var idx = zindexOfNotEqual.ndarray( 3, new Complex128( 1.0, 2.0 ), x, 1, 1 );
// returns 1
```

</section>

<!-- /.usage -->

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

<section class="notes">

## Notes

- When searching for a search element, the function checks for inequality of the real and imaginary components using the strict inequality operator `!==`. As a consequence, `NaN` values are considered distinct from all values (including other `NaN` values), and `-0` and `+0` are considered the same.

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

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

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );
var logEach = require( '@stdlib/console/log-each' );
var zindexOfNotEqual = require( '@stdlib/blas/ext/base/zindex-of-not-equal' );

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

var idx = zindexOfNotEqual( x.length, new Complex128( 0.0, 0.0 ), x, 1 );
console.log( idx );
```

</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/zindex_of_not_equal.h"
```

<!-- lint disable maximum-heading-length -->

#### stdlib_strided_zindex_of_not_equal( N, searchElement, \*X, strideX )

<!-- lint enable maximum-heading-length -->

Returns the first index of an element in a double-precision complex floating-point strided array which is not equal to a specified search element.

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

const double x[] = { 1.0, 2.0, 1.0, 2.0, 0.0, 0.0, 1.0, 2.0 };
const stdlib_complex128_t searchElement = stdlib_complex128( 1.0, 2.0 );

int idx = stdlib_strided_zindex_of_not_equal( 4, searchElement, (const stdlib_complex128_t *)x, 1 );
// returns 2
```

The function accepts the following arguments:

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

```c
CBLAS_INT stdlib_strided_zindex_of_not_equal( const CBLAS_INT N, const stdlib_complex128_t searchElement, const stdlib_complex128_t *X, const CBLAS_INT strideX );
```

<!-- lint disable maximum-heading-length -->

#### stdlib_strided_zindex_of_not_equal_ndarray( N, searchElement, \*X, strideX, offsetX )

<!-- lint enable maximum-heading-length -->

Returns the first index of an element in a double-precision complex floating-point strided array which is not equal to a specified search element using alternative indexing semantics.

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

const double x[] = { 1.0, 2.0, 1.0, 2.0, 0.0, 0.0, 1.0, 2.0 };
const stdlib_complex128_t searchElement = stdlib_complex128( 1.0, 2.0 );

int idx = stdlib_strided_zindex_of_not_equal_ndarray( 4, searchElement, (const stdlib_complex128_t *)x, 1, 0 );
// returns 2
```

The function accepts the following arguments:

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

```c
CBLAS_INT stdlib_strided_zindex_of_not_equal_ndarray( const CBLAS_INT N, const stdlib_complex128_t searchElement, 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">

</section>

<!-- /.notes -->

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

<section class="examples">

### Examples

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

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

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

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

// Specify a search element:
const stdlib_complex128_t searchElement = stdlib_complex128( 1.0, 2.0 );

// Perform a search:
int idx = stdlib_strided_zindex_of_not_equal( N, searchElement, (const stdlib_complex128_t *)x, strideX );

// Print the result:
printf( "index value: %d\n", idx );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- 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

[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/ctor

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

</section>

<!-- /.links -->
Loading