Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -162,6 +162,7 @@
 
 ### Bug Fixes
 
+-   [`3a0b3cc`](https://github.com/stdlib-js/stdlib/commit/3a0b3cc30d966f8739511d4f0cedc73b07376e59) - improve `entries` return type and examples in `array/complex128` types
 -   [`d3b0f25`](https://github.com/stdlib-js/stdlib/commit/d3b0f251b37fdc27cd3a02ac794dddba0b2f7b36) - correct loop bounds in toJSON method for `nested2views`
 -   [`fbc5910`](https://github.com/stdlib-js/stdlib/commit/fbc5910c2290928c2fdc730a6b166b39e637d304) - remove unnecessary loop in toJSON method for entries2views
 -   [`8cdfd62`](https://github.com/stdlib-js/stdlib/commit/8cdfd621717a7a41428526107a42364a921b07ae) - ensure proper cache invalidation
@@ -256,6 +257,7 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+-   [`3a0b3cc`](https://github.com/stdlib-js/stdlib/commit/3a0b3cc30d966f8739511d4f0cedc73b07376e59) - **fix:** improve `entries` return type and examples in `array/complex128` types _(by Philipp Burckhardt)_
 -   [`582ef31`](https://github.com/stdlib-js/stdlib/commit/582ef3182ea40031f2bff23af519b1a7e7952d57) - **refactor:** wrap `blas/ext/base/gjoin` _(by Athan Reines)_
 -   [`5f49874`](https://github.com/stdlib-js/stdlib/commit/5f498740352d6ac14ac7a8df0284e640c21c2f12) - **bench:** refactor to use string interpolation in `array/base/binary3d` [(#8803)](https://github.com/stdlib-js/stdlib/pull/8803) _(by Kate Suraev)_
 -   [`34c2666`](https://github.com/stdlib-js/stdlib/commit/34c2666e48e25c5a508aeae1337f666a3b404684) - **bench:** refactor to use string interpolation in `array/base/binary4d` [(#8804)](https://github.com/stdlib-js/stdlib/pull/8804) _(by Kate Suraev)_

complex128/docs/types/index.d.ts

@@ -312,7 +312,7 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
+	* var buf = new ArrayBuffer( 32 );
 	* var arr = new Complex128Array( buf );
 	* // returns <Complex128Array>
 	*
@@ -322,8 +322,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
-	* var arr = new Complex128Array( buf, 8 );
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new Complex128Array( buf, 16 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -332,8 +332,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 32 );
-	* var arr = new Complex128Array( buf, 8, 2 );
+	* var buf = new ArrayBuffer( 64 );
+	* var arr = new Complex128Array( buf, 16, 2 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -357,8 +357,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* arr.set( [ 1.0, -1.0 ], 0 );
 	* arr.set( [ 9.0, -9.0 ], 9 );
 	*
-	* z = arr.get( -1 )
-	* // return <Complex128>
+	* z = arr.at( -1 );
+	* // returns <Complex128>
 	*
 	* z = arr.at( 100 );
 	* // returns undefined
@@ -489,7 +489,7 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* var bool = it.next().done;
 	* // returns true
 	*/
-	entries(): Iterator;
+	entries(): TypedIterator<[number, Complex128]>;
 
 	/**
 	* Tests whether all elements in an array pass a test implemented by a predicate function.
@@ -728,9 +728,6 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* arr.set( [ 3.0, 3.0 ], 2 );
 	*
 	* arr.forEach( log );
-	* // => 0: 1 + 1i
-	* // => 1: 2 + 2i
-	* // => 2: 3 + 3i
 	*/
 	forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
 
@@ -799,13 +796,13 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* arr.set( [ 2.0, 2.0 ], 3 );
 	* arr.set( [ 5.0, 5.0 ], 4 );
 	*
-	* var idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ) );
+	* var idx = arr.indexOf( new Complex128( 2.0, 2.0 ) );
 	* // returns 1
 	*
-	* idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ), 2 );
+	* idx = arr.indexOf( new Complex128( 2.0, 2.0 ), 2 );
 	* // returns 3
 	*
-	* idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ), -3 );
+	* idx = arr.indexOf( new Complex128( 2.0, 2.0 ), -3 );
 	* // returns 3
 	*/
 	indexOf( searchElement: ComplexLike, fromIndex?: number ): number;
@@ -1592,7 +1589,7 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
+	* var buf = new ArrayBuffer( 32 );
 	* var arr = new Complex128Array( buf );
 	* // returns <Complex128Array>
 	*
@@ -1602,8 +1599,8 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
-	* var arr = new Complex128Array( buf, 8 );
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new Complex128Array( buf, 16 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -1612,8 +1609,8 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 32 );
-	* var arr = new Complex128Array( buf, 8, 2 );
+	* var buf = new ArrayBuffer( 64 );
+	* var arr = new Complex128Array( buf, 16, 2 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -1661,7 +1658,7 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
+	* var buf = new ArrayBuffer( 32 );
 	* var arr = new Complex128Array( buf );
 	* // returns <Complex128Array>
 	*
@@ -1671,8 +1668,8 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
-	* var arr = new Complex128Array( buf, 8 );
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new Complex128Array( buf, 16 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -1681,8 +1678,8 @@ interface Complex128ArrayConstructor {
 	* @example
 	* var ArrayBuffer = require( './../../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 32 );
-	* var arr = new Complex128Array( buf, 8, 2 );
+	* var buf = new ArrayBuffer( 64 );
+	* var arr = new Complex128Array( buf, 16, 2 );
 	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
@@ -1808,7 +1805,7 @@ interface Complex128ArrayConstructor {
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
 *
-* var buf = new ArrayBuffer( 16 );
+* var buf = new ArrayBuffer( 32 );
 * var arr = new Complex128Array( buf );
 * // returns <Complex128Array>
 *
@@ -1818,8 +1815,8 @@ interface Complex128ArrayConstructor {
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
 *
-* var buf = new ArrayBuffer( 16 );
-* var arr = new Complex128Array( buf, 8 );
+* var buf = new ArrayBuffer( 32 );
+* var arr = new Complex128Array( buf, 16 );
 * // returns <Complex128Array>
 *
 * var len = arr.length;
@@ -1828,8 +1825,8 @@ interface Complex128ArrayConstructor {
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
 *
-* var buf = new ArrayBuffer( 32 );
-* var arr = new Complex128Array( buf, 8, 2 );
+* var buf = new ArrayBuffer( 64 );
+* var arr = new Complex128Array( buf, 16, 2 );
 * // returns <Complex128Array>
 *
 * var len = arr.length;
@@ -1841,3 +1838,5 @@ declare var ctor: Complex128ArrayConstructor;
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: Complex128Array