refactor: reduce dtype string duplication

kgryte · kgryte · commit d88c94643fc9 · 2024-02-06T23:51:05.000-08:00
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/README.md b/lib/node_modules/@stdlib/array/typed-complex-dtypes/README.md
@@ -46,14 +46,9 @@ Returns a list of complex typed array data types.
 
 ```javascript
 var out = dtypes();
-// returns [ 'complex64', 'complex128' ]
+// e.g., returns [ 'complex64', ... ]
 ```
 
-The output `array` contains the following data types:
-
--   `complex64`: single-precision floating-point complex numbers.
--   `complex128`: double-precision floating-point complex numbers.
-
 </section>
 
 <!-- /.usage -->
@@ -79,7 +74,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
 var dtypes = require( '@stdlib/array/typed-complex-dtypes' );
 
 var DTYPES = dtypes();
-var bool;
 
 function isdtype( str ) {
     if ( indexOf( DTYPES, str ) === -1 ) {
@@ -88,7 +82,7 @@ function isdtype( str ) {
     return true;
 }
 
-bool = isdtype( 'complex64' );
+var bool = isdtype( 'complex64' );
 // returns true
 
 bool = isdtype( 'complex128' );
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/benchmark/benchmark.js b/lib/node_modules/@stdlib/array/typed-complex-dtypes/benchmark/benchmark.js
@@ -35,8 +35,8 @@ bench( pkg, function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = dtypes();
-		if ( out.length !== 2 ) {
-			b.fail( 'should return an array of length 2' );
+		if ( out.length < 2 ) {
+			b.fail( 'should return an array' );
 		}
 	}
 	b.toc();
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/repl.txt b/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/repl.txt
@@ -2,11 +2,6 @@
 {{alias}}()
     Returns a list of complex typed array data types.
 
-    The output array contains the following data types:
-
-    - complex64: single-precision floating-point complex numbers.
-    - complex128: double-precision floating-point complex numbers.
-
     Returns
     -------
     out: Array<string>
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/types/index.d.ts
@@ -29,7 +29,7 @@ import { ComplexFloatingPointDataType as DataType } from '@stdlib/types/array';
 *
 * @example
 * var list = dtypes();
-* // returns [ 'complex64', 'complex128' ]
+* // e.g., returns [ 'complex64', ... ]
 */
 declare function dtypes(): Array<DataType>;
 
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/examples/index.js b/lib/node_modules/@stdlib/array/typed-complex-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( 'complex64' );
+var bool = isdtype( 'complex64' );
 console.log( bool );
 // => true
 
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/dtypes.json b/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/dtypes.json
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/index.js b/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/index.js
@@ -27,7 +27,7 @@
 * var dtypes = require( '@stdlib/array/typed-complex-dtypes' );
 *
 * var list = dtypes();
-* // returns [ 'complex64', 'complex128' ]
+* // e.g., returns [ 'complex64', ... ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/main.js b/lib/node_modules/@stdlib/array/typed-complex-dtypes/lib/main.js
@@ -20,7 +20,7 @@
 
 // MODULES //
 
-var DTYPES = require( './dtypes.json' );
+var dt = require( '@stdlib/array/dtypes' );
 
 
 // MAIN //
@@ -32,10 +32,10 @@ var DTYPES = require( './dtypes.json' );
 *
 * @example
 * var list = dtypes();
-* // returns [ 'complex64', 'complex128' ]
+* // e.g., returns [ 'complex64', ... ]
 */
 function dtypes() {
-	return DTYPES.slice();
+	return dt( 'complex_floating_point' );
 }
 
 
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/test/test.js b/lib/node_modules/@stdlib/array/typed-complex-dtypes/test/test.js
@@ -21,6 +21,7 @@
 // MODULES //
 
 var tape = require( 'tape' );
+var dt = require( '@stdlib/array/dtypes' );
 var dtypes = require( './../lib' );
 
 
@@ -36,10 +37,7 @@ tape( 'the function returns a list of complex typed array data types', function
 	var expected;
 	var actual;
 
-	expected = [
-		'complex64',
-		'complex128'
-	];
+	expected = dt( 'complex_floating_point' );
 	actual = dtypes();
 
 	t.deepEqual( actual, expected, 'returns expected value' );

Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,8 @@ bench( pkg, function benchmark( b ) {`
`35`	`35`	`b.tic();`
`36`	`36`	`for ( i = 0; i < b.iterations; i++ ) {`
`37`	`37`	`out = dtypes();`
`38`		`- if ( out.length !== 2 ) {`
`39`		`- b.fail( 'should return an array of length 2' );`
	`38`	`+ if ( out.length < 2 ) {`
	`39`	`+ b.fail( 'should return an array' );`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`b.toc();`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ import { ComplexFloatingPointDataType as DataType } from '@stdlib/types/array';`
`29`	`29`	`*`
`30`	`30`	`* @example`
`31`	`31`	`* var list = dtypes();`
`32`		`-* // returns [ 'complex64', 'complex128' ]`
	`32`	`+* // e.g., returns [ 'complex64', ... ]`
`33`	`33`	`*/`
`34`	`34`	`declare function dtypes(): Array<DataType>;`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* var dtypes = require( '@stdlib/array/typed-complex-dtypes' );`
`28`	`28`	`*`
`29`	`29`	`* var list = dtypes();`
`30`		`-* // returns [ 'complex64', 'complex128' ]`
	`30`	`+* // e.g., returns [ 'complex64', ... ]`
`31`	`31`	`*/`
`32`	`32`
`33`	`33`	`// MODULES //`