stdlib-js · kgryte · Apr 22, 2026 · Apr 22, 2026
diff --git a/lib/node_modules/@stdlib/blas/ext/base/zunitspace/README.md b/lib/node_modules/@stdlib/blas/ext/base/zunitspace/README.md
@@ -0,0 +1,310 @@
+<!--
+
+@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.
+
+-->
+
+# zunitspace
+
+> Fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zunitspace = require( '@stdlib/blas/ext/base/zunitspace' );
+```
+
+#### zunitspace( N, start, x, strideX )
+
+Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+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 ] );
+
+zunitspace( x.length, new Complex128( 3.0, 0.0 ), x, 1 );
+// x => <Complex128Array>[ 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ]
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **start**: starting [`Complex128`][@stdlib/complex/float64/ctor] value.
+-   **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 Complex128 = require( '@stdlib/complex/float64/ctor' );
+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 ] );
+
+zunitspace( 3, new Complex128( 3.0, 0.0 ), x, 2 );
+// x => <Complex128Array>[ 3.0, 0.0, 3.0, 4.0, 4.0, 0.0, 7.0, 8.0, 5.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 Complex128 = require( '@stdlib/complex/float64/ctor' );
+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...
+zunitspace( 3, new Complex128( 3.0, 0.0 ), x1, 2 );
+// x0 => <Complex128Array>[ 1.0, 2.0, 3.0, 0.0, 5.0, 6.0, 4.0, 0.0, 9.0, 10.0, 5.0, 0.0 ]
+```
+
+#### zunitspace.ndarray( N, start, x, strideX, offsetX )
+
+Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value using alternative indexing semantics.
+
+```javascript
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+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 ] );
+
+zunitspace.ndarray( x.length, new Complex128( 3.0, 0.0 ), x, 1, 0 );
+// x => <Complex128Array>[ 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.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 Complex128 = require( '@stdlib/complex/float64/ctor' );
+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 ] );
+
+zunitspace.ndarray( 3, new Complex128( 3.0, 0.0 ), x, 1, x.length-3 );
+// x => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 3.0, 0.0, 4.0, 0.0, 5.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 Complex128 = require( '@stdlib/complex/float64/ctor' );
+var zunitspace = require( '@stdlib/blas/ext/base/zunitspace' );
+
+var xbuf = discreteUniform( 20, -100, 100, {
+    'dtype': 'float64'
+});
+var x = new Complex128Array( xbuf.buffer );
+console.log( x );
+
+zunitspace( x.length, new Complex128( 3.0, 0.0 ), 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/zunitspace.h"
+```
+
+#### stdlib_strided_zunitspace( N, start, \*X, strideX )
+
+Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.
+
+```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 };
+
+const stdlib_complex128_t start = stdlib_complex128( 3.0, 0.0 );
+
+stdlib_strided_zunitspace( 4, start, (stdlib_complex128_t *)x, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **start**: `[in] stdlib_complex128_t` starting value.
+-   **X**: `[out] stdlib_complex128_t*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length.
+
+```c
+void API_SUFFIX(stdlib_strided_zunitspace)( const CBLAS_INT N, const stdlib_complex128_t start, stdlib_complex128_t *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_zunitspace_ndarray( N, start, \*X, strideX, offsetX )
+
+Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value 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 };
+
+const stdlib_complex128_t start = stdlib_complex128( 3.0, 0.0 );
+
+stdlib_strided_zunitspace_ndarray( 4, start, (stdlib_complex128_t *)x, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **start**: `[in] stdlib_complex128_t` starting value.
+-   **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_zunitspace_ndarray)( const CBLAS_INT N, const stdlib_complex128_t start, 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/zunitspace.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;
+
+    // Specify a starting value:
+    const stdlib_complex128_t start = stdlib_complex128( 3.0, 0.0 );
+
+    // Fill the array:
+    stdlib_strided_zunitspace( N, start, (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
+
+[@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 -->