feat: add boolean dtype support to ndarray/base/buffer-ctors

PR-URL: #2571
Ref: #2547
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]>

Author: Jaysukh-409

lib/node_modules/@stdlib/ndarray/base/buffer-ctors/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.
@@ -42,30 +42,14 @@ var ctors = require( '@stdlib/ndarray/base/buffer-ctors' );
 
 #### ctors( dtype )
 
-Returns an ndarray data buffer constructor for a specified data type.
+Returns an ndarray data buffer constructor for a specified [data type][@stdlib/ndarray/dtypes].
 
 ```javascript
 var ctor = ctors( 'float64' );
 // returns <Function>
 ```
 
-The function returns constructors for the following data types:
-
--   `binary`: binary.
--   `complex64`: single-precision complex floating-point numbers.
--   `complex128`: double-precision complex floating-point numbers.
--   `float32`: single-precision floating-point numbers.
--   `float64`: double-precision floating-point numbers.
--   `generic`: values of any type.
--   `int16`: signed 16-bit integers.
--   `int32`: signed 32-bit integers.
--   `int8`: signed 8-bit integers.
--   `uint16`: unsigned 16-bit integers.
--   `uint32`: unsigned 32-bit integers.
--   `uint8`: unsigned 8-bit integers.
--   `uint8c`: unsigned clamped 8-bit integers.
-
-If provided an unknown or unsupported data type, the function returns `null`.
+If provided an unknown or unsupported [data type][@stdlib/ndarray/dtypes], the function returns `null`.
 
 ```javascript
 var ctor = ctors( 'float' );
@@ -97,9 +81,9 @@ var dtypes = require( '@stdlib/ndarray/dtypes' );
 var ctors = require( '@stdlib/ndarray/base/buffer-ctors' );
 
 var DTYPES = dtypes();
+
 var ctor;
 var i;
-
 for ( i = 0; i < DTYPES.length; i++ ) {
     ctor = ctors( DTYPES[ i ] );
     console.log( ctor );
@@ -130,6 +114,8 @@ for ( i = 0; i < DTYPES.length; i++ ) {
 
 <section class="links">
 
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/buffer-ctors/docs/repl.txt

@@ -2,22 +2,6 @@
 {{alias}}( dtype )
     Returns an ndarray data buffer constructor.
 
-    The function returns constructors for the following data types:
-
-    - binary: binary.
-    - complex64: single-precision complex floating-point numbers.
-    - complex128: double-precision complex floating-point numbers.
-    - float32: single-precision floating-point numbers.
-    - float64: double-precision floating-point numbers.
-    - generic: values of any type.
-    - int16: signed 16-bit integers.
-    - int32: signed 32-bit integers.
-    - int8: signed 8-bit integers.
-    - uint16: unsigned 16-bit integers.
-    - uint32: unsigned 32-bit integers.
-    - uint8: unsigned 8-bit integers.
-    - uint8c: unsigned clamped 8-bit integers.
-
     Parameters
     ----------
     dtype: string

lib/node_modules/@stdlib/ndarray/base/buffer-ctors/examples/index.js

@@ -22,9 +22,9 @@ var dtypes = require( '@stdlib/ndarray/dtypes' );
 var ctors = require( './../lib' );
 
 var DTYPES = dtypes();
+
 var ctor;
 var i;
-
 for ( i = 0; i < DTYPES.length; i++ ) {
 	ctor = ctors( DTYPES[ i ] );
 	console.log( ctor );

lib/node_modules/@stdlib/ndarray/base/buffer-ctors/lib/ctors.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.
@@ -32,6 +32,7 @@ var Uint8Array = require( '@stdlib/array/uint8' );
 var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex128Array = require( '@stdlib/array/complex128' );
+var BooleanArray = require( '@stdlib/array/bool' );
 
 
 // MAIN //
@@ -50,7 +51,8 @@ var ctors = {
 	'uint8': Uint8Array,
 	'uint8c': Uint8ClampedArray,
 	'complex64': Complex64Array,
-	'complex128': Complex128Array
+	'complex128': Complex128Array,
+	'bool': BooleanArray
 };
 
 

lib/node_modules/@stdlib/ndarray/base/buffer-ctors/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.
@@ -34,6 +34,7 @@ var Uint8Array = require( '@stdlib/array/uint8' );
 var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex128Array = require( '@stdlib/array/complex128' );
+var BooleanArray = require( '@stdlib/array/bool' );
 var isFunction = require( '@stdlib/assert/is-function' );
 var ctors = require( './../lib' );
 
@@ -65,7 +66,8 @@ tape( 'the function returns ndarray data buffer constructors', function test( t
 		'uint8',
 		'uint8c',
 		'complex64',
-		'complex128'
+		'complex128',
+		'bool'
 	];
 	expected = [
 		Buffer,
@@ -80,7 +82,8 @@ tape( 'the function returns ndarray data buffer constructors', function test( t
 		Uint8Array,
 		Uint8ClampedArray,
 		Complex64Array,
-		Complex128Array
+		Complex128Array,
+		BooleanArray
 	];
 	for ( i = 0; i < dtypes.length; i++ ) {
 		ctor = ctors( dtypes[ i ] );