Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -675,6 +675,12 @@ A total of 37 issues were closed in this release:
 
 <details>
 
+-   [`322b8cb`](https://github.com/stdlib-js/stdlib/commit/322b8cb870769d9198ddbcd0b89610b185ab57ff) - **build:** ensure dtypes are strings _(by Athan Reines)_
+-   [`387beea`](https://github.com/stdlib-js/stdlib/commit/387beea5c84c7bd4f0aab41ec35e49819275c9b0) - **build:** ensure dtypes are strings _(by Athan Reines)_
+-   [`2a887b7`](https://github.com/stdlib-js/stdlib/commit/2a887b7eb76a7f0ecc48133049868395b90ff196) - **refactor:** support data type instances _(by Athan Reines)_
+-   [`760719b`](https://github.com/stdlib-js/stdlib/commit/760719b492247734f2778d4ace525d6719b2d202) - **refactor:** normalize a data type to a string _(by Athan Reines)_
+-   [`a52bc78`](https://github.com/stdlib-js/stdlib/commit/a52bc786e790aa242a563cdaefb58107b6cd2d9b) - **refactor:** normalize a provided data type to a string _(by Athan Reines)_
+-   [`982208c`](https://github.com/stdlib-js/stdlib/commit/982208cf3c840a5f3ff23378056cd7843dc1e173) - **docs:** update dtype type _(by Athan Reines)_
 -   [`6c43167`](https://github.com/stdlib-js/stdlib/commit/6c4316733d615b06d301eec89c377838a6b56dd8) - **fix:** resolve normalized data type _(by Athan Reines)_
 -   [`697b9ed`](https://github.com/stdlib-js/stdlib/commit/697b9edd6f85e39a03bed4f142814238bb3cdce8) - **docs:** update examples and docs to accommodate data type instances _(by Athan Reines)_
 -   [`452cc00`](https://github.com/stdlib-js/stdlib/commit/452cc003a69938f9cdce6ed45219f41673af1c1f) - **docs:** update example _(by Athan Reines)_

base/binary-tiling-block-size/docs/repl.txt

@@ -4,13 +4,13 @@
 
     Parameters
     ----------
-    dtypeX: string
+    dtypeX: string|DataType
         First input array data type.
 
-    dtypeY: string
+    dtypeY: string|DataType
         Second input array data type.
 
-    dtypeZ: string
+    dtypeZ: string|DataType
         Output array data type.
 
     Returns

base/binary-tiling-block-size/docs/types/index.d.ts

@@ -18,6 +18,10 @@
 
 // TypeScript Version: 4.1
 
+/// <reference types="@stdlib/types"/>
+
+import { DataType } from '@stdlib/types/ndarray';
+
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
@@ -30,7 +34,7 @@
 * var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
 * // returns <number>
 */
-declare function binaryBlockSize( dtypeX: string, dtypeY: string, dtypeZ: string ): number;
+declare function binaryBlockSize( dtypeX: DataType, dtypeY: DataType, dtypeZ: DataType ): number;
 
 
 // EXPORTS //

base/binary-tiling-block-size/docs/types/test.ts

@@ -27,7 +27,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( 'generic', 'generic', 'generic' ); // $ExpectType number
 }
 
-// The compiler throws an error if the function is provided a first argument which is not a string...
+// The compiler throws an error if the function is provided a first argument which is not a valid data type...
 {
 	binaryBlockSize( 123, 'float64', 'float64' ); // $ExpectError
 	binaryBlockSize( true, 'float64', 'float64' ); // $ExpectError
@@ -38,7 +38,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( ( x: number ): number => x, 'float64', 'float64' ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument which is not a string...
+// The compiler throws an error if the function is provided a second argument which is not a valid data type...
 {
 	binaryBlockSize( 'int32', 123, 'int32' ); // $ExpectError
 	binaryBlockSize( 'int32', true, 'int32' ); // $ExpectError
@@ -49,7 +49,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( 'int32', ( x: number ): number => x, 'int32' ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a third argument which is not a string...
+// The compiler throws an error if the function is provided a third argument which is not a valid data type...
 {
 	binaryBlockSize( 'int32', 'int32', 123 ); // $ExpectError
 	binaryBlockSize( 'int32', 'int32', true ); // $ExpectError

base/binary-tiling-block-size/lib/main.js

@@ -29,9 +29,9 @@ var defaults = require( './defaults.js' );
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
-* @param {string} dtypeX - first input array data type
-* @param {string} dtypeY - second input array data type
-* @param {string} dtypeZ - output array data type
+* @param {*} dtypeX - first input array data type
+* @param {*} dtypeY - second input array data type
+* @param {*} dtypeZ - output array data type
 * @returns {integer} block size (in units of elements)
 *
 * @example

base/broadcast-scalar/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # broadcastScalar
 
-> Broadcast a scalar value to an [`ndarray`][@stdlib/ndarray/base/ctor] having a specified shape.
+> Broadcast a scalar value to an [ndarray][@stdlib/ndarray/base/ctor] having a specified shape.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,7 +42,7 @@ var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
 
 #### broadcastScalar( value, dtype, shape, order )
 
-Broadcasts a scalar value to an [`ndarray`][@stdlib/ndarray/base/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
+Broadcasts a scalar value to an [ndarray][@stdlib/ndarray/base/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
 
 ```javascript
 var getShape = require( '@stdlib/ndarray/shape' );
@@ -71,9 +71,9 @@ var v = x.get( 0, 0 );
 
 ## Notes
 
--   If `value` is a number and [`dtype`][@stdlib/ndarray/dtypes] is a complex [data type][@stdlib/ndarray/dtypes], the function returns an [`ndarray`][@stdlib/ndarray/base/ctor] containing a complex number whose real component equals the provided scalar `value` and whose imaginary component is zero.
+-   If `value` is a number and [`dtype`][@stdlib/ndarray/dtypes] is a complex [data type][@stdlib/ndarray/dtypes], the function returns an [ndarray][@stdlib/ndarray/base/ctor] containing a complex number whose real component equals the provided scalar `value` and whose imaginary component is zero.
 -   The returned [ndarray][@stdlib/ndarray/base/ctor] is a view on an [ndarray][@stdlib/ndarray/base/ctor] data buffer containing a single element. The view is **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned [ndarray][@stdlib/ndarray/base/ctor], copy the [ndarray][@stdlib/ndarray/base/ctor] **before** performing operations which may mutate elements.
--   The returned [ndarray][@stdlib/ndarray/base/ctor] is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast a scalar value as an [`ndarray`][@stdlib/ndarray/base/ctor] within internal implementations and to do so with minimal overhead.
+-   The returned [ndarray][@stdlib/ndarray/base/ctor] is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast a scalar value as an [ndarray][@stdlib/ndarray/base/ctor] within internal implementations and to do so with minimal overhead.
 
 </section>
 

base/broadcast-scalar/docs/repl.txt

@@ -43,8 +43,6 @@
     <ndarray>
     > var sh = {{alias:@stdlib/ndarray/shape}}( x )
     [ 2, 2 ]
-    > var dt = {{alias:@stdlib/ndarray/dtype}}( x )
-    'float64'
     > var v = x.get( 0, 1 )
     1.0
 

base/broadcast-scalar/docs/types/index.d.ts

@@ -42,7 +42,7 @@ import { ndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, in
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'float64'
 *
 * var v = x.get( 0, 1 );
@@ -69,7 +69,7 @@ declare function broadcastScalar( value: number, dtype: 'float64', shape: Shape,
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'float32'
 *
 * var v = x.get( 0, 1 );
@@ -103,7 +103,7 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'complex128'
 *
 * var v = x.get( 0, 1 );
@@ -139,7 +139,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'complex64'
 *
 * var v = x.get( 0, 1 );
@@ -172,7 +172,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex64
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'int32'
 *
 * var v = x.get( 0, 1 );
@@ -199,7 +199,7 @@ declare function broadcastScalar( value: number, dtype: 'int32', shape: Shape, o
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'int16'
 *
 * var v = x.get( 0, 1 );
@@ -226,7 +226,7 @@ declare function broadcastScalar( value: number, dtype: 'int16', shape: Shape, o
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'int8'
 *
 * var v = x.get( 0, 1 );
@@ -253,7 +253,7 @@ declare function broadcastScalar( value: number, dtype: 'int8', shape: Shape, or
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'uint32'
 *
 * var v = x.get( 0, 1 );
@@ -280,7 +280,7 @@ declare function broadcastScalar( value: number, dtype: 'uint32', shape: Shape,
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'uint16'
 *
 * var v = x.get( 0, 1 );
@@ -307,7 +307,7 @@ declare function broadcastScalar( value: number, dtype: 'uint16', shape: Shape,
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'uint8'
 *
 * var v = x.get( 0, 1 );
@@ -334,7 +334,7 @@ declare function broadcastScalar( value: number, dtype: 'uint8', shape: Shape, o
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'uint8c'
 *
 * var v = x.get( 0, 1 );
@@ -361,7 +361,7 @@ declare function broadcastScalar( value: number, dtype: 'uint8c', shape: Shape,
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'generic'
 *
 * var v = x.get( 0, 1 );

base/broadcast-scalar/lib/index.js

@@ -34,7 +34,7 @@
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'float64'
 *
 * var v = x.get( 0, 1 );

base/broadcast-scalar/lib/main.js

@@ -28,6 +28,7 @@ var setter = require( '@stdlib/array/base/setter' );
 var zeros = require( '@stdlib/array/base/zeros' );
 var buffer = require( './../../../base/buffer' );
 var ndarray = require( './../../../base/ctor' );
+var resolveStr = require( './../../../base/dtype-resolve-str' );
 var format = require( '@stdlib/string/format' );
 
 
@@ -53,7 +54,7 @@ var format = require( '@stdlib/string/format' );
 * var sh = getShape( x );
 * // returns [ 2, 2 ]
 *
-* var dt = getDType( x );
+* var dt = String( getDType( x ) );
 * // returns 'float64'
 *
 * var v = x.get( 0, 1 );
@@ -68,6 +69,7 @@ function broadcastScalar( value, dtype, shape, order ) {
 	if ( buf === null ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be a recognized data type. Value: `%s`.', dtype ) );
 	}
+	dtype = resolveStr( dtype );
 	if ( isComplexDataType( dtype ) && isNumber( value ) ) {
 		value = [ value, 0.0 ]; // note: we're assuming that the ComplexXXArray setter accepts an array of interleaved real and imaginary components
 	}