Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -404,6 +404,7 @@
 
 ##### Features
 
+-   [`d06165b`](https://github.com/stdlib-js/stdlib/commit/d06165bd6c491b4ad19bc2577be76cff083eda98) - add support for extending data type kind subsets with a \"generic\" data type
 -   [`16e0808`](https://github.com/stdlib-js/stdlib/commit/16e0808004b7bd4f16eea7eced5229ee1120b577) - add boolean dtype support to `ndarray/dtypes` [(#2550)](https://github.com/stdlib-js/stdlib/pull/2550)
 -   [`6b9e18f`](https://github.com/stdlib-js/stdlib/commit/6b9e18f625337d030eb3cd2001934696ef05bfc2) - add support for 'typed' data type kind
 
@@ -738,6 +739,7 @@ A total of 4 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`d06165b`](https://github.com/stdlib-js/stdlib/commit/d06165bd6c491b4ad19bc2577be76cff083eda98) - **feat:** add support for extending data type kind subsets with a \"generic\" data type _(by Athan Reines)_
 -   [`6ea880c`](https://github.com/stdlib-js/stdlib/commit/6ea880ccabbf770cf13a2def4f9ce806daa2b2f6) - **feat:** add boolean dtype support to `ndarray/base/assign` [(#2598)](https://github.com/stdlib-js/stdlib/pull/2598) _(by Jaysukh Makvana, Athan Reines)_
 -   [`903c51c`](https://github.com/stdlib-js/stdlib/commit/903c51c7d0a06d9186a6f2be1b01fa25f770a3eb) - **test:** add tests to `@stdlib/ndarray/base/nullary` [(#2350)](https://github.com/stdlib-js/stdlib/pull/2350) _(by Muhammad Haris, Athan Reines)_
 -   [`de17de3`](https://github.com/stdlib-js/stdlib/commit/de17de32867461079aae166d5cecbecb1da7f922) - **feat:** update namespace TypeScript declarations [(#2593)](https://github.com/stdlib-js/stdlib/pull/2593) _(by stdlib-bot, Athan Reines)_

dtypes/README.md

@@ -87,6 +87,13 @@ The function supports the following data type kinds:
 -   `typed`: typed data types.
 -   `all`: all data types.
 
+Additionally, the function supports extending the "kinds" listed above by appending an `_and_generic` suffix to the kind name (e.g., `real_and_generic`).
+
+```javascript
+var out = dtypes( 'floating_point_and_generic' );
+// returns [...]
+```
+
 </section>
 
 <!-- /.usage -->

dtypes/benchmark/benchmark.js

@@ -71,3 +71,29 @@ bench( pkg+'::kind', function benchmark( b ) {
 	b.pass( 'benchmark finished' );
 	b.end();
 });
+
+bench( pkg+'::kind,generic', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'floating_point_and_generic',
+		'integer_and_generic',
+		'boolean_and_generic'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = dtypes( values[ i%values.length ] );
+		if ( out.length === 0 ) {
+			b.fail( 'should return a non-empty array' );
+		}
+	}
+	b.toc();
+	if ( !isStringArray( out ) ) {
+		b.fail( 'should return an array of strings' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

dtypes/docs/repl.txt

@@ -2,6 +2,24 @@
 {{alias}}( [kind] )
     Returns a list of ndarray data types.
 
+    When not provided a data type "kind", the function returns an array
+    containing the following data types:
+
+    - float32: single-precision floating-point numbers.
+    - float64: double-precision floating-point numbers.
+    - complex64: single-precision complex floating-point numbers.
+    - complex128: double-precision complex floating-point numbers.
+    - bool: boolean values.
+    - generic: values of any type.
+    - int16: signed 16-bit integers.
+    - int32: signed 32-bit integers.
+    - int8: signed 8-bit integers.
+    - uint16: unsigned 16-bit integers.
+    - uint32: unsigned 32-bit integers.
+    - uint8: unsigned 8-bit integers.
+    - uint8c: unsigned clamped 8-bit integers.
+    - binary: binary.
+
     The function supports the following data type "kinds":
 
     - floating_point: floating-point data types.
@@ -16,6 +34,9 @@
     - typed: typed data types.
     - all: all data types.
 
+    Additionally, the function supports extending the "kinds" listed above by
+    appending a '_and_generic' suffix to the kind name (e.g., real_and_generic).
+
     Parameters
     ----------
     kind: string (optional)
@@ -29,9 +50,11 @@
     Examples
     --------
     > var out = {{alias}}()
-    <Array>
+    [...]
     > out = {{alias}}( 'floating_point' )
-    <Array>
+    [...]
+    > out = {{alias}}( 'floating_point_and_generic' )
+    [...]
 
     See Also
     --------

dtypes/docs/types/test.ts

@@ -25,6 +25,7 @@ import dtypes = require( './index' );
 {
 	dtypes(); // $ExpectType DataType[]
 	dtypes( 'floating_point' ); // $ExpectType DataType[]
+	dtypes( 'floating_point_and_generic' ); // $ExpectType DataType[]
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...

dtypes/lib/main.js

@@ -20,9 +20,15 @@
 
 // MODULES //
 
+var replace = require( '@stdlib/string/base/replace' );
 var DTYPES = require( './dtypes.json' );
 
 
+// VARIABLES //
+
+var RE_SUFFIX = /_and_generic$/;
+
+
 // MAIN //
 
 /**
@@ -40,12 +46,26 @@ var DTYPES = require( './dtypes.json' );
 * // returns [...]
 */
 function dtypes() {
+	var kind;
 	var out;
+	var FLG;
 	if ( arguments.length === 0 ) {
 		return DTYPES.all.slice();
 	}
-	out = DTYPES[ arguments[ 0 ] ];
-	return ( out ) ? out.slice() : [];
+	FLG = false;
+	kind = arguments[ 0 ];
+	if ( RE_SUFFIX.test( kind ) ) {
+		kind = replace( kind, RE_SUFFIX, '' );
+		if ( kind !== 'all' ) {
+			FLG = true;
+		}
+	}
+	out = DTYPES[ kind ];
+	out = ( out ) ? out.slice() : [];
+	if ( FLG && out.length > 0 ) {
+		out.push( 'generic' );
+	}
+	return out;
 }