Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -1988,6 +1988,7 @@ This release closes the following issue:
 
 ##### Features
 
+-   [`4816901`](https://github.com/stdlib-js/stdlib/commit/481690174833259628032a259dbe7d26bbde807d) - add boolean dtype support to `array/typed` [(#2419)](https://github.com/stdlib-js/stdlib/pull/2419)
 -   [`819d2e4`](https://github.com/stdlib-js/stdlib/commit/819d2e407146d4dcc17f8bab53b591b3d573f8a1) - add data type maps and replace use of overloads [(#1317)](https://github.com/stdlib-js/stdlib/pull/1317)
 
 </section>
@@ -2187,6 +2188,7 @@ A total of 13 people contributed to this release. Thank you to the following con
 
 <details>
 
+-   [`4816901`](https://github.com/stdlib-js/stdlib/commit/481690174833259628032a259dbe7d26bbde807d) - **feat:** add boolean dtype support to `array/typed` [(#2419)](https://github.com/stdlib-js/stdlib/pull/2419) _(by Jaysukh Makvana, Athan Reines)_
 -   [`bd678e5`](https://github.com/stdlib-js/stdlib/commit/bd678e56ad259f1424590d1e1ce213dc038cc676) - **feat:** update namespace TypeScript declarations [(#2425)](https://github.com/stdlib-js/stdlib/pull/2425) _(by stdlib-bot, Athan Reines)_
 -   [`4f30f21`](https://github.com/stdlib-js/stdlib/commit/4f30f213c8ec0a95cdcd7dfe7e7a6bf4bec8bd36) - **feat:** add boolean dtype support to `array/reviver` [(#2420)](https://github.com/stdlib-js/stdlib/pull/2420) _(by Jaysukh Makvana)_
 -   [`42c67e7`](https://github.com/stdlib-js/stdlib/commit/42c67e76cdf919e4e43ff9333d9acc6177eb5558) - **feat:** add `every` and `some` methods to `array/bool` [(#2421)](https://github.com/stdlib-js/stdlib/pull/2421) _(by Jaysukh Makvana, Athan Reines)_

typed/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 Arrays
+# typedarray
 
 > Create a typed array.
 
@@ -42,28 +42,14 @@ var typedarray = require( '@stdlib/array/typed' );
 
 #### typedarray( \[dtype] )
 
-Creates a [typed array][mdn-typed-array] having a specified data type `dtype`.
+Creates a [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes].
 
 ```javascript
 var arr = typedarray();
 // returns <Float64Array>
 ```
 
-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] data type is `float64`. To specify an alternative data type, provide a `dtype` argument.
+By default, the output [typed array][mdn-typed-array] data type is `float64`. To specify an alternative data type, provide a [`dtype`][@stdlib/array/typed-dtypes] argument.
 
 ```javascript
 var arr = typedarray( 'int32' );
@@ -109,7 +95,7 @@ var arr2 = typedarray( [ 0.5, 0.5, 0.5 ], 'float32' );
 // returns <Float32Array>[ 0.5, 0.5, 0.5 ]
 ```
 
-If `dtype` is complex number data type and an array-like object contains interleaved real and imaginary components, the array-like object must have a length which is a multiple of two.
+If [`dtype`][@stdlib/array/typed-dtypes] is complex number data type and an array-like object contains interleaved real and imaginary components, the array-like object must have a length which is a multiple of two.
 
 #### typedarray( buffer\[, byteOffset\[, length]]\[, dtype] )
 
@@ -148,7 +134,7 @@ var arr6 = typedarray( buf, 10, 4, 'int16' );
 
 ## Notes
 
--   When providing a complex number array, if `dtype` is unspecified or the specified data type is not a complex number data type, the returned array contains interleaved real and imaginary components.
+-   When providing a complex number array, if [`dtype`][@stdlib/array/typed-dtypes] is unspecified or the specified data type is not a complex number data type, the returned array contains interleaved real and imaginary components.
 
 </section>
 
@@ -219,6 +205,8 @@ console.log( arr );
 
 [mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
 
+[@stdlib/array/typed-dtypes]: https://github.com/stdlib-js/array/tree/main/typed-dtypes
+
 <!-- <related-links> -->
 
 [@stdlib/array/complex128]: https://github.com/stdlib-js/array/tree/main/complex128

typed/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' );
 
@@ -119,6 +120,24 @@ bench( pkg+':dtype=complex64', 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=int32', function benchmark( b ) {
 	var arr;
 	var i;

typed/benchmark/benchmark.length.bool.js

@@ -0,0 +1,93 @@
+/**
+* @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 {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( 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 = typedarray( len, 'bool' );
+			if ( arr.length !== len ) {
+				b.fail( 'unexpected length' );
+			}
+		}
+		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( len );
+		bench( pkg+':dtype=bool,len='+len, f );
+	}
+}
+
+main();

typed/docs/repl.txt

@@ -2,22 +2,6 @@
 {{alias}}( [dtype] )
     Creates a typed array.
 
-    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)

typed/lib/main.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.
@@ -24,6 +24,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 var ctors = require( './../../typed-ctors' );
 var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' );
 var reinterpret64 = require( '@stdlib/strided/base/reinterpret-complex64' );
+var reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
 var defaults = require( './../../defaults' );
 var format = require( '@stdlib/string/format' );
 
@@ -33,6 +34,7 @@ var format = require( '@stdlib/string/format' );
 var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
 var Complex64Array = ctors( 'complex64' );
 var Complex128Array = ctors( 'complex128' );
+var BooleanArray = ctors( 'bool' );
 
 
 // MAIN //
@@ -147,6 +149,8 @@ function typedarray() {
 			arg = reinterpret64( arg, 0 );
 		} else if ( arg instanceof Complex128Array ) {
 			arg = reinterpret128( arg, 0 );
+		} else if ( arg instanceof BooleanArray ) {
+			arg = reinterpretBoolean( arg, 0 );
 		}
 		return new ctor( arg );
 	}