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
337 changes: 337 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/zfill-not-equal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,337 @@
<!--

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

-->

# zfillNotEqual

> Replace double-precision complex floating-point strided array elements not equal to a provided search element with a specified scalar constant.

<section class="usage">

## Usage

```javascript
var zfillNotEqual = require( '@stdlib/blas/ext/base/zfill-not-equal' );
```

#### zfillNotEqual( N, searchElement, alpha, x, strideX )

Replaces double-precision complex floating-point strided array elements not equal to a provided search element with a specified scalar constant.

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

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

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

zfillNotEqual( x.length, searchElement, alpha, x, 1 );
// x => <Complex128Array>[ 5.0, 5.0, 0.0, 0.0, 5.0, 5.0, 0.0, 0.0 ]
```

The function has the following parameters:

- **N**: number of indexed elements.
- **searchElement**: search element.
- **alpha**: scalar constant.
- **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 iterate over 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, 3.0, 4.0, 0.0, 0.0, 5.0, 6.0 ] );

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

zfillNotEqual( 2, searchElement, alpha, x, 2 );
// x => <Complex128Array>[ 5.0, 5.0, 3.0, 4.0, 0.0, 0.0, 5.0, 6.0 ]
```

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, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] );

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

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

// Iterate over the view:
zfillNotEqual( 3, searchElement, alpha, x1, 1 );
// x0 => <Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 5.0, 0.0, 0.0 ]
```

#### zfillNotEqual.ndarray( N, searchElement, alpha, x, strideX, offsetX )

Replaces strided array elements not equal to a provided search element with a specified scalar constant using alternative indexing semantics.

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

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

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

zfillNotEqual.ndarray( x.length, searchElement, alpha, x, 1, 0 );
// x => <Complex128Array>[ 5.0, 5.0, 0.0, 0.0, 5.0, 5.0, 0.0, 0.0 ]
```

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:

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

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

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

zfillNotEqual.ndarray( 3, searchElement, alpha, x, 1, x.length-3 );
// x => <Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 5.0, 0.0, 0.0 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N <= 0`, both functions return the strided array unchanged.
- When comparing elements, both functions check for equality of real and imaginary components using the strict equality operator `===`. As a consequence, `NaN` components are considered distinct (i.e., as `NaN !== NaN` always evaluates to `true`, elements having one or more `NaN` components are always replaced), and `-0` and `+0` are considered the same.

</section>

<!-- /.notes -->

<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 zfillNotEqual = require( '@stdlib/blas/ext/base/zfill-not-equal' );

var xbuf = discreteUniform( 20, 0, 3, {
'dtype': 'float64'
});
var x = new Complex128Array( xbuf.buffer );

var searchElement = new Complex128( 0.0, 0.0 );
var alpha = new Complex128( 5.0, 5.0 );

zfillNotEqual( x.length, searchElement, alpha, x, 1 );
logEach( '%s', x );
```

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

#### stdlib_strided_zfill_not_equal( N, searchElement, alpha, \*X, strideX )

Replaces double-precision complex floating-point strided array elements not equal to a provided search element with a specified scalar constant.

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

double x[] = { 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 };

const stdlib_complex128_t searchElement = stdlib_complex128( 0.0, 0.0 );
const stdlib_complex128_t alpha = stdlib_complex128( 5.0, 5.0 );

stdlib_strided_zfill_not_equal( 4, searchElement, alpha, (stdlib_complex128_t *)x, 1 );
```

The function accepts the following arguments:

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

```c
void stdlib_strided_zfill_not_equal( const CBLAS_INT N, const stdlib_complex128_t searchElement, const stdlib_complex128_t alpha, stdlib_complex128_t *X, const CBLAS_INT strideX );
```

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

#### stdlib_strided_zfill_not_equal_ndarray( N, searchElement, alpha, \*X, strideX, offsetX )

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

Replaces double-precision complex floating-point strided array elements not equal to a provided search element with a specified scalar constant using alternative indexing semantics.

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

double x[] = { 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 };

const stdlib_complex128_t searchElement = stdlib_complex128( 0.0, 0.0 );
const stdlib_complex128_t alpha = stdlib_complex128( 5.0, 5.0 );

stdlib_strided_zfill_not_equal_ndarray( 4, searchElement, alpha, (stdlib_complex128_t *)x, 1, 0 );
```

The function accepts the following arguments:

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

```c
void stdlib_strided_zfill_not_equal_ndarray( const CBLAS_INT N, const stdlib_complex128_t searchElement, const stdlib_complex128_t alpha, 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/zfill_not_equal.h"
#include "stdlib/complex/float64/ctor.h"
#include <stdio.h>

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

// Create a complex search element:
const stdlib_complex128_t searchElement = stdlib_complex128( 0.0, 0.0 );

// Create a complex scalar constant:
const stdlib_complex128_t alpha = stdlib_complex128( 5.0, 5.0 );

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

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

// Replace elements not equal to `0.0 + 0.0i`:
stdlib_strided_zfill_not_equal( N, searchElement, alpha, (stdlib_complex128_t *)x, strideX );

// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "x[ %i ] = %lf\n", i, x[ i ] );
}
}
```

</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 -->
Loading