Auto-generated commit

stdlib-bot · stdlib-bot · commit 119271f93572 · 2026-05-10T11:16:44.000Z
diff --git a/.gitignore b/.gitignore
@@ -25,6 +25,7 @@ package.json.copy
 ###############
 build/
 downloads/
+plans/
 reports/
 tmp/
 
@@ -175,6 +176,10 @@ acs-*.bib
 *.ind
 *.ist
 
+# Git #
+#######
+.worktrees
+
 # Visual Studio #
 #################
 .vscode/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,14 +4,15 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2026-04-17)
+## Unreleased (2026-05-10)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`1674c38`](https://github.com/stdlib-js/stdlib/commit/1674c3865eca607df401b7ccebea4873fba422c0) - **docs:** improve doctests for complex number typed arrays in `ndarray/filter-map` [(#12042)](https://github.com/stdlib-js/stdlib/pull/12042) _(by Karan Anand)_
 -   [`6d6b9d4`](https://github.com/stdlib-js/stdlib/commit/6d6b9d42d8904ca49fb55e2ca464780573886aa0) - **bench:** refactor to use string interpolation in `@stdlib/ndarray` [(#11446)](https:-/github.com/stdlib-js/stdlib/pull/11446) _(by Karan Anand)_
 
 </details>
diff --git a/README.md b/README.md
@@ -216,7 +216,7 @@ The callback function is provided the following arguments:
         'dtype': 'complex128'
     };
     var y = filterMap( x, opts, fcn );
-    // returns <ndarray>
+    // returns <ndarray>[ <Complex128>[ 8.0, 0.0 ], <Complex128>[ 9.0, 0.0 ], <Complex128>[ 10.0, 0.0 ] ]
     ```
 
 -   If a provided callback function returns `undefined`, the function skips the respective [ndarray][@stdlib/ndarray/ctor] element. If the callback function returns a value other than `undefined`, the function stores the callback's return value in the output [ndarray][@stdlib/ndarray/ctor].
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -382,7 +382,7 @@ declare function filterMap<V = unknown>( x: float32ndarray, fcn: Callback<number
 * // returns <ndarray>
 *
 * var y = filterMap( x, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex64>[ 7.0, 8.0 ], <Complex64>[ 9.0, 10.0 ], <Complex64>[ 11.0, 12.0 ] ]
 */
 declare function filterMap<V = unknown>( x: complex64ndarray, fcn: Callback<Complex64, ComplexLike, V>, thisArg?: ThisParameterType<Callback<Complex64, ComplexLike, V>> ): complex64ndarray;
 
@@ -413,7 +413,7 @@ declare function filterMap<V = unknown>( x: complex64ndarray, fcn: Callback<Comp
 * // returns <ndarray>
 *
 * var y = filterMap( x, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex128>[ 7.0, 8.0 ], <Complex128>[ 9.0, 10.0 ], <Complex128>[ 11.0, 12.0 ] ]
 */
 declare function filterMap<V = unknown>( x: complex128ndarray, fcn: Callback<Complex128, ComplexLike, V>, thisArg?: ThisParameterType<Callback<Complex128, ComplexLike, V>> ): complex128ndarray;
 
@@ -799,7 +799,7 @@ declare function filterMap<V = unknown>( x: float32ndarray, options: OrderOption
 *     'order': 'row-major'
 * };
 * var y = filterMap( x, opts, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex64>[ 7.0, 8.0 ], <Complex64>[ 9.0, 10.0 ], <Complex64>[ 11.0, 12.0 ] ]
 */
 declare function filterMap<V = unknown>( x: complex64ndarray, options: OrderOptions, fcn: Callback<Complex64, ComplexLike, V>, thisArg?: ThisParameterType<Callback<Complex64, ComplexLike, V>> ): complex64ndarray;
 
@@ -835,7 +835,7 @@ declare function filterMap<V = unknown>( x: complex64ndarray, options: OrderOpti
 *     'order': 'row-major'
 * };
 * var y = filterMap( x, opts, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex128>[ 7.0, 8.0 ], <Complex128>[ 9.0, 10.0 ], <Complex128>[ 11.0, 12.0 ] ]
 */
 declare function filterMap<V = unknown>( x: complex128ndarray, options: OrderOptions, fcn: Callback<Complex128, ComplexLike, V>, thisArg?: ThisParameterType<Callback<Complex128, ComplexLike, V>> ): complex128ndarray;
 
@@ -1270,7 +1270,7 @@ declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarr
 *     'dtype': 'complex128'
 * };
 * var y = filterMap( x, opts, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex128>[ 8.0, 0.0 ], <Complex128>[ 9.0, 0.0 ], <Complex128>[ 10.0, 0.0 ] ]
 */
 declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarray<T>, options: Complex128Options, fcn: Callback<T, U, V>, thisArg?: ThisParameterType<Callback<T, U, V>> ): complex128ndarray;
 
@@ -1288,7 +1288,7 @@ declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarr
 * @example
 * var Float64Array = require( '@stdlib/array-float64' );
 * var ndarray = require( '@stdlib/ndarray-ctor' );
-* var Complex64 = require( '@stdlib/complex-float64-ctor' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
 *
 * function fcn( z, idx ) {
 *     if ( idx[ 0 ] > 0 ) {
@@ -1308,7 +1308,7 @@ declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarr
 *     'dtype': 'complex64'
 * };
 * var y = filterMap( x, opts, fcn );
-* // returns <ndarray>
+* // returns <ndarray>[ <Complex64>[ 8.0, 0.0 ], <Complex64>[ 9.0, 0.0 ], <Complex64>[ 10.0, 0.0 ] ]
 */
 declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarray<T>, options: Complex64Options, fcn: Callback<T, U, V>, thisArg?: ThisParameterType<Callback<T, U, V>> ): complex64ndarray;
 
