Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -674,6 +674,11 @@ A total of 37 issues were closed in this release:
 
 <details>
 
+-   [`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)_
+-   [`5e87686`](https://github.com/stdlib-js/stdlib/commit/5e87686d428b0ae5570c1f0c56d4c6721b13643d) - **docs:** update examples to use ndarray instance notation _(by Athan Reines)_
+-   [`67fe5f8`](https://github.com/stdlib-js/stdlib/commit/67fe5f8d3c4f7c7bbb322e648d48a462960b4b99) - **docs:** update type _(by Athan Reines)_
+-   [`85d47b6`](https://github.com/stdlib-js/stdlib/commit/85d47b6504ee90577497e26357afa6e63c101df6) - **docs:** update types _(by Athan Reines)_
 -   [`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)_

base/binary-reduce-strided1d-dispatch-factory/README.md

@@ -103,10 +103,7 @@ var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
 var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 
 var z = binary( x, y );
-// returns <ndarray>
-
-var v = z.get();
-// returns -5.0
+// returns <ndarray>[ -5.0 ]
 ```
 
 The function has the following parameters:
@@ -154,7 +151,7 @@ var z = binary( x, y, {
 });
 // returns <ndarray>
 
-var dt = getDType( z );
+var dt = String( getDType( z ) );
 // returns 'float64'
 ```
 
@@ -191,10 +188,7 @@ var zbuf = [ 0.0 ];
 var z = new ndarray( 'generic', zbuf, [], [ 0 ], 0, 'row-major' );
 
 var out = binary.assign( x, y, z );
-// returns <ndarray>
-
-var v = out.get();
-// returns -5.0
+// returns <ndarray>[ -5.0 ]
 
 var bool = ( out === z );
 // returns true
@@ -300,7 +294,7 @@ var z = dot( x, y, {
 
 // Resolve the output array data type:
 var dt = dtype( z );
-console.log( dt );
+console.log( String( dt ) );
 
 // Print the results:
 console.log( ndarray2array( z ) );

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

@@ -28,11 +28,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
@@ -104,9 +104,8 @@ fcn( x, y[, ...args][, options] )
     > 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( x, y );
-    > var v = z.get()
-    30.0
+    > var z = f( x, y )
+    <ndarray>[ 30.0 ]
 
 
 fcn.assign( x, y[, ...args], out[, options] )
@@ -157,11 +156,9 @@ fcn.assign( x, y[, ...args], out[, options] )
     > 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-factory/docs/types/index.d.ts

@@ -152,10 +152,7 @@ interface BinaryFunction<T, U> {
 	* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 	*
 	* var z = dot( x, y );
-	* // returns <ndarray>
-	*
-	* var v = z.get();
-	* // returns -5.0
+	* // returns <ndarray>[ -5.0 ]
 	*/
 	( 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.
 
@@ -195,10 +192,7 @@ interface BinaryFunction<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
@@ -241,10 +235,7 @@ interface BinaryFunction<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
@@ -285,10 +276,7 @@ interface BinaryFunction<T, U> {
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 */
 declare function factory<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): BinaryFunction<T, U>;
 

base/binary-reduce-strided1d-dispatch-factory/examples/index.js

@@ -75,7 +75,7 @@ var z = dot( x, y, {
 
 // Resolve the output array data type:
 var dt = dtype( z );
-console.log( dt );
+console.log( String( dt ) );
 
 // Print the results:
 console.log( ndarray2array( z ) );

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

@@ -48,10 +48,7 @@
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 *
 * @example
 * var base = require( '@stdlib/blas/base/ndarray/gdot' );
@@ -81,10 +78,7 @@
 * 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

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

@@ -31,10 +31,10 @@ var BinaryStrided1dDispatch = require( './../../../base/binary-reduce-strided1d-
 *
 * @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 {ArrayLikeObject} [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 ndarray argument
-* @param {StringArray} odtypes - list of supported output data types
+* @param {ArrayLikeObject<ArrayLikeObject>} idtypes - list containing lists of supported input data types for each ndarray argument
+* @param {ArrayLikeObject} 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
@@ -69,10 +69,7 @@ var BinaryStrided1dDispatch = require( './../../../base/binary-reduce-strided1d-
 * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var z = dot( x, y );
-* // returns <ndarray>
-*
-* var v = z.get();
-* // returns -5.0
+* // returns <ndarray>[ -5.0 ]
 *
 * @example
 * var base = require( '@stdlib/blas/base/ndarray/gdot' );
@@ -101,10 +98,7 @@ var BinaryStrided1dDispatch = require( './../../../base/binary-reduce-strided1d-
 * 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

base/binary-reduce-strided1d-dispatch/README.md

@@ -99,10 +99,7 @@ var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
 var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
 
 var z = binary.apply( x, y );
-// returns <ndarray>
-
-var v = z.get();
-// returns -5.0
+// returns <ndarray>[ -5.0 ]
 ```
 
 The method has the following parameters:
@@ -148,7 +145,7 @@ var z = binary.apply( x, y, {
 });
 // returns <ndarray>
 
-var dt = getDType( z );
+var dt = String( getDType( z ) );
 // returns 'float64'
 ```
 
@@ -183,10 +180,7 @@ var zbuf = [ 0.0 ];
 var z = new ndarray( 'generic', zbuf, [], [ 0 ], 0, 'row-major' );
 
 var out = binary.assign( x, y, z );
-// returns <ndarray>
-
-var v = out.get();
-// returns -5.0
+// returns <ndarray>[ -5.0 ]
 
 var bool = ( out === z );
 // returns true
@@ -290,7 +284,7 @@ var z = dot.apply( x, y, {
 
 // Resolve the output array data type:
 var dt = dtype( z );
-console.log( dt );
+console.log( String( dt ) );
 
 // Print the results:
 console.log( ndarray2array( z ) );

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

@@ -75,7 +75,7 @@ var z = dot.apply( x, y, {
 
 // Resolve the output array data type:
 var dt = dtype( z );
-console.log( dt );
+console.log( String( dt ) );
 
 // Print the results:
 console.log( ndarray2array( z ) );

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

@@ -77,10 +77,10 @@ var DEFAULT_ORDER = defaults.get( 'order' );
 * @constructor
 * @param {Object} table - dispatch table
 * @param {Function} table.default - default strided reduction function
-* @param {Array} [table.types=[]] - one-dimensional list of ndarray data types describing specialized input ndarray argument signatures
+* @param {ArrayLikeObject} [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<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 {ArrayLikeObject<ArrayLikeObject>} idtypes - list containing lists of supported input data types for each input ndarray argument
+* @param {ArrayLikeObject} 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