Skip to content

Commit a2c3eb0

Browse files
kgrytekgryte
committed
feat: add support for returning data type subsets according to a kind argument
1 parent e90a075 commit a2c3eb0

File tree

9 files changed

+334
-30
lines changed

9 files changed

+334
-30
lines changed

‎lib/node_modules/@stdlib/array/dtypes/README.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ limitations under the License.
4040
var dtypes = require( '@stdlib/array/dtypes' );
4141
```
4242

43-
#### dtypes()
43+
#### dtypes( \[kind] )
4444

4545
Returns a list of array data types.
4646

@@ -49,7 +49,7 @@ var out = dtypes();
4949
// e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
5050
```
5151

52-
The output `array` contains the following data types:
52+
When not provided a data type "kind", the function returns an array containing the following data types:
5353

5454
- `float32`: single-precision floating-point numbers.
5555
- `float64`: double-precision floating-point numbers.
@@ -64,6 +64,25 @@ The output `array` contains the following data types:
6464
- `uint8`: unsigned 8-bit integers.
6565
- `uint8c`: unsigned clamped 8-bit integers.
6666

67+
To return the subset of data types belonging to a specified data type kind, provide a `kind` argument.
68+
69+
```javascript
70+
var out = dtypes( 'floating_point' );
71+
// returns [...]
72+
```
73+
74+
The function supports the following data type kinds:
75+
76+
- `floating_point`: floating-point data types.
77+
- `real_floating_point`: real-valued floating-point data types.
78+
- `complex_floating_point`: complex-valued floating-point data types.
79+
- `integer`: integer data types.
80+
- `signed_integer`: signed integer data types.
81+
- `unsigned_integer`: unsigned integer data types.
82+
- `real`: real-valued data types.
83+
- `numeric`: numeric data types.
84+
- `all`: all data types.
85+
6786
</section>
6887

6988
<!-- /.usage -->
@@ -89,7 +108,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
89108
var dtypes = require( '@stdlib/array/dtypes' );
90109

91110
var DTYPES = dtypes();
92-
var bool;
93111

94112
function isdtype( str ) {
95113
if ( indexOf( DTYPES, str ) === -1 ) {
@@ -98,7 +116,7 @@ function isdtype( str ) {
98116
return true;
99117
}
100118

101-
bool = isdtype( 'float64' );
119+
var bool = isdtype( 'float64' );
102120
// returns true
103121

104122
bool = isdtype( 'int16' );

‎lib/node_modules/@stdlib/array/dtypes/benchmark/benchmark.js‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,28 @@ bench( pkg, function benchmark( b ) {
4646
b.pass( 'benchmark finished' );
4747
b.end();
4848
});
49+
50+
bench( pkg+'::kind', function benchmark( b ) {
51+
var values;
52+
var out;
53+
var i;
54+
55+
values = [
56+
'floating_point',
57+
'integer'
58+
];
59+
60+
b.tic();
61+
for ( i = 0; i < b.iterations; i++ ) {
62+
out = dtypes( values[ i%values.length ] );
63+
if ( out.length === 0 ) {
64+
b.fail( 'should return a non-empty array' );
65+
}
66+
}
67+
b.toc();
68+
if ( !isStringArray( out ) ) {
69+
b.fail( 'should return an array of strings' );
70+
}
71+
b.pass( 'benchmark finished' );
72+
b.end();
73+
});

‎lib/node_modules/@stdlib/array/dtypes/docs/repl.txt‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

2-
{{alias}}()
2+
{{alias}}( [kind] )
33
Returns a list of array data types.
44

5-
The output array contains the following data types:
5+
When not provided a data type "kind", the function returns an array
6+
containing the following data types:
67

78
- float32: single-precision floating-point numbers.
89
- float64: double-precision floating-point numbers.
@@ -17,6 +18,23 @@
1718
- uint8: unsigned 8-bit integers.
1819
- uint8c: unsigned clamped 8-bit integers.
1920

21+
The function supports the following data type "kinds":
22+
23+
- floating_point: floating-point data types.
24+
- real_floating_point: real-valued floating-point data types.
25+
- complex_floating_point: complex-valued floating-point data types.
26+
- integer: integer data types.
27+
- signed_integer: signed integer data types.
28+
- unsigned_integer: unsigned integer data types.
29+
- real: real-valued data types.
30+
- numeric: numeric data types.
31+
- all: all data types.
32+
33+
Parameters
34+
----------
35+
kind: string (optional)
36+
Data type kind.
37+
2038
Returns
2139
-------
2240
out: Array<string>
@@ -26,6 +44,8 @@
2644
--------
2745
> var out = {{alias}}()
2846
<Array>
47+
> out = {{alias}}( 'floating_point' )
48+
<Array>
2949

3050
See Also
3151
--------

‎lib/node_modules/@stdlib/array/dtypes/docs/types/index.d.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,23 @@
2020

2121
/// <reference types="@stdlib/types"/>
2222

23-
import { DataType } from '@stdlib/types/array';
23+
import { DataType, DataTypeKind } from '@stdlib/types/array';
2424

2525
/**
2626
* Returns a list of array data types.
2727
*
28+
* @param kind - data type kind
2829
* @returns list of array data types
2930
*
3031
* @example
3132
* var list = dtypes();
3233
* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
34+
*
35+
* @example
36+
* var list = dtypes( 'floating_point' );
37+
* // returns [...]
3338
*/
34-
declare function dtypes(): Array<DataType>;
39+
declare function dtypes( kind?: DataTypeKind ): Array<DataType>;
3540

3641

3742
// EXPORTS //

‎lib/node_modules/@stdlib/array/dtypes/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ import dtypes = require( './index' );
2424
// The function returns an array of data types...
2525
{
2626
dtypes(); // $ExpectType DataType[]
27+
dtypes( 'floating_point' ); // $ExpectType DataType[]
2728
}
2829

29-
// The compiler throws an error if the function is provided arguments...
30+
// The compiler throws an error if the function is provided an unsupported number of arguments...
3031
{
31-
dtypes( 1 ); // $ExpectError
32-
dtypes( 1, 2 ); // $ExpectError
32+
dtypes( 'floating_point', 2 ); // $ExpectError
3333
}

‎lib/node_modules/@stdlib/array/dtypes/examples/index.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
2222
var dtypes = require( './../lib' );
2323

2424
var DTYPES = dtypes();
25-
var bool;
2625

2726
function isdtype( str ) {
2827
if ( indexOf( DTYPES, str ) === -1 ) {
@@ -31,7 +30,7 @@ function isdtype( str ) {
3130
return true;
3231
}
3332

34-
bool = isdtype( 'float64' );
33+
var bool = isdtype( 'float64' );
3534
console.log( bool );
3635
// => true
3736

‎lib/node_modules/@stdlib/array/dtypes/lib/dtypes.json‎

Lines changed: 74 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,74 @@
1-
[
2-
"float32",
3-
"float64",
4-
"generic",
5-
"int16",
6-
"int32",
7-
"int8",
8-
"uint16",
9-
"uint32",
10-
"uint8",
11-
"uint8c",
12-
"complex64",
13-
"complex128"
14-
]
1+
{
2+
"all": [
3+
"complex64",
4+
"complex128",
5+
"float32",
6+
"float64",
7+
"generic",
8+
"int16",
9+
"int32",
10+
"int8",
11+
"uint16",
12+
"uint32",
13+
"uint8",
14+
"uint8c"
15+
],
16+
"floating_point": [
17+
"complex64",
18+
"complex128",
19+
"float32",
20+
"float64"
21+
],
22+
"real_floating_point": [
23+
"float32",
24+
"float64"
25+
],
26+
"complex_floating_point": [
27+
"complex64",
28+
"complex128"
29+
],
30+
"integer": [
31+
"int16",
32+
"int32",
33+
"int8",
34+
"uint16",
35+
"uint32",
36+
"uint8",
37+
"uint8c"
38+
],
39+
"signed_integer": [
40+
"int16",
41+
"int32",
42+
"int8"
43+
],
44+
"unsigned_integer": [
45+
"uint16",
46+
"uint32",
47+
"uint8",
48+
"uint8c"
49+
],
50+
"real": [
51+
"float32",
52+
"float64",
53+
"int16",
54+
"int32",
55+
"int8",
56+
"uint16",
57+
"uint32",
58+
"uint8",
59+
"uint8c"
60+
],
61+
"numeric": [
62+
"complex64",
63+
"complex128",
64+
"float32",
65+
"float64",
66+
"int16",
67+
"int32",
68+
"int8",
69+
"uint16",
70+
"uint32",
71+
"uint8",
72+
"uint8c"
73+
]
74+
}

‎lib/node_modules/@stdlib/array/dtypes/lib/main.js‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,24 @@ var DTYPES = require( './dtypes.json' );
2828
/**
2929
* Returns a list of array data types.
3030
*
31+
* @param {string} [kind] - data type kind
3132
* @returns {StringArray} list of array data types
3233
*
3334
* @example
3435
* var list = dtypes();
3536
* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex64', 'complex128' ]
37+
*
38+
* @example
39+
* var list = dtypes( 'floating_point' );
40+
* // returns [...]
3641
*/
3742
function dtypes() {
38-
return DTYPES.slice();
43+
var out;
44+
if ( arguments.length === 0 ) {
45+
return DTYPES.all.slice();
46+
}
47+
out = DTYPES[ arguments[ 0 ] ];
48+
return ( out ) ? out.slice() : [];
3949
}
4050

4151

0 commit comments

Comments
 (0)
⚡