<!--

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

-->

# szeroTo

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

<section class="usage">

## Usage

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

#### szeroTo( N, x, strideX )

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

```javascript
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );

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

The function has the following parameters:

-   **N**: number of indexed elements.
-   **x**: input [`Float32Array`][@stdlib/array/float32].
-   **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:

```javascript
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

szeroTo( 3, x, 2 );
// x => <Float32Array>[ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ]
```

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

```javascript
var Float32Array = require( '@stdlib/array/float32' );

// Initial array...
var x0 = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

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

// Fill every other element...
szeroTo( 3, x1, 2 );
// x0 => <Float32Array>[ 0.0, 0.0, 0.0, 1.0, 0.0, 2.0 ]
```

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

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

```javascript
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );

szeroTo.ndarray( x.length, x, 1, 0 );
// x => <Float32Array>[ 0.0, 1.0, 2.0, 3.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 Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

szeroTo.ndarray( 3, x, 1, x.length-3 );
// x => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 1.0, 2.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 szeroTo = require( '@stdlib/blas/ext/base/szero-to' );

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'float32'
});
console.log( x );

szeroTo( 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/szero_to.h"
```

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

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

```c
float x[] = { 0.0f, 0.0f, 0.0f, 0.0f };

stdlib_strided_szero_to( 4, x, 1 );
```

The function accepts the following arguments:

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

```c
void API_SUFFIX(stdlib_strided_szero_to)( const CBLAS_INT N, float *X, const CBLAS_INT strideX );
```

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

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

```c
float x[] = { 0.0f, 0.0f, 0.0f, 0.0f };

stdlib_strided_szero_to_ndarray( 4, x, 1, 0 );
```

The function accepts the following arguments:

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

```c
void API_SUFFIX(stdlib_strided_szero_to_ndarray)( const CBLAS_INT N, float *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/szero_to.h"
#include <stdio.h>

int main( void ) {
    // Create a strided array:
    float x[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };

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

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

    // Fill the array:
    stdlib_strided_szero_to( N, x, strideX );

    // Print the result:
    for ( int i = 0; i < 8; i++ ) {
        printf( "x[ %i ] = %f\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/float32]: https://www.npmjs.com/package/@stdlib/array-float32

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

</section>

<!-- /.links -->
