feat: add boolean dtype support to array/pool

PR-URL: #2486
Ref: #2304
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: Jaysukh-409

lib/node_modules/@stdlib/array/pool/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.
@@ -18,7 +18,7 @@ limitations under the License.
 
 -->
 
-# Typed Array Pool
+# typedarraypool
 
 > Allocate typed arrays from a typed array memory pool.
 
@@ -42,7 +42,7 @@ var typedarraypool = require( '@stdlib/array/pool' );
 
 #### typedarraypool( \[dtype] )
 
-Returns an **uninitialized** [typed array][mdn-typed-array] having a specified data type `dtype`.
+Returns an **uninitialized** [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes] `dtype`.
 
 ```javascript
 var arr = typedarraypool();
@@ -53,21 +53,7 @@ var arr = typedarraypool();
 typedarraypool.free( arr );
 ```
 
-The function recognizes the following data types:
-
--   `float64`: double-precision floating-point numbers (IEEE 754)
--   `float32`: single-precision floating-point numbers (IEEE 754)
--   `complex128`: double-precision complex floating-point numbers
--   `complex64`: single-precision complex floating-point numbers
--   `int32`: 32-bit two's complement signed integers
--   `uint32`: 32-bit unsigned integers
--   `int16`: 16-bit two's complement signed integers
--   `uint16`: 16-bit unsigned integers
--   `int8`: 8-bit two's complement signed integers
--   `uint8`: 8-bit unsigned integers
--   `uint8c`: 8-bit unsigned integers clamped to `0-255`
-
-By default, the output [typed array][mdn-typed-array] is `float64`. To specify an alternative data type, set the `dtype` parameter.
+By default, the output [typed array][mdn-typed-array] is `float64`. To specify an alternative [data type][@stdlib/array/typed-dtypes], set the `dtype` parameter.
 
 ```javascript
 var arr = typedarraypool( 'int32' );
@@ -135,7 +121,7 @@ typedarraypool.free( arr2 );
 
 #### typedarraypool.malloc( \[dtype] )
 
-Returns an **uninitialized** [typed array][mdn-typed-array] having a specified data type `dtype`.
+Returns an **uninitialized** [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes] `dtype`.
 
 ```javascript
 var arr1 = typedarraypool.malloc();
@@ -207,7 +193,7 @@ typedarraypool.free( arr2 );
 
 #### typedarraypool.calloc( \[dtype] )
 
-Returns a **zero-initialized** [typed array][mdn-typed-array] having a specified data type `dtype`.
+Returns a **zero-initialized** [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes] `dtype`.
 
 ```javascript
 var arr1 = typedarraypool.calloc();
@@ -461,6 +447,8 @@ console.log( 'nbytes: %d', typedarray.nbytes );
 
 [mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
 
+[@stdlib/array/typed-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-dtypes
+
 <!-- <related-links> -->
 
 [@stdlib/array/typed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed

lib/node_modules/@stdlib/array/pool/benchmark/benchmark.calloc.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.
@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var isTypedArray = require( '@stdlib/assert/is-typed-array' );
 var isComplexTypedArray = require( '@stdlib/assert/is-complex-typed-array' );
+var isBooleanArray = require( '@stdlib/assert/is-booleanarray' );
 var pkg = require( './../package.json' ).name;
 var typedarray = require( './../lib' );
 
@@ -209,6 +210,24 @@ bench( pkg+':calloc:dtype=uint8c', function benchmark( b ) {
 	b.end();
 });
 
+bench( pkg+':calloc:dtype=bool', function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = typedarray.calloc( 0, 'bool' );
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isBooleanArray( arr ) ) {
+		b.fail( 'should return a boolean array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
 bench( pkg+':calloc:dtype=complex64', function benchmark( b ) {
 	var arr;
 	var i;

lib/node_modules/@stdlib/array/pool/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.
@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var isTypedArray = require( '@stdlib/assert/is-typed-array' );
 var isComplexTypedArray = require( '@stdlib/assert/is-complex-typed-array' );
+var isBooleanArray = require('@stdlib/assert/is-booleanarray');
 var pkg = require( './../package.json' ).name;
 var typedarray = require( './../lib' );
 
@@ -209,6 +210,24 @@ bench( pkg+':dtype=uint8c', function benchmark( b ) {
 	b.end();
 });
 
+bench( pkg+':dtype=bool', function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = typedarray( 0, 'bool' );
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isBooleanArray( arr ) ) {
+		b.fail( 'should return a boolean array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
 bench( pkg+':dtype=complex64', function benchmark( b ) {
 	var arr;
 	var i;

lib/node_modules/@stdlib/array/pool/benchmark/benchmark.length.bool.js

@@ -0,0 +1,102 @@
+/**
+* @license Apache-2.0
+*
+* 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.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var isBooleanArray = require( '@stdlib/assert/is-booleanarray' );
+var pkg = require( './../package.json' ).name;
+var typedarray = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {Function} fcn - allocation function
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( fcn, len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var arr;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			arr = fcn( len, 'bool' );
+			if ( arr.length !== len ) {
+				b.fail( 'unexpected length' );
+			}
+			typedarray.free( arr );
+		}
+		b.toc();
+		if ( !isBooleanArray( arr ) ) {
+			b.fail( 'should return a boolean array' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+
+		f = createBenchmark( typedarray, len );
+		bench( pkg+':dtype=bool,len='+len, f );
+
+		f = createBenchmark( typedarray.malloc, len );
+		bench( pkg+':malloc:dtype=bool,len='+len, f );
+
+		f = createBenchmark( typedarray.calloc, len );
+		bench( pkg+':calloc:dtype=bool,len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/pool/benchmark/benchmark.malloc.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.
@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var isTypedArray = require( '@stdlib/assert/is-typed-array' );
 var isComplexTypedArray = require( '@stdlib/assert/is-complex-typed-array' );
+var isBooleanArray = require( '@stdlib/assert/is-booleanarray' );
 var pkg = require( './../package.json' ).name;
 var typedarray = require( './../lib' );
 
@@ -209,6 +210,24 @@ bench( pkg+':malloc:dtype=uint8c', function benchmark( b ) {
 	b.end();
 });
 
+bench( pkg+':malloc:dtype=bool', function benchmark( b ) {
+	var arr;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr = typedarray.malloc( 0, 'bool' );
+		if ( arr.length !== 0 ) {
+			b.fail( 'should have length 0' );
+		}
+	}
+	b.toc();
+	if ( !isBooleanArray( arr ) ) {
+		b.fail( 'should return a boolean array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
 bench( pkg+':malloc:dtype=complex64', function benchmark( b ) {
 	var arr;
 	var i;

lib/node_modules/@stdlib/array/pool/docs/repl.txt

@@ -5,22 +5,6 @@
     Memory is **uninitialized**, which means that the contents of a returned
     typed array may contain sensitive contents.
 
-    The function supports the following data types:
-
-    - float64: double-precision floating-point numbers (IEEE 754)
-    - float32: single-precision floating-point numbers (IEEE 754)
-    - complex128: double-precision complex floating-point numbers
-    - complex64: single-precision complex floating-point numbers
-    - int32: 32-bit two's complement signed integers
-    - uint32: 32-bit unsigned integers
-    - int16: 16-bit two's complement signed integers
-    - uint16: 16-bit unsigned integers
-    - int8: 8-bit two's complement signed integers
-    - uint8: 8-bit unsigned integers
-    - uint8c: 8-bit unsigned integers clamped to 0-255
-
-    The default typed array data type is `float64`.
-
     Parameters
     ----------
     dtype: string (optional)
@@ -272,7 +256,7 @@
     --------
     > var arr = {{alias}}( 5 )
     <Float64Array>
-    > {{alias}}.free( arr )
+    > {{alias}}.free( arr );
 
 
 {{alias}}.clear()
@@ -284,7 +268,7 @@
     > var arr = {{alias}}( 5 )
     <Float64Array>
     > {{alias}}.free( arr );
-    > {{alias}}.clear()
+    > {{alias}}.clear();
 
 
 {{alias}}.highWaterMark
@@ -295,6 +279,7 @@
     Examples
     --------
     > {{alias}}.highWaterMark
+    <number>
 
 
 {{alias}}.nbytes
@@ -318,6 +303,7 @@
     > var arr = {{alias}}( 5 )
     <Float64Array>
     > {{alias}}.nbytes
+    <number>
 
 
 {{alias}}.factory( [options] )

lib/node_modules/@stdlib/array/pool/docs/types/index.d.ts

@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2021 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.
@@ -20,13 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ArrayLike, RealOrComplexTypedArray, NumericDataType as DataType } from '@stdlib/types/array';
+import { ArrayLike, RealOrComplexTypedArray, BooleanArray, NumericDataType as DataType } from '@stdlib/types/array';
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 
 /**
 * Typed array or null.
 */
-type TypedArrayOrNull = RealOrComplexTypedArray | null;
+type TypedArrayOrNull = RealOrComplexTypedArray | BooleanArray | null;
 
 /**
 * Interface defining pool options.
@@ -255,7 +255,7 @@ interface Pool {
 	* // Free the allocated typed array buffer for use in a future allocation:
 	* typedarraypool.free( arr.buffer );
 	*/
-	free( buf: RealOrComplexTypedArray | ArrayBuffer ): void;
+	free( buf: RealOrComplexTypedArray | BooleanArray | ArrayBuffer ): void;
 
 	/**
 	* Clears the typed array pool allowing garbage collection of previously allocated (and currently free) array buffers.