feat: add support for 'typed' data type kind

kgryte · kgryte · commit 6b9e18f62533 · 2024-02-06T23:33:47.000-08:00
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/README.md b/lib/node_modules/@stdlib/ndarray/dtypes/README.md
@@ -82,6 +82,7 @@ The function supports the following data type kinds:
 -   `unsigned_integer`: unsigned integer data types.
 -   `real`: real-valued data types.
 -   `numeric`: numeric data types.
+-   `typed`: typed data types.
 -   `all`: all data types.
 
 </section>
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/dtypes/docs/repl.txt
@@ -2,23 +2,6 @@
 {{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:
-
-    - binary: binary.
-    - complex64: single-precision complex floating-point numbers.
-    - complex128: double-precision complex floating-point numbers.
-    - float32: single-precision floating-point numbers.
-    - float64: double-precision floating-point numbers.
-    - 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.
-
     The function supports the following data type "kinds":
 
     - floating_point: floating-point data types.
@@ -29,6 +12,7 @@
     - unsigned_integer: unsigned integer data types.
     - real: real-valued data types.
     - numeric: numeric data types.
+    - typed: typed data types.
     - all: all data types.
 
     Parameters
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/index.d.ts
@@ -25,24 +25,6 @@ import { DataType, DataTypeKind } from '@stdlib/types/ndarray';
 /**
 * Returns a list of ndarray data types.
 *
-* ## Notes
-*
-* -   When not provided a data type "kind", the function returns an array containing the following data types:
-*
-*     -   `binary`: binary.
-*     -   `complex64`: single-precision complex floating-point numbers.
-*     -   `complex128`: double-precision complex floating-point numbers.
-*     -   `float32`: single-precision floating-point numbers.
-*     -   `float64`: double-precision floating-point numbers.
-*     -   `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.
-*
 * @param kind - data type kind
 * @returns list of ndarray data types
 *
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/lib/dtypes.json b/lib/node_modules/@stdlib/ndarray/dtypes/lib/dtypes.json
@@ -14,6 +14,20 @@
     "uint8",
     "uint8c"
   ],
+  "typed": [
+    "binary",
+    "complex64",
+    "complex128",
+    "float32",
+    "float64",
+    "int16",
+    "int32",
+    "int8",
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ],
   "floating_point": [
     "complex64",
     "complex128",
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js b/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js
@@ -105,6 +105,30 @@ tape( 'the function supports returning a list of ndarray data types (all)', func
 	t.end();
 });
 
+tape( 'the function supports returning a list of ndarray data types (typed)', function test( t ) {
+	var expected;
+	var actual;
+
+	expected = [
+		'binary',
+		'complex64',
+		'complex128',
+		'float32',
+		'float64',
+		'int16',
+		'int32',
+		'int8',
+		'uint16',
+		'uint32',
+		'uint8',
+		'uint8c'
+	];
+	actual = dtypes( 'typed' );
+
+	t.deepEqual( actual, expected, 'returns expected value' );
+	t.end();
+});
+
 tape( 'the function supports returning a list of floating-point ndarray data types', function test( t ) {
 	var expected;
 	var actual;
