feat!: rename integral to integer

kgryte · kgryte · commit d45a05b03973 · 2023-04-02T15:30:29.000-07:00
This ensures consistency with existing project conventions where
we use "integer" to refer to both signed and unsigned integer
dtypes.

BREAKING CHANGE: rename `integral` to `integer`

To migrate, users should update their code to use `integer` rather
than `integral` to refer to the policy/kind which includes both
signed and unsigned integer dtypes.
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/README.md b/lib/node_modules/@stdlib/ndarray/defaults/README.md
@@ -59,7 +59,7 @@ The returned object has the following properties:
     -   **floating_point**: default floating-point data type.
     -   **real_floating_point**: default real-valued floating-point data type.
     -   **complex_floating_point**: default complex-valued floating-point data type.
-    -   **integral**: default integer data type.
+    -   **integer**: default integer data type.
     -   **signed_integer**: default signed integer data type.
     -   **unsigned_integer**: default unsigned integer data type.
 
@@ -128,7 +128,7 @@ opts.dtype = o.dtypes.real_floating_point;
 x = array( buf, opts );
 console.log( x.dtype );
 
-opts.dtype = o.dtypes.integral;
+opts.dtype = o.dtypes.integer;
 x = array( buf, opts );
 console.log( x.dtype );
 
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/defaults/docs/repl.txt
@@ -28,7 +28,7 @@
     out.dtypes.complex_floating_point: string
         Default complex-valued floating-point data type.
 
-    out.dtypes.integral: string
+    out.dtypes.integer: string
         Default integer data type.
 
     out.dtypes.signed_integer: string
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/defaults/docs/types/index.d.ts
@@ -55,7 +55,7 @@ interface DataTypes {
 	/**
 	* Default integer data type.
 	*/
-	integral: 'int32';
+	integer: 'int32';
 
 	/**
 	* Default signed integer data type.
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/examples/index.js b/lib/node_modules/@stdlib/ndarray/defaults/examples/index.js
@@ -42,7 +42,7 @@ opts.dtype = o.dtypes.real_floating_point;
 x = array( buf, opts );
 console.log( x.dtype );
 
-opts.dtype = o.dtypes.integral;
+opts.dtype = o.dtypes.integer;
 x = array( buf, opts );
 console.log( x.dtype );
 
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/lib/get.js b/lib/node_modules/@stdlib/ndarray/defaults/lib/get.js
@@ -33,7 +33,7 @@ var HASH = {
 	'dtypes.floating_point': DEFAULTS.dtypes.floating_point,
 	'dtypes.real_floating_point': DEFAULTS.dtypes.real_floating_point,
 	'dtypes.complex_floating_point': DEFAULTS.dtypes.complex_floating_point,
-	'dtypes.integral': DEFAULTS.dtypes.integral,
+	'dtypes.integer': DEFAULTS.dtypes.integer,
 	'dtypes.signed_integer': DEFAULTS.dtypes.signed_integer,
 	'dtypes.unsigned_integer': DEFAULTS.dtypes.unsigned_integer,
 	'order': DEFAULTS.order,
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/lib/main.js b/lib/node_modules/@stdlib/ndarray/defaults/lib/main.js
@@ -39,7 +39,7 @@ function defaults() {
 			'floating_point': 'float64',
 			'real_floating_point': 'float64',
 			'complex_floating_point': 'complex128',
-			'integral': 'int32',
+			'integer': 'int32',
 			'signed_integer': 'int32',
 			'unsigned_integer': 'uint32'
 		},
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/test/test.get.js b/lib/node_modules/@stdlib/ndarray/defaults/test/test.get.js
@@ -51,7 +51,7 @@ tape( 'if provided a recognized setting, the function returns a default value',
 		'dtypes.floating_point',
 		'dtypes.real_floating_point',
 		'dtypes.complex_floating_point',
-		'dtypes.integral',
+		'dtypes.integer',
 		'dtypes.signed_integer',
 		'dtypes.unsigned_integer',
 
@@ -66,7 +66,7 @@ tape( 'if provided a recognized setting, the function returns a default value',
 		DEFAULTS.dtypes.floating_point,
 		DEFAULTS.dtypes.real_floating_point,
 		DEFAULTS.dtypes.complex_floating_point,
-		DEFAULTS.dtypes.integral,
+		DEFAULTS.dtypes.integer,
 		DEFAULTS.dtypes.signed_integer,
 		DEFAULTS.dtypes.unsigned_integer,
 
diff --git a/lib/node_modules/@stdlib/ndarray/defaults/test/test.main.js b/lib/node_modules/@stdlib/ndarray/defaults/test/test.main.js
@@ -57,8 +57,8 @@ tape( 'the function returns default ndarray settings', function test( t ) {
 	t.strictEqual( hasOwnProp( o.dtypes, 'complex_floating_point' ), true, 'has property' );
 	t.strictEqual( typeof o.dtypes.complex_floating_point, 'string', 'returns expected value' );
 
-	t.strictEqual( hasOwnProp( o.dtypes, 'integral' ), true, 'has property' );
-	t.strictEqual( typeof o.dtypes.integral, 'string', 'returns expected value' );
+	t.strictEqual( hasOwnProp( o.dtypes, 'integer' ), true, 'has property' );
+	t.strictEqual( typeof o.dtypes.integer, 'string', 'returns expected value' );
 
 	t.strictEqual( hasOwnProp( o.dtypes, 'signed_integer' ), true, 'has property' );
 	t.strictEqual( typeof o.dtypes.signed_integer, 'string', 'returns expected value' );
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/README.md b/lib/node_modules/@stdlib/ndarray/dtypes/README.md
@@ -77,7 +77,7 @@ 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.
--   `integral`: integer data types.
+-   `integer`: integer data types.
 -   `signed_integer`: signed integer data types.
 -   `unsigned_integer`: unsigned integer data types.
 -   `real`: real-valued data types.
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/benchmark/benchmark.js b/lib/node_modules/@stdlib/ndarray/dtypes/benchmark/benchmark.js
@@ -54,7 +54,7 @@ bench( pkg+'::kind', function benchmark( b ) {
 
 	values = [
 		'floating_point',
-		'integral'
+		'integer'
 	];
 
 	b.tic();
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/dtypes/docs/repl.txt
@@ -24,7 +24,7 @@
     - floating_point: floating-point data types.
     - real_floating_point: real-valued floating-point data types.
     - complex_floating_point: complex-valued floating-point data types.
-    - integral: integer data types.
+    - integer: integer data types.
     - signed_integer: signed integer data types.
     - unsigned_integer: unsigned integer data types.
     - real: real-valued data types.
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
@@ -21,7 +21,7 @@
 /**
 * Data type kind.
 */
-type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point' | 'complex_floating_point' | 'integral' | 'signed_integer' | 'unsigned_integer'; // tslint-disable-line max-line-length
+type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point' | 'complex_floating_point' | 'integer' | 'signed_integer' | 'unsigned_integer'; // tslint-disable-line max-line-length
 
 /**
 * Returns a 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
@@ -28,7 +28,7 @@
     "complex64",
     "complex128"
   ],
-  "integral": [
+  "integer": [
     "int16",
     "int32",
     "int8",
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js b/lib/node_modules/@stdlib/ndarray/dtypes/test/test.js
@@ -162,7 +162,7 @@ tape( 'the function supports returning a list of integer ndarray data types', fu
 		'uint8',
 		'uint8c'
 	];
-	actual = dtypes( 'integral' );
+	actual = dtypes( 'integer' );
 
 	t.deepEqual( actual, expected, 'returns expected value' );
 	t.end();
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/README.md b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/README.md
@@ -56,7 +56,7 @@ The output `array` contains the following data type policies:
 -   `bool`: return a boolean data type.
 -   `signed_integer`: return a signed integer data type.
 -   `unsigned_integer`: return an unsigned integer data type.
--   `integral`: return an integer data type (i.e., either signed or unsigned).
+-   `integer`: return an integer data type (i.e., either signed or unsigned).
 -   `floating_point`: return a floating-point data type (i.e., either real-valued or complex-valued).
 -   `real_floating_point`: return a real-valued floating-point data type.
 -   `complex_floating_point`: return a complex-valued floating-point data type.
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/repl.txt
@@ -11,7 +11,7 @@
     - real: return a real-valued data type.
     - signed_integer: return a signed integer data type.
     - unsigned_integer: return an unsigned integer data type.
-    - integral: return an integer data type (i.e., either signed or unsigned).
+    - integer: return an integer data type (i.e., either signed or unsigned).
     - floating_point: return a floating-point data type (i.e., either real-
       valued or complex-valued).
     - real_floating_point: return a real-valued floating-point data type.
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/types/index.d.ts
@@ -32,7 +32,7 @@
 *     -   `real`: return a real-valued data type.
 *     -   `signed_integer`: return a signed integer data type.
 *     -   `unsigned_integer`: return an unsigned integer data type.
-*     -   `integral`: return an integer data type (i.e., either signed or unsigned).
+*     -   `integer`: return an integer data type (i.e., either signed or unsigned).
 *     -   `floating_point`: return a floating-point data type (i.e., either real-valued or complex-valued).
 *     -   `real_floating_point`: return a real-valued floating-point data type.
 *     -   `complex_floating_point`: return a complex-valued floating-point data type.
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/include/stdlib/ndarray/output_dtype_policies.h b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/include/stdlib/ndarray/output_dtype_policies.h
@@ -35,7 +35,7 @@ enum STDLIB_NDARRAY_OUTPUT_DTYPE_POLICY {
 	STDLIB_NDARRAY_OUTPUT_POLICY_BOOL,
 	STDLIB_NDARRAY_OUTPUT_POLICY_SIGNED_INTEGER,
 	STDLIB_NDARRAY_OUTPUT_POLICY_UNSIGNED_INTEGER,
-	STDLIB_NDARRAY_OUTPUT_POLICY_INTEGRAL,
+	STDLIB_NDARRAY_OUTPUT_POLICY_INTEGER,
 	STDLIB_NDARRAY_OUTPUT_POLICY_FLOATING_POINT,
 	STDLIB_NDARRAY_OUTPUT_POLICY_REAL_FLOATING_POINT,
 	STDLIB_NDARRAY_OUTPUT_POLICY_COMPLEX_FLOATING_POINT,
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/enum.js b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/enum.js
@@ -43,7 +43,7 @@ function enumeration() {
 		'bool': 2,
 		'signed_integer': 3,
 		'unsigned_integer': 4,
-		'integral': 5,
+		'integer': 5,
 		'floating_point': 6,
 		'real_floating_point': 7,
 		'complex_floating_point': 8,
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/policies.json b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/policies.json
@@ -4,7 +4,7 @@
   "bool",
 	"signed_integer",
   "unsigned_integer",
-  "integral",
+  "integer",
   "floating_point",
   "real_floating_point",
   "complex_floating_point",
diff --git a/lib/node_modules/@stdlib/ndarray/output-dtype-policies/test/test.js b/lib/node_modules/@stdlib/ndarray/output-dtype-policies/test/test.js
@@ -35,7 +35,7 @@ var POLICIES = [
 	'bool',
 	'signed_integer',
 	'unsigned_integer',
-	'integral',
+	'integer',
 	'floating_point',
 	'real_floating_point',
 	'complex_floating_point',
@@ -63,7 +63,7 @@ tape( 'the function returns a list of ndarray data type policies', function test
 		'bool',
 		'signed_integer',
 		'unsigned_integer',
-		'integral',
+		'integer',
 		'floating_point',
 		'real_floating_point',
 		'complex_floating_point',
