Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,16 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-05-21)
+## Unreleased (2025-05-27)
 
 <section class="features">
 
 ### Features
 
+-   [`138cc36`](https://github.com/stdlib-js/stdlib/commit/138cc36c180a676fc4ae8b675d77d58db8f02f26) - add `Complex64Vector` to namespace
+-   [`50dac78`](https://github.com/stdlib-js/stdlib/commit/50dac7824c40e9cf5c10b0ee576f44fba8b191a5) - add `ndarray/vector/complex64`
+-   [`0431d21`](https://github.com/stdlib-js/stdlib/commit/0431d211467c0ebfa57547a5da66f598870bbf33) - add `Complex128Vector` to namespace
+-   [`0183f29`](https://github.com/stdlib-js/stdlib/commit/0183f293bf9a127899492ad80a87394e8b18afc1) - add `ndarray/vector/complex128`
 -   [`5149a37`](https://github.com/stdlib-js/stdlib/commit/5149a3789bf321b18b1636b838ab086175b6c2ca) - add `ndarray/base/unary-reduce-subarray-by` [(#7008)](https://github.com/stdlib-js/stdlib/pull/7008)
 -   [`54dc71e`](https://github.com/stdlib-js/stdlib/commit/54dc71e0ff4a2b5661d48a1bdee584507f66373f) - add `every` and `includes` to namespace
 -   [`2349a6e`](https://github.com/stdlib-js/stdlib/commit/2349a6edf849f8f7093a77bbdeb2fdd7d9955f89) - add `vector` to namespace
@@ -407,6 +411,11 @@ A total of 15 issues were closed in this release:
 
 <details>
 
+-   [`34f6c88`](https://github.com/stdlib-js/stdlib/commit/34f6c88797418bf412b222450bd1659e43b7a7c1) - **docs:** update namespace table of contents [(#7105)](https://github.com/stdlib-js/stdlib/pull/7105) _(by stdlib-bot)_
+-   [`138cc36`](https://github.com/stdlib-js/stdlib/commit/138cc36c180a676fc4ae8b675d77d58db8f02f26) - **feat:** add `Complex64Vector` to namespace _(by Athan Reines)_
+-   [`50dac78`](https://github.com/stdlib-js/stdlib/commit/50dac7824c40e9cf5c10b0ee576f44fba8b191a5) - **feat:** add `ndarray/vector/complex64` _(by Athan Reines)_
+-   [`0431d21`](https://github.com/stdlib-js/stdlib/commit/0431d211467c0ebfa57547a5da66f598870bbf33) - **feat:** add `Complex128Vector` to namespace _(by Athan Reines)_
+-   [`0183f29`](https://github.com/stdlib-js/stdlib/commit/0183f293bf9a127899492ad80a87394e8b18afc1) - **feat:** add `ndarray/vector/complex128` _(by Athan Reines)_
 -   [`cc20b2d`](https://github.com/stdlib-js/stdlib/commit/cc20b2de446f10e06216b84bdd5457ef473ffdd6) - **refactor:** update require path _(by Athan Reines)_
 -   [`5149a37`](https://github.com/stdlib-js/stdlib/commit/5149a3789bf321b18b1636b838ab086175b6c2ca) - **feat:** add `ndarray/base/unary-reduce-subarray-by` [(#7008)](https://github.com/stdlib-js/stdlib/pull/7008) _(by Muhammad Haris, Athan Reines)_
 -   [`89d9dc3`](https://github.com/stdlib-js/stdlib/commit/89d9dc316985aa3c194222afbf8146e58ff6d761) - **docs:** update namespace table of contents [(#7046)](https://github.com/stdlib-js/stdlib/pull/7046) _(by stdlib-bot)_

CONTRIBUTORS

@@ -167,6 +167,7 @@ Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
 Suhaib Ilahi <[email protected]>
 Suraj Kumar <[email protected]>
+Swapnil Hajare <[email protected]>
 Tanishq Ahuja <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>

vector/README.md

@@ -56,6 +56,8 @@ The namespace exports the following:
 <div class="namespace-toc">
 
 -   <span class="signature">[`BooleanVector()`][@stdlib/ndarray/vector/bool]</span><span class="delimiter">: </span><span class="description">create a boolean vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Complex128Vector()`][@stdlib/ndarray/vector/complex128]</span><span class="delimiter">: </span><span class="description">create a double-precision complex floating-point vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Complex64Vector()`][@stdlib/ndarray/vector/complex64]</span><span class="delimiter">: </span><span class="description">create a single-precision complex floating-point vector (i.e., a one-dimensional ndarray).</span>
 -   <span class="signature">[`vector()`][@stdlib/ndarray/vector/ctor]</span><span class="delimiter">: </span><span class="description">create a vector (i.e., a one-dimensional ndarray).</span>
 -   <span class="signature">[`Float32Vector()`][@stdlib/ndarray/vector/float32]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
 -   <span class="signature">[`Float64Vector()`][@stdlib/ndarray/vector/float64]</span><span class="delimiter">: </span><span class="description">create a double-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
@@ -120,6 +122,10 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/ndarray/tree/main/vector/bool
 
+[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray/tree/main/vector/complex128
+
+[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray/tree/main/vector/complex64
+
 [@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray/tree/main/vector/ctor
 
 [@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray/tree/main/vector/float32

vector/complex128/README.md

@@ -0,0 +1,202 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+# Complex128Vector
+
+> Create a double-precision complex floating-point vector (i.e., a one-dimensional [ndarray][@stdlib/ndarray/ctor]).
+
+<!-- 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 Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
+```
+
+#### Complex128Vector( \[options] )
+
+Returns a one-dimensional double-precision complex floating-point [ndarray][@stdlib/ndarray/ctor].
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Complex128Vector();
+// returns <ndarray>
+
+var len = numel( arr );
+// returns 0
+```
+
+The function accepts the following options:
+
+-   **order**: specifies whether an [ndarray][@stdlib/ndarray/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style). Default: `'row-major'`.
+-   **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
+-   **readonly**: boolean indicating whether an array should be **read-only**. Default: `false`.
+
+#### Complex128Vector( length\[, options] )
+
+Returns a one-dimensional double-precision complex floating-point [ndarray][@stdlib/ndarray/ctor] having a specified `length`.
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Complex128Vector( 5 );
+// returns <ndarray>
+
+var len1 = numel( arr );
+// returns 5
+```
+
+#### Complex128Vector( obj\[, options] )
+
+Creates a one-dimensional double-precision complex floating-point [ndarray][@stdlib/ndarray/ctor] from an array-like object or iterable.
+
+```javascript
+var numel = require( '@stdlib/ndarray/numel' );
+
+var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+// returns <ndarray>
+
+var len1 = numel( arr );
+// returns 3
+```
+
+#### Complex128Vector( buffer\[, byteOffset\[, length]]\[, options] )
+
+Returns a one-dimensional double-precision complex floating-point [ndarray][@stdlib/ndarray/ctor] view of an [`ArrayBuffer`][@stdlib/array/buffer].
+
+```javascript
+var ArrayBuffer = require( '@stdlib/array/buffer' );
+var numel = require( '@stdlib/ndarray/numel' );
+
+var buf = new ArrayBuffer( 64 );
+
+var arr1 = new Complex128Vector( buf );
+// returns <ndarray>
+
+var len1 = numel( arr1 );
+// returns 4
+
+var arr2 = new Complex128Vector( buf, 16 );
+// returns <ndarray>
+
+var len2 = numel( arr2 );
+// returns 3
+
+var arr3 = new Complex128Vector( buf, 16, 1 );
+// returns <ndarray>
+
+var len3 = numel( arr3 );
+// 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">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var sum = require( '@stdlib/blas/ext/sum' );
+var map = require( '@stdlib/ndarray/map' );
+var real = require( '@stdlib/complex/float64/real' );
+var imag = require( '@stdlib/complex/float64/imag' );
+var Complex128 = require( '@stdlib/complex/float64/ctor' );
+var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
+
+// Create a vector containing random values:
+var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) );
+
+// Compute the sum:
+var v = sum( x );
+console.log( v.get() );
+
+// Define a function which applies a threshold to real and imaginary components:
+function threshold( v ) {
+    if ( real( v ) > 10 && imag( v ) > 10 ) {
+        return v;
+    }
+    return new Complex128( 0.0, 0.0 );
+}
+
+// Apply threshold:
+var y = map( x, threshold );
+
+// Recompute the sum:
+v = sum( y );
+console.log( v.get() );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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/buffer]: https://github.com/stdlib-js/array-buffer
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
+
+</section>
+
+<!-- /.links -->

vector/complex128/benchmark/benchmark.js

@@ -0,0 +1,47 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var pkg = require( './../package.json' ).name;
+var Complex128Vector = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = new Complex128Vector( 0 );
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( arr ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});