feat!: rename type definitions for array and ndarray data types

kgryte · kgryte · commit e25b23b917ee · 2023-12-31T02:31:52.000-08:00
This commit renames type definitions in order to align with defined
data type "kinds". This ensures consistent naming conventions such
that a data type "kind" has a direct mapping to a data type type
definition.

BREAKING CHANGE: rename type definitions for array and ndarray data types

In order to migrate, users should update their implementations to
use the latest naming conventions. The affected type definitions
are aliases for individual data type strings, so their should be
no behavioral changes.
diff --git a/lib/node_modules/@stdlib/array/linspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/linspace/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatOrComplexDataType as DataType, ArrayLike, FloatOrComplexTypedArray, Complex64Array, Complex128Array } from '@stdlib/types/array';
+import { FloatingPointDataType as DataType, ArrayLike, FloatOrComplexTypedArray, Complex64Array, Complex128Array } from '@stdlib/types/array';
 import { ComplexLike, Complex64, Complex128 } from '@stdlib/types/complex';
 
 /**
diff --git a/lib/node_modules/@stdlib/array/min-dtype/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/min-dtype/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { RealDataType, ComplexDataType, DataType } from '@stdlib/types/array';
+import { RealDataType, ComplexFloatingPointDataType } from '@stdlib/types/array';
 import { ComplexLike } from '@stdlib/types/complex';
 
 /**
@@ -61,7 +61,7 @@ declare function minDataType( value: number ): RealDataType;
 * var dt = minDataType( z );
 * // returns 'complex64'
 */
-declare function minDataType( value: ComplexLike ): ComplexDataType;
+declare function minDataType( value: ComplexLike ): ComplexFloatingPointDataType;
 
 /**
 * Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
diff --git a/lib/node_modules/@stdlib/array/min-dtype/docs/types/test.ts b/lib/node_modules/@stdlib/array/min-dtype/docs/types/test.ts
@@ -29,7 +29,7 @@ import minDataType = require( './index' );
 	};
 
 	minDataType( 2.13 ); // $ExpectType RealDataType
-	minDataType( z ); // $ExpectType ComplexDataType
+	minDataType( z ); // $ExpectType ComplexFloatingPointDataType
 	minDataType( 'beep' ); // $ExpectType "generic"
 }
 
diff --git a/lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts
@@ -20,12 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Complex128Array, Complex64Array, AnyArray, FloatOrComplexDataType } from '@stdlib/types/array';
+import { Complex128Array, Complex64Array, AnyArray, FloatingPointDataType } from '@stdlib/types/array';
 
 /**
 * Data type.
 */
-type DataType = FloatOrComplexDataType | 'generic';
+type DataType = FloatingPointDataType | 'generic';
 
 /**
 * Creates an array filled with NaNs and having the same length as a provided input array.
diff --git a/lib/node_modules/@stdlib/array/nans/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/nans/docs/types/index.d.ts
@@ -20,12 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Complex128Array, Complex64Array, FloatOrComplexDataType } from '@stdlib/types/array';
+import { Complex128Array, Complex64Array, FloatingPointDataType } from '@stdlib/types/array';
 
 /**
 * Data type.
 */
-type DataType = FloatOrComplexDataType | 'generic';
+type DataType = FloatingPointDataType | 'generic';
 
 /**
 * Creates an array filled with NaNs and having a specified length.
diff --git a/lib/node_modules/@stdlib/array/pool/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/pool/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ArrayLike, RealOrComplexTypedArray, RealOrComplexDataType as DataType } from '@stdlib/types/array';
+import { ArrayLike, RealOrComplexTypedArray, NumericDataType as DataType } from '@stdlib/types/array';
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 
 /**
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
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ComplexDataType as DataType } from '@stdlib/types/array';
+import { ComplexFloatingPointDataType as DataType } from '@stdlib/types/array';
 
 /**
 * Returns a list of complex typed array data types.
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/array/typed-complex-dtypes/docs/types/test.ts
@@ -23,7 +23,7 @@ import dtypes = require( './index' );
 
 // The function returns a string array..
 {
-	dtypes(); // $ExpectType ComplexDataType[]
+	dtypes(); // $ExpectType ComplexFloatingPointDataType[]
 }
 
 // The compiler throws an error if the function is provided arguments...
diff --git a/lib/node_modules/@stdlib/array/typed-complex/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed-complex/docs/types/index.d.ts
@@ -22,7 +22,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ArrayLike, ComplexTypedArray, ComplexDataType as DataType } from '@stdlib/types/array';
+import { ArrayLike, ComplexTypedArray, ComplexFloatingPointDataType as DataType } from '@stdlib/types/array';
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 
 /**
diff --git a/lib/node_modules/@stdlib/array/typed-dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed-dtypes/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { RealOrComplexDataType as DataType } from '@stdlib/types/array';
+import { NumericDataType as DataType } from '@stdlib/types/array';
 
 /**
 * Returns a list of typed array data types.
diff --git a/lib/node_modules/@stdlib/array/typed-dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/array/typed-dtypes/docs/types/test.ts
@@ -23,7 +23,7 @@ import dtypes = require( './index' );
 
 // The function returns a string array..
 {
-	dtypes(); // $ExpectType RealOrComplexDataType[]
+	dtypes(); // $ExpectType NumericDataType[]
 }
 
 // The compiler throws an error if the function is provided arguments...
diff --git a/lib/node_modules/@stdlib/array/typed-float-dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed-float-dtypes/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatOrComplexDataType as DataType } from '@stdlib/types/array';
+import { FloatingPointDataType as DataType } from '@stdlib/types/array';
 
 /**
 * Returns a list of typed array floating-point data types.
diff --git a/lib/node_modules/@stdlib/array/typed-float-dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/array/typed-float-dtypes/docs/types/test.ts
@@ -23,7 +23,7 @@ import dtypes = require( './index' );
 
 // The function returns a string array..
 {
-	dtypes(); // $ExpectType FloatOrComplexDataType[]
+	dtypes(); // $ExpectType FloatingPointDataType[]
 }
 
 // The compiler throws an error if the function is provided arguments...
diff --git a/lib/node_modules/@stdlib/array/typed-real-float-dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed-real-float-dtypes/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType as DataType } from '@stdlib/types/array';
+import { RealFloatingPointDataType as DataType } from '@stdlib/types/array';
 
 /**
 * Returns a list of typed array real-valued floating-point data types.
diff --git a/lib/node_modules/@stdlib/array/typed-real-float-dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/array/typed-real-float-dtypes/docs/types/test.ts
@@ -23,7 +23,7 @@ import dtypes = require( './index' );
 
 // The function returns a string array..
 {
-	dtypes(); // $ExpectType FloatDataType[]
+	dtypes(); // $ExpectType RealFloatingPointDataType[]
 }
 
 // The compiler throws an error if the function is provided arguments...
diff --git a/lib/node_modules/@stdlib/array/typed/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/typed/docs/types/index.d.ts
@@ -22,7 +22,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ArrayLike, RealOrComplexTypedArray, RealOrComplexDataType } from '@stdlib/types/array';
+import { ArrayLike, RealOrComplexTypedArray, NumericDataType } from '@stdlib/types/array';
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 
 /**
@@ -39,7 +39,7 @@ import ArrayBuffer = require( '@stdlib/array/buffer' );
 * var arr = typedarray( 'float32');
 * // returns <Float32Array>
 */
-declare function typedarray( dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -56,7 +56,7 @@ declare function typedarray( dtype?: RealOrComplexDataType ): RealOrComplexTyped
 * var arr = typedarray( 2, 'float32' );
 * // returns <Float32Array>[ 0.0, 0.0 ]
 */
-declare function typedarray( length: number, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( length: number, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -83,7 +83,7 @@ declare function typedarray( length: number, dtype?: RealOrComplexDataType ): Re
 * var arr2 = typedarray( arr1, 'uint32' );
 * // returns <Uint32Array>[ 5, 3 ]
 */
-declare function typedarray( typedarray: RealOrComplexTypedArray, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( typedarray: RealOrComplexTypedArray, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -100,7 +100,7 @@ declare function typedarray( typedarray: RealOrComplexTypedArray, dtype?: RealOr
 * var arr = typedarray( [ 5, -3 ], 'int32' );
 * // returns <Int32Array>[ 5, -3 ]
 */
-declare function typedarray( obj: ArrayLike<number> | Iterable<any>, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( obj: ArrayLike<number> | Iterable<any>, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -123,7 +123,7 @@ declare function typedarray( obj: ArrayLike<number> | Iterable<any>, dtype?: Rea
 * var arr = typedarray( buf, 'float32' );
 * // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
 */
-declare function typedarray( buffer: ArrayBuffer, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( buffer: ArrayBuffer, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -147,7 +147,7 @@ declare function typedarray( buffer: ArrayBuffer, dtype?: RealOrComplexDataType
 * var arr = typedarray( buf, 8, 'float32' );
 * // returns <Float32Array>[ 0.0, 0.0 ]
 */
-declare function typedarray( buffer: ArrayBuffer, byteOffset?: number, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( buffer: ArrayBuffer, byteOffset?: number, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 /**
 * Creates a typed array.
@@ -172,7 +172,7 @@ declare function typedarray( buffer: ArrayBuffer, byteOffset?: number, dtype?: R
 * var arr = typedarray( buf, 8, 2, 'int32' );
 * // returns <Int32Array>[ 0, 0 ]
 */
-declare function typedarray( buffer: ArrayBuffer, byteOffset?: number, length?: number, dtype?: RealOrComplexDataType ): RealOrComplexTypedArray;
+declare function typedarray( buffer: ArrayBuffer, byteOffset?: number, length?: number, dtype?: NumericDataType ): RealOrComplexTypedArray;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/complex/dtype/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/dtype/docs/types/index.d.ts
@@ -20,12 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Complex64, Complex128, ComplexDataType } from '@stdlib/types/complex';
+import { Complex64, Complex128, ComplexFloatingPointDataType } from '@stdlib/types/complex';
 
 /**
 * Complex number data type.
 */
-type DataType = ComplexDataType;
+type DataType = ComplexFloatingPointDataType;
 
 /**
 * Returns the data type of a complex number.
diff --git a/lib/node_modules/@stdlib/complex/dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/dtypes/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ComplexDataType } from '@stdlib/types/complex';
+import { ComplexFloatingPointDataType } from '@stdlib/types/complex';
 
 /**
 * Returns a list of complex number data types.
@@ -31,7 +31,7 @@ import { ComplexDataType } from '@stdlib/types/complex';
 * var list = dtypes();
 * // e.g., returns [ 'complex64', 'complex128' ]
 */
-declare function dtypes(): Array<ComplexDataType>;
+declare function dtypes(): Array<ComplexFloatingPointDataType>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/complex/dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/complex/dtypes/docs/types/test.ts
@@ -23,7 +23,7 @@ import dtypes = require( './index' );
 
 // The function returns an array of data types...
 {
-	dtypes(); // $ExpectType ComplexDataType[]
+	dtypes(); // $ExpectType ComplexFloatingPointDataType[]
 }
 
 // The compiler throws an error if the function is provided arguments...
diff --git a/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ComplexDataType } from '@stdlib/types/complex';
+import { ComplexFloatingPointDataType } from '@stdlib/types/complex';
 
 /**
 * Real number data types.
@@ -30,7 +30,7 @@ type RealDataTypes = 'float64' | 'float32' | 'int32' | 'int16' | 'int8' | 'uint3
 /**
 * Number data types.
 */
-type DataType = RealDataTypes | ComplexDataType;
+type DataType = RealDataTypes | ComplexFloatingPointDataType;
 
 /**
 * Interface describing a promotion table.
diff --git a/lib/node_modules/@stdlib/random/array/arcsine/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/arcsine/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/beta/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/beta/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/betaprime/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/betaprime/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/cosine/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/cosine/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/exponential/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/exponential/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/gamma/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/gamma/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/geometric/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/geometric/docs/types/index.d.ts
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { FloatDataType, FloatTypedArray } from '@stdlib/types/array';
+import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array';
 import * as random from '@stdlib/types/random';
 
 /**
 * Supported data types.
 */
-type DataType = FloatDataType | 'generic';
+type DataType = RealFloatingPointDataType | 'generic';
 
 /**
 * Output array.
diff --git a/lib/node_modules/@stdlib/random/array/invgamma/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/invgamma/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/lognormal/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/lognormal/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/minstd-shuffle/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/minstd-shuffle/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/minstd/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/minstd/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/mt19937/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/mt19937/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/normal/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/normal/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/randu/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/randu/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/random/array/uniform/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/uniform/docs/types/index.d.ts
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ import minDataType = require( './index' );`
`29`	`29`	`};`
`30`	`30`
`31`	`31`	`minDataType( 2.13 ); // $ExpectType RealDataType`
`32`		`- minDataType( z ); // $ExpectType ComplexDataType`
	`32`	`+ minDataType( z ); // $ExpectType ComplexFloatingPointDataType`
`33`	`33`	`minDataType( 'beep' ); // $ExpectType "generic"`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ import dtypes = require( './index' );`
`23`	`23`
`24`	`24`	`// The function returns a string array..`
`25`	`25`	`{`
`26`		`- dtypes(); // $ExpectType ComplexDataType[]`
	`26`	`+ dtypes(); // $ExpectType ComplexFloatingPointDataType[]`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`// The compiler throws an error if the function is provided arguments...`