feat: add values method to array/complex64

PR-URL: #1706
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com> 
Signed-off-by: Athan Reines <kgryte@gmail.com>

Author: Jaysukh-409

lib/node_modules/@stdlib/array/complex64/README.md

@@ -798,6 +798,11 @@ var bool = it.next().done;
 // returns true
 ```
 
+The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
+
+-   **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.
+-   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
+
 <a name="method-every"></a>
 
 #### Complex64Array.prototype.every( predicate\[, thisArg] )
@@ -2222,9 +2227,52 @@ var str = arr.toString();
 // returns '1 + 1i,2 - 2i,3 + 3i'
 ```
 
+<a name="method-values"></a>
+
+#### Complex64Array.prototype.values()
+
+Returns an iterator for iterating over each value in a typed array.
+
+```javascript
+var realf = require( '@stdlib/complex/realf' );
+var imagf = require( '@stdlib/complex/imagf' );
+var arr = new Complex64Array( 2 );
+
+arr.set( [ 1.0, -1.0 ], 0 );
+arr.set( [ 2.0, -2.0 ], 1 );
+
+var iter = arr.values();
+
+var v = iter.next().value;
+// returns <Complex64>
+
+var re = realf( v );
+// returns 1.0
+
+var im = imagf( v );
+// returns -1.0
+
+v = iter.next().value;
+// returns <Complex64>
+
+re = realf( v );
+// returns 2.0
+
+im = imagf( v );
+// returns -2.0
+
+var bool = iter.next().done;
+// returns true
+```
+
+The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
+
+-   **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.
+-   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
+
 <a name="method-with"></a>
 
-#### Complex128Array.prototype.with( index, value )
+#### Complex64Array.prototype.with( index, value )
 
 Returns a new typed array with the element at a provided index replaced with a provided value.
 
@@ -2352,6 +2400,8 @@ logEach( '%s', out );
 
 <section class="links">
 
+[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
+
 [@stdlib/array/typed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed
 
 [@stdlib/array/buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/buffer

lib/node_modules/@stdlib/array/complex64/benchmark/benchmark.values.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':values:len=2', function benchmark( b ) {
+	var iter;
+	var arr;
+	var i;
+
+	arr = new Complex64Array( [ 1.0, -1.0, 2.0, -2.0 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		iter = arr.values();
+		if ( typeof iter !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isIteratorLike( iter ) ) {
+		b.fail( 'should return an iterator protocol-compliant object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/array/complex64/benchmark/benchmark.values.length.js

@@ -0,0 +1,103 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 pow = require( '@stdlib/math/base/special/pow' );
+var Complex64 = require( '@stdlib/complex/float32' );
+var isIteratorLike = require('@stdlib/assert/is-iterator-like');
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr;
+	var i;
+
+	arr = [];
+	for ( i = 0; i < len; i++ ) {
+		arr.push( new Complex64( i, i ) );
+	}
+	arr = new Complex64Array( arr );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var iter;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			iter = arr.values();
+			if ( typeof iter !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isIteratorLike( iter ) ) {
+			b.fail( 'should return an iterator protocol-compliant object' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':values:len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts

@@ -22,7 +22,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+import { Iterator as Iter, IterableIterator, TypedIterator } from '@stdlib/types/iter';
 import { ArrayLike, RealOrComplexTypedArray, Complex64Array as Complex64ArrayInterface } from '@stdlib/types/array';
 import { ComplexLike, Complex64 } from '@stdlib/types/complex';
 import ArrayBuffer = require( '@stdlib/array/buffer' );
@@ -459,7 +459,7 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* var bool = it.next().done;
 	* // returns true
 	*/
-	entries(): Iterator;
+	entries(): TypedIterator<[number, Complex64]>;
 
 	/**
 	* Tests whether all elements in an array pass a test implemented by a predicate function.
@@ -1260,6 +1260,44 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	*/
 	toString(): string;
 
+	/**
+	* Returns an iterator for iterating over each value in a typed array.
+	*
+	* @returns iterator
+	*
+	* @example
+	* var realf = require( '@stdlib/complex/realf' );
+	* var imagf = require( '@stdlib/complex/imagf' );
+	* var arr = new Complex64Array( 2 );
+	*
+	* arr.set( [ 1.0, -1.0 ], 0 );
+	* arr.set( [ 2.0, -2.0 ], 1 );
+	*
+	* var iter = arr.values();
+	*
+	* var v = iter.next().value;
+	* // returns <Complex64>
+	*
+	* var re = realf( v );
+	* // returns 1.0
+	*
+	* var im = imagf( v );
+	* // returns -1.0
+	*
+	* v = iter.next().value;
+	* // returns <Complex64>
+	*
+	* re = realf( v );
+	* // returns 2.0
+	*
+	* im = imagf( v );
+	* // returns -2.0
+	*
+	* var bool = iter.next().done;
+	* // returns true
+	*/
+	values(): TypedIterator<Complex64>;
+
 	/**
 	* Returns a new typed array with the element at a provided index replaced with a provided value.
 	*