Auto-generated commit

dtypes/README.md

@@ -40,7 +40,7 @@ limitations under the License.
 var dtypes = require( '@stdlib/array/dtypes' );
 ```
 
-#### dtypes()
+#### dtypes( \[kind] )
 
 Returns a list of array data types.
 
@@ -49,7 +49,7 @@ var out = dtypes();
 // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
 ```
 
-The output `array` contains the following 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.
@@ -64,6 +64,25 @@ The output `array` contains the following data types:
 -   `uint8`: unsigned 8-bit integers.
 -   `uint8c`: unsigned clamped 8-bit integers.
 
+To return the subset of data types belonging to a specified data type kind, provide a `kind` argument.
+
+```javascript
+var out = dtypes( 'floating_point' );
+// returns [...]
+```
+
+The function supports the following data type kinds:
+
+-   `floating_point`: floating-point data types.
+-   `real_floating_point`: real-valued floating-point data types.
+-   `complex_floating_point`: complex-valued floating-point data types.
+-   `integer`: integer data types.
+-   `signed_integer`: signed integer data types.
+-   `unsigned_integer`: unsigned integer data types.
+-   `real`: real-valued data types.
+-   `numeric`: numeric data types.
+-   `all`: all data types.
+
 </section>
 
 <!-- /.usage -->
@@ -89,7 +108,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
 var dtypes = require( '@stdlib/array/dtypes' );
 
 var DTYPES = dtypes();
-var bool;
 
 function isdtype( str ) {
     if ( indexOf( DTYPES, str ) === -1 ) {
@@ -98,7 +116,7 @@ function isdtype( str ) {
     return true;
 }
 
-bool = isdtype( 'float64' );
+var bool = isdtype( 'float64' );
 // returns true
 
 bool = isdtype( 'int16' );

dtypes/benchmark/benchmark.js

@@ -35,8 +35,33 @@ bench( pkg, function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = dtypes();
-		if ( out.length !== 10 ) {
-			b.fail( 'should return an array of length 10' );
+		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();
+});
+
+bench( pkg+'::kind', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'floating_point',
+		'integer'
+	];
+
+	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();

dtypes/docs/repl.txt

@@ -1,8 +1,9 @@
 
-{{alias}}()
+{{alias}}( [kind] )
     Returns a list of array data types.
 
-    The output array contains the following 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.
@@ -17,6 +18,23 @@
     - 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.
+    - real_floating_point: real-valued floating-point data types.
+    - complex_floating_point: complex-valued floating-point data types.
+    - integer: integer data types.
+    - signed_integer: signed integer data types.
+    - unsigned_integer: unsigned integer data types.
+    - real: real-valued data types.
+    - numeric: numeric data types.
+    - all: all data types.
+
+    Parameters
+    ----------
+    kind: string (optional)
+        Data type kind.
+
     Returns
     -------
     out: Array<string>
@@ -26,6 +44,8 @@
     --------
     > var out = {{alias}}()
     <Array>
+    > out = {{alias}}( 'floating_point' )
+    <Array>
 
     See Also
     --------

dtypes/docs/types/index.d.ts

@@ -20,18 +20,23 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { DataType } from '@stdlib/types/array';
+import { DataType, DataTypeKind } from '@stdlib/types/array';
 
 /**
 * Returns a list of array data types.
 *
+* @param kind - data type kind
 * @returns list of array data types
 *
 * @example
 * var list = dtypes();
 * // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
+*
+* @example
+* var list = dtypes( 'floating_point' );
+* // returns [...]
 */
-declare function dtypes(): Array<DataType>;
+declare function dtypes( kind?: DataTypeKind ): Array<DataType>;
 
 
 // EXPORTS //

dtypes/docs/types/test.ts

@@ -24,10 +24,10 @@ import dtypes = require( './index' );
 // The function returns an array of data types...
 {
 	dtypes(); // $ExpectType DataType[]
+	dtypes( 'floating_point' ); // $ExpectType DataType[]
 }
 
-// The compiler throws an error if the function is provided arguments...
+// The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	dtypes( 1 ); // $ExpectError
-	dtypes( 1, 2 ); // $ExpectError
+	dtypes( 'floating_point', 2 ); // $ExpectError
 }

dtypes/examples/index.js

@@ -22,7 +22,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
 var dtypes = require( './../lib' );
 
 var DTYPES = dtypes();
-var bool;
 
 function isdtype( str ) {
 	if ( indexOf( DTYPES, str ) === -1 ) {
@@ -31,7 +30,7 @@ function isdtype( str ) {
 	return true;
 }
 
-bool = isdtype( 'float64' );
+var bool = isdtype( 'float64' );
 console.log( bool );
 // => true
 

dtypes/lib/dtypes.json

@@ -1,14 +1,74 @@
-[
-	"float32",
-	"float64",
-	"generic",
-	"int16",
-	"int32",
-	"int8",
-	"uint16",
-	"uint32",
-	"uint8",
-	"uint8c",
-  "complex64",
-  "complex128"
-]
+{
+  "all": [
+    "complex64",
+    "complex128",
+    "float32",
+    "float64",
+    "generic",
+    "int16",
+    "int32",
+    "int8",
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ],
+  "floating_point": [
+    "complex64",
+    "complex128",
+    "float32",
+    "float64"
+  ],
+  "real_floating_point": [
+    "float32",
+    "float64"
+  ],
+  "complex_floating_point": [
+    "complex64",
+    "complex128"
+  ],
+  "integer": [
+    "int16",
+    "int32",
+    "int8",
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ],
+  "signed_integer": [
+    "int16",
+    "int32",
+    "int8"
+  ],
+  "unsigned_integer": [
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ],
+  "real": [
+    "float32",
+    "float64",
+    "int16",
+    "int32",
+    "int8",
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ],
+  "numeric": [
+    "complex64",
+    "complex128",
+    "float32",
+    "float64",
+    "int16",
+    "int32",
+    "int8",
+    "uint16",
+    "uint32",
+    "uint8",
+    "uint8c"
+  ]
+}

dtypes/lib/main.js

@@ -28,14 +28,24 @@ var DTYPES = require( './dtypes.json' );
 /**
 * Returns a list of array data types.
 *
+* @param {string} [kind] - data type kind
 * @returns {StringArray} list of array data types
 *
 * @example
 * var list = dtypes();
 * // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
+*
+* @example
+* var list = dtypes( 'floating_point' );
+* // returns [...]
 */
 function dtypes() {
-	return DTYPES.slice();
+	var out;
+	if ( arguments.length === 0 ) {
+		return DTYPES.all.slice();
+	}
+	out = DTYPES[ arguments[ 0 ] ];
+	return ( out ) ? out.slice() : [];
 }