Skip to content

Commit d45a05b

Browse files
committed
feat!: rename integral to integer
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.
1 parent d96fdc9 commit d45a05b

File tree

21 files changed

+25
-25
lines changed

21 files changed

+25
-25
lines changed

lib/node_modules/@stdlib/ndarray/defaults/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The returned object has the following properties:
5959
- **floating_point**: default floating-point data type.
6060
- **real_floating_point**: default real-valued floating-point data type.
6161
- **complex_floating_point**: default complex-valued floating-point data type.
62-
- **integral**: default integer data type.
62+
- **integer**: default integer data type.
6363
- **signed_integer**: default signed integer data type.
6464
- **unsigned_integer**: default unsigned integer data type.
6565

@@ -128,7 +128,7 @@ opts.dtype = o.dtypes.real_floating_point;
128128
x = array( buf, opts );
129129
console.log( x.dtype );
130130

131-
opts.dtype = o.dtypes.integral;
131+
opts.dtype = o.dtypes.integer;
132132
x = array( buf, opts );
133133
console.log( x.dtype );
134134

lib/node_modules/@stdlib/ndarray/defaults/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
out.dtypes.complex_floating_point: string
2929
Default complex-valued floating-point data type.
3030

31-
out.dtypes.integral: string
31+
out.dtypes.integer: string
3232
Default integer data type.
3333

3434
out.dtypes.signed_integer: string

lib/node_modules/@stdlib/ndarray/defaults/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ interface DataTypes {
5555
/**
5656
* Default integer data type.
5757
*/
58-
integral: 'int32';
58+
integer: 'int32';
5959

6060
/**
6161
* Default signed integer data type.

lib/node_modules/@stdlib/ndarray/defaults/examples/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ opts.dtype = o.dtypes.real_floating_point;
4242
x = array( buf, opts );
4343
console.log( x.dtype );
4444

45-
opts.dtype = o.dtypes.integral;
45+
opts.dtype = o.dtypes.integer;
4646
x = array( buf, opts );
4747
console.log( x.dtype );
4848

lib/node_modules/@stdlib/ndarray/defaults/lib/get.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var HASH = {
3333
'dtypes.floating_point': DEFAULTS.dtypes.floating_point,
3434
'dtypes.real_floating_point': DEFAULTS.dtypes.real_floating_point,
3535
'dtypes.complex_floating_point': DEFAULTS.dtypes.complex_floating_point,
36-
'dtypes.integral': DEFAULTS.dtypes.integral,
36+
'dtypes.integer': DEFAULTS.dtypes.integer,
3737
'dtypes.signed_integer': DEFAULTS.dtypes.signed_integer,
3838
'dtypes.unsigned_integer': DEFAULTS.dtypes.unsigned_integer,
3939
'order': DEFAULTS.order,

lib/node_modules/@stdlib/ndarray/defaults/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ function defaults() {
3939
'floating_point': 'float64',
4040
'real_floating_point': 'float64',
4141
'complex_floating_point': 'complex128',
42-
'integral': 'int32',
42+
'integer': 'int32',
4343
'signed_integer': 'int32',
4444
'unsigned_integer': 'uint32'
4545
},

lib/node_modules/@stdlib/ndarray/defaults/test/test.get.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ tape( 'if provided a recognized setting, the function returns a default value',
5151
'dtypes.floating_point',
5252
'dtypes.real_floating_point',
5353
'dtypes.complex_floating_point',
54-
'dtypes.integral',
54+
'dtypes.integer',
5555
'dtypes.signed_integer',
5656
'dtypes.unsigned_integer',
5757

@@ -66,7 +66,7 @@ tape( 'if provided a recognized setting, the function returns a default value',
6666
DEFAULTS.dtypes.floating_point,
6767
DEFAULTS.dtypes.real_floating_point,
6868
DEFAULTS.dtypes.complex_floating_point,
69-
DEFAULTS.dtypes.integral,
69+
DEFAULTS.dtypes.integer,
7070
DEFAULTS.dtypes.signed_integer,
7171
DEFAULTS.dtypes.unsigned_integer,
7272

lib/node_modules/@stdlib/ndarray/defaults/test/test.main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ tape( 'the function returns default ndarray settings', function test( t ) {
5757
t.strictEqual( hasOwnProp( o.dtypes, 'complex_floating_point' ), true, 'has property' );
5858
t.strictEqual( typeof o.dtypes.complex_floating_point, 'string', 'returns expected value' );
5959

60-
t.strictEqual( hasOwnProp( o.dtypes, 'integral' ), true, 'has property' );
61-
t.strictEqual( typeof o.dtypes.integral, 'string', 'returns expected value' );
60+
t.strictEqual( hasOwnProp( o.dtypes, 'integer' ), true, 'has property' );
61+
t.strictEqual( typeof o.dtypes.integer, 'string', 'returns expected value' );
6262

6363
t.strictEqual( hasOwnProp( o.dtypes, 'signed_integer' ), true, 'has property' );
6464
t.strictEqual( typeof o.dtypes.signed_integer, 'string', 'returns expected value' );

lib/node_modules/@stdlib/ndarray/dtypes/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The function supports the following data type kinds:
7777
- `floating_point`: floating-point data types.
7878
- `real_floating_point`: real-valued floating-point data types.
7979
- `complex_floating_point`: complex-valued floating-point data types.
80-
- `integral`: integer data types.
80+
- `integer`: integer data types.
8181
- `signed_integer`: signed integer data types.
8282
- `unsigned_integer`: unsigned integer data types.
8383
- `real`: real-valued data types.

lib/node_modules/@stdlib/ndarray/dtypes/benchmark/benchmark.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ bench( pkg+'::kind', function benchmark( b ) {
5454

5555
values = [
5656
'floating_point',
57-
'integral'
57+
'integer'
5858
];
5959

6060
b.tic();

lib/node_modules/@stdlib/ndarray/dtypes/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
- floating_point: floating-point data types.
2525
- real_floating_point: real-valued floating-point data types.
2626
- complex_floating_point: complex-valued floating-point data types.
27-
- integral: integer data types.
27+
- integer: integer data types.
2828
- signed_integer: signed integer data types.
2929
- unsigned_integer: unsigned integer data types.
3030
- real: real-valued data types.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/**
2222
* Data type kind.
2323
*/
24-
type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point' | 'complex_floating_point' | 'integral' | 'signed_integer' | 'unsigned_integer'; // tslint-disable-line max-line-length
24+
type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point' | 'complex_floating_point' | 'integer' | 'signed_integer' | 'unsigned_integer'; // tslint-disable-line max-line-length
2525

2626
/**
2727
* Returns a list of ndarray data types.

lib/node_modules/@stdlib/ndarray/dtypes/lib/dtypes.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"complex64",
2929
"complex128"
3030
],
31-
"integral": [
31+
"integer": [
3232
"int16",
3333
"int32",
3434
"int8",

lib/node_modules/@stdlib/ndarray/dtypes/test/test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ tape( 'the function supports returning a list of integer ndarray data types', fu
162162
'uint8',
163163
'uint8c'
164164
];
165-
actual = dtypes( 'integral' );
165+
actual = dtypes( 'integer' );
166166

167167
t.deepEqual( actual, expected, 'returns expected value' );
168168
t.end();

lib/node_modules/@stdlib/ndarray/output-dtype-policies/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The output `array` contains the following data type policies:
5656
- `bool`: return a boolean data type.
5757
- `signed_integer`: return a signed integer data type.
5858
- `unsigned_integer`: return an unsigned integer data type.
59-
- `integral`: return an integer data type (i.e., either signed or unsigned).
59+
- `integer`: return an integer data type (i.e., either signed or unsigned).
6060
- `floating_point`: return a floating-point data type (i.e., either real-valued or complex-valued).
6161
- `real_floating_point`: return a real-valued floating-point data type.
6262
- `complex_floating_point`: return a complex-valued floating-point data type.

lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- real: return a real-valued data type.
1212
- signed_integer: return a signed integer data type.
1313
- unsigned_integer: return an unsigned integer data type.
14-
- integral: return an integer data type (i.e., either signed or unsigned).
14+
- integer: return an integer data type (i.e., either signed or unsigned).
1515
- floating_point: return a floating-point data type (i.e., either real-
1616
valued or complex-valued).
1717
- real_floating_point: return a real-valued floating-point data type.

lib/node_modules/@stdlib/ndarray/output-dtype-policies/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
* - `real`: return a real-valued data type.
3333
* - `signed_integer`: return a signed integer data type.
3434
* - `unsigned_integer`: return an unsigned integer data type.
35-
* - `integral`: return an integer data type (i.e., either signed or unsigned).
35+
* - `integer`: return an integer data type (i.e., either signed or unsigned).
3636
* - `floating_point`: return a floating-point data type (i.e., either real-valued or complex-valued).
3737
* - `real_floating_point`: return a real-valued floating-point data type.
3838
* - `complex_floating_point`: return a complex-valued floating-point data type.

lib/node_modules/@stdlib/ndarray/output-dtype-policies/include/stdlib/ndarray/output_dtype_policies.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ enum STDLIB_NDARRAY_OUTPUT_DTYPE_POLICY {
3535
STDLIB_NDARRAY_OUTPUT_POLICY_BOOL,
3636
STDLIB_NDARRAY_OUTPUT_POLICY_SIGNED_INTEGER,
3737
STDLIB_NDARRAY_OUTPUT_POLICY_UNSIGNED_INTEGER,
38-
STDLIB_NDARRAY_OUTPUT_POLICY_INTEGRAL,
38+
STDLIB_NDARRAY_OUTPUT_POLICY_INTEGER,
3939
STDLIB_NDARRAY_OUTPUT_POLICY_FLOATING_POINT,
4040
STDLIB_NDARRAY_OUTPUT_POLICY_REAL_FLOATING_POINT,
4141
STDLIB_NDARRAY_OUTPUT_POLICY_COMPLEX_FLOATING_POINT,

lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/enum.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ function enumeration() {
4343
'bool': 2,
4444
'signed_integer': 3,
4545
'unsigned_integer': 4,
46-
'integral': 5,
46+
'integer': 5,
4747
'floating_point': 6,
4848
'real_floating_point': 7,
4949
'complex_floating_point': 8,

lib/node_modules/@stdlib/ndarray/output-dtype-policies/lib/policies.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"bool",
55
"signed_integer",
66
"unsigned_integer",
7-
"integral",
7+
"integer",
88
"floating_point",
99
"real_floating_point",
1010
"complex_floating_point",

lib/node_modules/@stdlib/ndarray/output-dtype-policies/test/test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var POLICIES = [
3535
'bool',
3636
'signed_integer',
3737
'unsigned_integer',
38-
'integral',
38+
'integer',
3939
'floating_point',
4040
'real_floating_point',
4141
'complex_floating_point',
@@ -63,7 +63,7 @@ tape( 'the function returns a list of ndarray data type policies', function test
6363
'bool',
6464
'signed_integer',
6565
'unsigned_integer',
66-
'integral',
66+
'integer',
6767
'floating_point',
6868
'real_floating_point',
6969
'complex_floating_point',

0 commit comments

Comments
 (0)