Auto-generated commit

CHANGELOG.md

@@ -1132,6 +1132,7 @@ This release closes the following issue:
 
 ##### Features
 
+-   [`c417923`](https://github.com/stdlib-js/stdlib/commit/c4179233cb2de5ffaa8c59b3910e14de12414483) - add boolean dtype support in `array/dtypes` [(#2307)](https://github.com/stdlib-js/stdlib/pull/2307)
 -   [`894eb44`](https://github.com/stdlib-js/stdlib/commit/894eb448a1720439bb19f246a53bd6a5a83f8b78) - add support for 'typed' data type kind
 
 </section>
@@ -1750,6 +1751,7 @@ A total of 13 people contributed to this release. Thank you to the following con
 
 <details>
 
+-   [`c417923`](https://github.com/stdlib-js/stdlib/commit/c4179233cb2de5ffaa8c59b3910e14de12414483) - **feat:** add boolean dtype support in `array/dtypes` [(#2307)](https://github.com/stdlib-js/stdlib/pull/2307) _(by Jaysukh Makvana, Athan Reines)_
 -   [`2a174cd`](https://github.com/stdlib-js/stdlib/commit/2a174cd91a26e08e7032934762ef2c0ed0320bda) - **feat:** add boolean dtype support in `array/promotion-rules` [(#2369)](https://github.com/stdlib-js/stdlib/pull/2369) _(by Jaysukh Makvana, Athan Reines)_
 -   [`d71d044`](https://github.com/stdlib-js/stdlib/commit/d71d04433120ab3096fb01c546d96c60c7684681) - **feat:** add `sort` method to `array/bool` [(#2363)](https://github.com/stdlib-js/stdlib/pull/2363) _(by Jaysukh Makvana)_
 -   [`1b80190`](https://github.com/stdlib-js/stdlib/commit/1b8019023cc1e56fc6ae46fba1825503c03c48a1) - **feat:** add boolean dtype support in `array/next-dtype` [(#2362)](https://github.com/stdlib-js/stdlib/pull/2362) _(by Jaysukh Makvana)_

dtypes/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2018 The Stdlib Authors.
+Copyright (c) 2024 The Stdlib Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -55,6 +55,7 @@ When not provided a data type "kind", the function returns an array containing t
 -   `float64`: double-precision floating-point numbers.
 -   `complex64`: single-precision complex floating-point numbers.
 -   `complex128`: double-precision complex floating-point numbers.
+-   `bool`: boolean values.
 -   `generic`: values of any type.
 -   `int16`: signed 16-bit integers.
 -   `int32`: signed 32-bit integers.
@@ -76,6 +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.
+-   `boolean`: boolean data types.
 -   `integer`: integer data types.
 -   `signed_integer`: signed integer data types.
 -   `unsigned_integer`: unsigned integer data types.

dtypes/benchmark/benchmark.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -79,7 +79,8 @@ bench( pkg+'::kind,generic', function benchmark( b ) {
 
 	values = [
 		'floating_point_and_generic',
-		'integer_and_generic'
+		'integer_and_generic',
+		'boolean_and_generic'
 	];
 
 	b.tic();

dtypes/docs/repl.txt

@@ -9,6 +9,7 @@
     - float64: double-precision floating-point numbers.
     - complex64: single-precision complex floating-point numbers.
     - complex128: double-precision complex floating-point numbers.
+    - bool: boolean values.
     - generic: values of any type.
     - int16: signed 16-bit integers.
     - int32: signed 32-bit integers.
@@ -23,6 +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.
+    - boolean: boolean data types.
     - integer: integer data types.
     - signed_integer: signed integer data types.
     - unsigned_integer: unsigned integer data types.

dtypes/lib/dtypes.json

@@ -1,5 +1,6 @@
 {
   "all": [
+    "bool",
     "complex64",
     "complex128",
     "float32",
@@ -14,6 +15,7 @@
     "uint8c"
   ],
   "typed": [
+    "bool",
     "complex64",
     "complex128",
     "float32",
@@ -40,6 +42,9 @@
     "complex64",
     "complex128"
   ],
+  "boolean": [
+    "bool"
+  ],
   "integer": [
     "int16",
     "int32",

dtypes/lib/index.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@
 * var dtypes = require( '@stdlib/array/dtypes' );
 *
 * var list = dtypes();
-* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex128', 'complex64' ]
+* // e.g., returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c', 'complex128', 'complex64', 'bool' ]
 */
 
 // MODULES //

dtypes/test/test.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2024 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -37,6 +37,7 @@ tape( 'the function returns a list of array data types', function test( t ) {
 	var actual;
 
 	expected = [
+		'bool',
 		'complex64',
 		'complex128',
 		'float32',
@@ -61,6 +62,7 @@ tape( 'the function supports returning a list of array data types (all)', functi
 	var actual;
 
 	expected = [
+		'bool',
 		'complex64',
 		'complex128',
 		'float32',
@@ -85,6 +87,7 @@ tape( 'the function supports returning a list of array data types (all, includin
 	var actual;
 
 	expected = [
+		'bool',
 		'complex64',
 		'complex128',
 		'float32',
@@ -109,6 +112,7 @@ tape( 'the function supports returning a list of array data types (typed)', func
 	var actual;
 
 	expected = [
+		'bool',
 		'complex64',
 		'complex128',
 		'float32',
@@ -132,6 +136,7 @@ tape( 'the function supports returning a list of array data types (typed, includ
 	var actual;
 
 	expected = [
+		'bool',
 		'complex64',
 		'complex128',
 		'float32',
@@ -242,6 +247,33 @@ tape( 'the function supports returning a list of complex-valued floating-point a
 	t.end();
 });
 
+tape( 'the function supports returning a list of boolean array data types', function test( t ) {
+	var expected;
+	var actual;
+
+	expected = [
+		'bool'
+	];
+	actual = dtypes( 'boolean' );
+
+	t.deepEqual( actual, expected, 'returns expected value' );
+	t.end();
+});
+
+tape( 'the function supports returning a list of boolean array data types (including "generic")', function test( t ) {
+	var expected;
+	var actual;
+
+	expected = [
+		'bool',
+		'generic'
+	];
+	actual = dtypes( 'boolean_and_generic' );
+
+	t.deepEqual( actual, expected, 'returns expected value' );
+	t.end();
+});
+
 tape( 'the function supports returning a list of integer array data types', function test( t ) {
 	var expected;
 	var actual;