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

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

-->

# zzeroTo

> Fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.

<section class="usage">

## Usage

```javascript
var zzeroTo = require( '@stdlib/blas/ext/base/zzero-to' );
```

#### zzeroTo( N, x, strideX )

Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.

```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 ] );

zzeroTo( x.length, x, 1 );
// x => <Complex128Array>[ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]
```

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 fill every other element:

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

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

var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

zzeroTo( 3, x, 2 );
// x => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 1.0, 0.0, 7.0, 8.0, 2.0, 0.0, 11.0, 12.0 ]
```

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

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

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

// Initial array...
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

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

// Fill every other element...
zzeroTo( 3, x1, 2 );
// x0 => <Complex128Array>[ 1.0, 2.0, 0.0, 0.0, 5.0, 6.0, 1.0, 0.0, 9.0, 10.0, 2.0, 0.0 ]
```

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

Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero using alternative indexing semantics.

```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 ] );

zzeroTo.ndarray( x.length, x, 1, 0 );
// x => <Complex128Array>[ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 3.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:

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

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

var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

zzeroTo.ndarray( 3, x, 1, x.length-3 );
// x => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ]
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N <= 0`, both functions return `x` unchanged.

</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 zzeroTo = require( '@stdlib/blas/ext/base/zzero-to' );

var xbuf = discreteUniform( 20, -100, 100, {
'dtype': 'float64'
});
var x = new Complex128Array( xbuf.buffer );
console.log( x );

zzeroTo( x.length, x, 1 );
console.log( 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/zzero_to.h"
```

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

Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.

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

double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };

stdlib_strided_zzero_to( 4, (stdlib_complex128_t *)x, 1 );
```

The function accepts the following arguments:

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

```c
void API_SUFFIX(stdlib_strided_zzero_to)( const CBLAS_INT N, stdlib_complex128_t *X, const CBLAS_INT strideX );
```

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

Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero using alternative indexing semantics.

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

double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };

stdlib_strided_zzero_to_ndarray( 4, (stdlib_complex128_t *)x, 1, 0 );
```

The function accepts the following arguments:

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

```c
void API_SUFFIX(stdlib_strided_zzero_to_ndarray)( const CBLAS_INT N, 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/zzero_to.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, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };

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

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

// Fill the array:
stdlib_strided_zzero_to( N, (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

</section>

<!-- /.links -->
Loading