Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -674,6 +674,7 @@ A total of 37 issues were closed in this release:
 
 <details>
 
+-   [`da7ea70`](https://github.com/stdlib-js/stdlib/commit/da7ea70b7b2de281c4c1364fe7dca3ef8ca7085c) - **refactor:** support data type instances _(by Athan Reines)_
 -   [`b1623fe`](https://github.com/stdlib-js/stdlib/commit/b1623fe2c183124b2eb55736b4314329aea2856a) - **feat:** update `ndarray/base` TypeScript declarations [(#9420)](https://github.com/stdlib-js/stdlib/pull/9420) _(by stdlib-bot)_
 -   [`50367fe`](https://github.com/stdlib-js/stdlib/commit/50367fe8a498ac1e3e80fe688eb5c3df2d57a82d) - **feat:** add `toFlippedud` to namespace _(by Athan Reines)_
 -   [`e7d3d48`](https://github.com/stdlib-js/stdlib/commit/e7d3d486d1a9fc72f471b845d14f076d4f94ae60) - **feat:** add `toFlippedlr` to namespace _(by Athan Reines)_

base/binary-reduce-strided1d-dispatch/docs/repl.txt

@@ -29,11 +29,11 @@
         - arrays: array containing two input ndarrays, followed by any
         additional ndarray arguments.
 
-    idtypes: Array<Array<string>>
+    idtypes: Array<Array<string|DataType>>
         List containing lists of supported input array data types for each
         input ndarray argument.
 
-    odtypes: Array<string>
+    odtypes: Array<string|DataType>
         List of supported output array data types.
 
     policies: Object
@@ -105,9 +105,8 @@
     > var ord = 'row-major';
     > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, oo, ord );
     > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, sx, oo, ord );
-    > var z = f.apply( x, y );
-    > var v = z.get()
-    30.0
+    > var z = f.apply( x, y )
+    <ndarray>[ 30.0 ]
 
 
 {{alias}}.prototype.assign( x, y[, ...args], out[, options] )
@@ -158,11 +157,9 @@
     > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, sx, oo, ord );
     > var out = {{alias:@stdlib/ndarray/zeros}}( [], { 'dtype': dt } );
     > var z = f.assign( x, y, out )
-    <ndarray>
+    <ndarray>[ 30.0 ]
     > var bool = ( out === z )
     true
-    > var v = out.get()
-    30.0
 
     See Also
     --------

base/binary-reduce-strided1d-dispatch/docs/types/index.d.ts

@@ -153,10 +153,7 @@ declare class BinaryStrided1dDispatch<T, U> {
 	* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 	*
 	* var z = dot.apply( x, y );
-	* // returns <ndarray>
-	*
-	* var v = z.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*/
 	constructor( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies );
 
@@ -192,10 +189,7 @@ declare class BinaryStrided1dDispatch<T, U> {
 	* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 	*
 	* var z = dot.apply( x, y );
-	* // returns <ndarray>
-	*
-	* var v = z.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*/
 	apply( x: InputArray<T>, y: InputArray<T>, ...args: Array<InputArray<T> | Options> ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how the input ndarrays interact with output data type policy and whether that policy has been overridden by `options.dtype`. In principle, as well, based on the policy, it is possible to know more exactly which `InputArray` types are actually allowed.
 
@@ -235,10 +229,7 @@ declare class BinaryStrided1dDispatch<T, U> {
 	* var z = new ndarray( 'generic', zbuf, [], [ 0 ], 0, 'row-major' );
 	*
 	* var out = dot.assign( x, y, z );
-	* // returns <ndarray>
-	*
-	* var v = out.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*
 	* var bool = ( out === z );
 	* // returns true
@@ -281,10 +272,7 @@ declare class BinaryStrided1dDispatch<T, U> {
 	* var z = new ndarray( 'generic', zbuf, [], [ 0 ], 0, 'row-major' );
 	*
 	* var out = dot.assign( x, y, z );
-	* // returns <ndarray>
-	*
-	* var v = out.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*
 	* var bool = ( out === z );
 	* // returns true
@@ -329,10 +317,7 @@ interface BinaryStrided1dDispatchConstructor {
 	* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 	*
 	* var z = dot.apply( x, y );
-	* // returns <ndarray>
-	*
-	* var v = z.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*/
 	new<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): BinaryStrided1dDispatch<T, U>;
 
@@ -369,10 +354,7 @@ interface BinaryStrided1dDispatchConstructor {
 	* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 	*
 	* var z = dot.apply( x, y );
-	* // returns <ndarray>
-	*
-	* var v = z.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*/
 	<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): BinaryStrided1dDispatch<T, U>;
 }
@@ -410,10 +392,7 @@ interface BinaryStrided1dDispatchConstructor {
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot.apply( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 */
 declare var ctor: BinaryStrided1dDispatchConstructor;
 

base/binary-reduce-strided1d-dispatch/lib/index.js

@@ -48,10 +48,7 @@
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot.apply( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 */
 
 // MODULES //

base/binary-reduce-strided1d-dispatch/lib/main.js

@@ -33,11 +33,14 @@ var isFunctionArray = require( '@stdlib/assert/is-function-array' );
 var isDataType = require( './../../../base/assert/is-data-type' );
 var isOutputDataTypePolicy = require( './../../../base/assert/is-output-data-type-policy' );
 var isInputCastingPolicy = require( './../../../base/assert/is-input-casting-policy' );
+var isEqualDataType = require( './../../../base/assert/is-equal-data-type' );
 var contains = require( '@stdlib/array/base/assert/contains' );
 var binaryReduceStrided1d = require( './../../../base/binary-reduce-strided1d' );
 var binaryOutputDataType = require( './../../../base/binary-output-dtype' );
 var binaryInputCastingDataType = require( './../../../base/binary-input-casting-dtype' );
 var dtypes2enums = require( './../../../base/dtypes2enums' );
+var dtypes2strings = require( './../../../base/dtypes2strings' );
+var resolveStr = require( './../../../base/dtype-resolve-str' );
 var spreadDimensions = require( './../../../base/spread-dimensions' );
 var getShape = require( './../../../shape' ); // note: non-base accessor is intentional due to input ndarrays originating in userland
 var ndims = require( './../../../ndims' );
@@ -74,10 +77,10 @@ var DEFAULT_ORDER = defaults.get( 'order' );
 * @constructor
 * @param {Object} table - dispatch table
 * @param {Function} table.default - default strided reduction function
-* @param {StringArray} [table.types=[]] - one-dimensional list of ndarray data types describing specialized input ndarray argument signatures
+* @param {Array} [table.types=[]] - one-dimensional list of ndarray data types describing specialized input ndarray argument signatures
 * @param {ArrayLikeObject<Function>} [table.fcns=[]] - list of strided reduction functions which are specific to specialized input ndarray argument signatures
-* @param {ArrayLikeObject<StringArray>} idtypes - list containing lists of supported input data types for each input ndarray argument
-* @param {StringArray} odtypes - list of supported output data types
+* @param {ArrayLikeObject<Array>} idtypes - list containing lists of supported input data types for each input ndarray argument
+* @param {Array} odtypes - list of supported output data types
 * @param {Object} policies - policies
 * @param {string} policies.output - output data type policy
 * @param {string} policies.casting - input ndarray casting policy
@@ -112,10 +115,7 @@ var DEFAULT_ORDER = defaults.get( 'order' );
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot.apply( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 */
 function BinaryStrided1dDispatch( table, idtypes, odtypes, policies ) {
 	var dt;
@@ -138,6 +138,7 @@ function BinaryStrided1dDispatch( table, idtypes, odtypes, policies ) {
 	if ( !isCollection( idtypes ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be an array-like object. Value: `%s`.', idtypes ) );
 	}
+	idtypes = copy( idtypes );
 	for ( i = 0; i < idtypes.length; i++ ) {
 		dt = idtypes[ i ];
 		if (
@@ -147,6 +148,7 @@ function BinaryStrided1dDispatch( table, idtypes, odtypes, policies ) {
 		) {
 			throw new TypeError( format( 'invalid argument. Second argument must contain arrays of data types. Value: `%s`.', idtypes ) );
 		}
+		idtypes[ i ] = dtypes2strings( dt );
 	}
 	if (
 		!isCollection( odtypes ) ||
@@ -155,6 +157,8 @@ function BinaryStrided1dDispatch( table, idtypes, odtypes, policies ) {
 	) {
 		throw new TypeError( format( 'invalid argument. Third argument must be an array of data types. Value: `%s`.', odtypes ) );
 	}
+	odtypes = dtypes2strings( odtypes );
+
 	if ( !isObject( policies ) ) {
 		throw new TypeError( format( 'invalid argument. Fourth argument must be an object. Value: `%s`.', table ) );
 	}
@@ -226,10 +230,7 @@ function BinaryStrided1dDispatch( table, idtypes, odtypes, policies ) {
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot.apply( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 */
 setReadOnly( BinaryStrided1dDispatch.prototype, 'apply', function apply( x, y ) {
 	var options;
@@ -264,11 +265,11 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'apply', function apply( x, y )
 		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray-like object. Value: `%s`.', y ) );
 	}
 	xdt = getDType( x );
-	if ( !contains( this._idtypes[ 0 ], xdt ) ) {
+	if ( !contains( this._idtypes[ 0 ], resolveStr( xdt ) ) ) {
 		throw new TypeError( format( 'invalid argument. First argument must have one of the following data types: "%s". Data type: `%s`.', join( this._idtypes[ 0 ], '", "' ), xdt ) );
 	}
 	ydt = getDType( y );
-	if ( !contains( this._idtypes[ 1 ], ydt ) ) {
+	if ( !contains( this._idtypes[ 1 ], resolveStr( ydt ) ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must have one of the following data types: "%s". Data type: `%s`.', join( this._idtypes[ 1 ], '", "' ), ydt ) );
 	}
 	args = [ x, y ];
@@ -278,7 +279,7 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'apply', function apply( x, y )
 			break;
 		}
 		dt = getDType( arr );
-		if ( !contains( this._idtypes[ i ], dt ) ) {
+		if ( !contains( this._idtypes[ i ], resolveStr( dt ) ) ) {
 			throw new TypeError( format( 'invalid argument. Argument %d must have one of the following data types: "%s". Data type: `%s`.', i, join( this._idtypes[ i ], '", "' ), dt ) );
 		}
 		// Note: we don't type promote additional ndarray arguments, as they are passed as scalars to the underlying strided reduction function...
@@ -337,15 +338,15 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'apply', function apply( x, y )
 
 	// Determine whether we need to cast the input ndarrays...
 	dt = binaryInputCastingDataType( xdt, ydt, zdt, this._policies.casting );
-	if ( xdt !== dt ) {
+	if ( !isEqualDataType( xdt, dt ) ) {
 		// TODO: replace the following logic with a call to `ndarray/base/(?maybe-)(cast|convert|copy)` or similar utility
 		tmp = baseEmpty( dt, shx, ordx );
 		assign( [ x, tmp ] );
 		args[ 0 ] = tmp;
 		xdt = dt;
 	}
 	dt = binaryInputCastingDataType( ydt, xdt, zdt, this._policies.casting );
-	if ( ydt !== dt ) {
+	if ( !isEqualDataType( ydt, dt ) ) {
 		// TODO: replace the following logic with a call to `ndarray/base/(?maybe-)(cast|convert|copy)` or similar utility
 		tmp = baseEmpty( dt, shy, ordy );
 		assign( [ y, tmp ] );
@@ -419,10 +420,7 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'apply', function apply( x, y )
 * var z = new ndarray( 'generic', zbuf, [], [ 0 ], 0, 'row-major' );
 *
 * var out = dot.assign( x, y, z );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 *
 * var bool = ( out === z );
 * // returns true
@@ -457,11 +455,11 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'assign', function assign( x, y
 	}
 	// Validate the input ndarray data types in order to maintain similar behavior to `apply` above...
 	xdt = getDType( x );
-	if ( !contains( this._idtypes[ 0 ], xdt ) ) {
+	if ( !contains( this._idtypes[ 0 ], resolveStr( xdt ) ) ) {
 		throw new TypeError( format( 'invalid argument. First argument must have one of the following data types: "%s". Data type: `%s`.', join( this._idtypes[ 0 ], '", "' ), xdt ) );
 	}
 	ydt = getDType( y );
-	if ( !contains( this._idtypes[ 1 ], ydt ) ) {
+	if ( !contains( this._idtypes[ 1 ], resolveStr( ydt ) ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must have one of the following data types: "%s". Data type: `%s`.', join( this._idtypes[ 1 ], '", "' ), ydt ) );
 	}
 	// Verify that both input arrays have the same shape:
@@ -505,7 +503,7 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'assign', function assign( x, y
 	// Verify that additional ndarray arguments have expected dtypes (note: we intentionally don't validate the output ndarray dtype in order to provide an escape hatch for a user wanting to have an output ndarray having a specific dtype that `apply` does not support; note: we don't type promote additional ndarray arguments, as they are passed as scalars to the underlying strided reduction function)...
 	for ( i = 2; i < args.length; i++ ) {
 		dt = getDType( args[ i ] );
-		if ( !contains( this._idtypes[ i ], dt ) ) {
+		if ( !contains( this._idtypes[ i ], resolveStr( dt ) ) ) {
 			throw new TypeError( format( 'invalid argument. Argument %d must have one of the following data types: "%s". Data type: `%s`.', i, join( this._idtypes[ i ], '", "' ), dt ) );
 		}
 	}
@@ -525,15 +523,15 @@ setReadOnly( BinaryStrided1dDispatch.prototype, 'assign', function assign( x, y
 	// Determine whether we need to cast the input ndarrays...
 	zdt = getDType( z );
 	dt = binaryInputCastingDataType( xdt, ydt, zdt, this._policies.casting );
-	if ( xdt !== dt ) {
+	if ( !isEqualDataType( xdt, dt ) ) {
 		// TODO: replace the following logic with a call to `ndarray/base/(?maybe-)(cast|convert|copy)` or similar utility
 		tmp = baseEmpty( dt, shx, getOrder( x ) );
 		assign( [ x, tmp ] );
 		args[ 0 ] = tmp;
 		xdt = dt;
 	}
 	dt = binaryInputCastingDataType( ydt, xdt, zdt, this._policies.casting );
-	if ( ydt !== dt ) {
+	if ( !isEqualDataType( ydt, dt ) ) {
 		// TODO: replace the following logic with a call to `ndarray/base/(?maybe-)(cast|convert|copy)` or similar utility
 		tmp = baseEmpty( dt, shy, getOrder( y ) );
 		assign( [ y, tmp ] );

base/binary-reduce-strided1d-dispatch/lib/validate.js

@@ -26,6 +26,7 @@ var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
 var isIntegerArray = require( '@stdlib/assert/is-integer-array' ).primitives;
 var isEmptyCollection = require( '@stdlib/assert/is-empty-collection' );
 var normalizeIndices = require( './../../../base/to-unique-normalized-indices' );
+var resolveStr = require( './../../../base/dtype-resolve-str' );
 var join = require( '@stdlib/array/base/join' );
 var contains = require( '@stdlib/array/base/assert/contains' );
 var format = require( '@stdlib/string/format' );
@@ -85,7 +86,7 @@ function validate( opts, ndims, dtypes, options ) {
 	}
 	if ( hasOwnProp( options, 'dtype' ) ) {
 		opts.dtype = options.dtype;
-		if ( !contains( dtypes, String( opts.dtype ) ) ) {
+		if ( !contains( dtypes, resolveStr( opts.dtype ) ) ) {
 			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', join( dtypes, '", "' ), opts.dtype ) );
 		}
 	}