refactor: apply suggestions from code review

Author: headlessNode

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d-dispatch-factory/README.md

@@ -32,7 +32,7 @@ limitations under the License.
 var nullaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
 ```
 
-#### nullaryStrided1dDispatchFactory( table, odtypes, policies\[, options] )
+#### nullaryStrided1dDispatchFactory( table, idtypes, odtypes\[, options] )
 
 Returns a function for applying a strided function to an output ndarray.
 
@@ -46,11 +46,8 @@ var table = {
 };
 
 var dtypes = [ 'float64', 'float32', 'generic' ];
-var policies = {
-    'output': 'same'
-};
 
-var nullary = nullaryStrided1dDispatchFactory( table, [ dtypes ], policies );
+var nullary = nullaryStrided1dDispatchFactory( table, [ dtypes ], dtypes );
 ```
 
 The function has the following parameters:
@@ -64,11 +61,9 @@ The function has the following parameters:
     -   **types**: one-dimensional list of ndarray data types describing specialized output ndarray argument signatures. Only the output ndarray argument data types should be specified. Additional ndarray argument data types should be omitted and are not considered during dispatch. The length of `types` must equal the number of strided functions specified by `fcns`.
     -   **fcns**: list of strided functions which are specific to specialized output ndarray argument signatures.
 
--   **odtypes**: list containing lists of supported output data types for each input ndarray argument.
-
--   **policies**: dispatch policies. Must have the following properties:
+-   **idtypes**: list containing lists of supported input data types for each input ndarray argument.
 
-    -   **output**: output data type [policy][@stdlib/ndarray/output-dtype-policies].
+-   **odtypes**: list of supported output data types.
 
 -   **options**: function options (_optional_).
 
@@ -89,15 +84,13 @@ var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var ndarray = require( '@stdlib/ndarray/base/ctor' );
 
-var odt = dtypes( 'real_and_generic' );
-var policies = {
-    'output': 'same'
-};
+var idt = dtypes( 'real_and_generic' );
+var odt = dtypes( 'all' );
 
 var table = {
     'default': base
 };
-var nullary = nullaryStrided1dDispatchFactory( table, [ odt ], policies );
+var nullary = nullaryStrided1dDispatchFactory( table, [ idt ], odt );
 
 var xbuf = [ -1.0, 2.0, -3.0 ];
 var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -169,14 +162,10 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var ndarray = require( '@stdlib/ndarray/ctor' );
 var nullaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
 
-// Define the supported output data types:
+// Define the supported input and output data types:
+var idt = dtypes( 'real_and_generic' );
 var odt = dtypes( 'all' );
 
-// Define dispatch policies:
-var policies = {
-    'output': 'same'
-};
-
 // Define a dispatch table:
 var table = {
     'types': [
@@ -191,7 +180,7 @@ var table = {
 };
 
 // Create an interface for performing an operation:
-var sorthp = nullaryStrided1dDispatchFactory( table, [ odt ], policies );
+var sorthp = nullaryStrided1dDispatchFactory( table, [ idt ], odt );
 
 // Generate an array of random numbers:
 var xbuf = discreteUniform( 25, -10, 10, {
@@ -207,9 +196,7 @@ var o = scalar2ndarray( 1.0, {
 });
 
 // Perform operation:
-sorthp.assign( x, o, {
-    'dims': [ 0 ]
-});
+sorthp.assign( x, o );
 
 // Print the results:
 console.log( ndarray2array( x ) );
@@ -231,8 +218,6 @@ console.log( ndarray2array( x ) );
 
 <section class="links">
 
-[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies
-
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d-dispatch-factory/benchmark/benchmark.assign.js

@@ -42,21 +42,19 @@ var factory = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var policies;
 	var nullary;
 	var table;
-	var dt;
+	var idt;
+	var odt;
 	var x;
 	var o;
 
 	table = {
 		'default': gsorthp
 	};
-	dt = dtypes( 'all' );
-	policies = {
-		'output': 'same'
-	};
-	nullary = factory( table, [ dt ], policies );
+	idt = dtypes( 'real_and_generic' );
+	odt = dtypes( 'all' );
+	nullary = factory( table, [ idt ], odt );
 
 	x = uniform( len, -50.0, 50.0, {
 		'dtype': 'float64'

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d-dispatch-factory/benchmark/benchmark.js

@@ -29,26 +29,27 @@ var factory = require( './../lib' );
 // MAIN //
 
 bench( pkg+'::factory', function benchmark( b ) {
-	var policies;
-	var dtypes;
+	var idtypes;
+	var odtypes;
 	var table;
 	var v;
 	var i;
 
 	table = {
 		'default': gsorthp
 	};
-	dtypes = [
+	idtypes = [
+		'float64',
+		'float32'
+	];
+	odtypes = [
 		'float64',
 		'float32'
 	];
-	policies = {
-		'output': 'same'
-	};
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = factory( table, [ dtypes ], policies );
+		v = factory( table, [ idtypes ], odtypes );
 		if ( typeof v !== 'function' ) {
 			b.fail( 'should return a function' );
 		}

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d-dispatch-factory/docs/repl.txt

@@ -1,5 +1,5 @@
 
-{{alias}}( table, odtypes, policies[, options] )
+{{alias}}( table, idtypes, odtypes[, options] )
     Returns function for applying a strided function to an output ndarray.
 
     Parameters
@@ -28,14 +28,12 @@
         - arrays: array containing an output ndarray, followed by any additional
         ndarray arguments.
 
-    odtypes: Array<Array<string>>
-        List containing lists of supported output array data types for each
-        output ndarray argument.
+    idtypes: Array<Array<string>>
+        List containing lists of supported input data types for each input
+        ndarray argument.
 
-    policies: Object
-        Dispatch policies. Must have the following properties:
-
-        - output: output data type policy.
+    odtypes: Array<string>
+        List of supported output data types.
 
     options: Object (optional)
         Function options.
@@ -51,10 +49,10 @@
 
     Examples
     --------
-    > var dt = [ 'float64', 'float32', 'generic' ];
-    > var p = { 'output': 'same' };
+    > var idt = [ 'float64', 'float32', 'generic' ];
+    > var odt = [ 'float64', 'float32', 'generic' ];
     > var t = { 'default': {{alias:@stdlib/blas/ext/base/ndarray/gsorthp}} };
-    > var f = {{alias}}( t, [ dt ], p );
+    > var f = {{alias}}( t, [ idt ], odt );
 
 fcn.assign( x[, ...args][, options] )
     Applies a strided function and assign results to a provided output ndarray.
@@ -82,10 +80,10 @@ fcn.assign( x[, ...args][, options] )
 
     Examples
     --------
-    > var dts = [ 'float64', 'float32', 'generic' ];
-    > var p = { 'output': 'same' };
+    > var idt = [ 'float64', 'float32', 'generic' ];
+    > var odt = [ 'float64', 'float32', 'generic' ];
     > var t = { 'default': {{alias:@stdlib/blas/ext/base/ndarray/gsorthp}} };
-    > var f = {{alias}}( t, [ dts ], p );
+    > var f = {{alias}}( t, [ idt ], odt );
     > var buf = [ -1.0, 2.0, -3.0, -4.0 ];
     > var dt = 'generic';
     > var sh = [ buf.length ];

lib/node_modules/@stdlib/ndarray/base/nullary-strided1d-dispatch-factory/docs/types/index.d.ts

@@ -21,7 +21,7 @@
 /// <reference types="@stdlib/types"/>
 
 import { ArrayLike } from '@stdlib/types/array';
-import { OutputPolicy, DataType, typedndarray } from '@stdlib/types/ndarray';
+import { DataType, typedndarray } from '@stdlib/types/ndarray';
 
 /**
 * Input array.
@@ -96,15 +96,6 @@ interface DispatchTable<T> extends BaseDispatchTable<T> {
 	fcns: ArrayLike<Nullary<T> | NullaryWithAdditionalArrays<T>>;
 }
 
-/**
-* Dispatch policies.
-*/
-interface Policies {
-	/**
-	* Output data type policy.
-	*/
-	output: OutputPolicy;
-}
 
 /**
 * Interface for applying an operation to an ndarray.
@@ -124,20 +115,22 @@ interface NullaryFunction<T> {
 	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var ndarray = require( '@stdlib/ndarray/base/ctor' );
 	*
+	* var idt = dtypes( 'real_and_generic' );
 	* var odt = dtypes( 'all' );
-	* var policies = {
-	*     'output': 'same'
-	* };
 	*
 	* var table = {
 	*     'default': base
 	* };
-	* var sorthp = factory( table, [ odt ], policy );
+	* var sorthp = factory( table, [ idt ], odt );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
 	*
-	* var out = sorthp.assign( x );
+	* var o = scalar2ndarray( 1.0, {
+	*     'dtype': 'generic'
+	* });
+	*
+	* var out = sorthp.assign( x, o );
 	* // returns <ndarray>
 	*
 	* var arr = ndarray2array( out );
@@ -163,15 +156,13 @@ interface NullaryFunction<T> {
 	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var ndarray = require( '@stdlib/ndarray/base/ctor' );
 	*
+	* var idt = dtypes( 'real_and_generic' );
 	* var odt = dtypes( 'all' );
-	* var policies = {
-	*     'output': 'same'
-	* };
 	*
 	* var table = {
 	*     'default': base
 	* };
-	* var sorthp = factory( table, [ odt ], policy );
+	* var sorthp = factory( table, [ idt ], odt );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -196,10 +187,10 @@ interface NullaryFunction<T> {
 * Creates a function for applying a strided function to an output ndarray.
 *
 * @param table - dispatch table
-* @param odtypes - list containing lists of supported output data types for each ndarray argument
-* @param policies - dispatch policies
+* @param idtypes - list containing lists of supported input data types for each ndarray argument
+* @param odtypes - list of supported output data types
 * @param options - function options
-* @returns function for applying a unary function
+* @returns function for applying a nullary function
 *
 * @example
 * var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
@@ -208,15 +199,13 @@ interface NullaryFunction<T> {
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
+* var idt = dtypes( 'real_and_generic' );
 * var odt = dtypes( 'all' );
-* var policies = {
-*     'output': 'same'
-* };
 *
 * var table = {
 *     'default': base
 * };
-* var sorthp = factory( table, [ odt ], policy );
+* var sorthp = factory( table, [ idt ], odt );
 *
 * var xbuf = [ -1.0, 2.0, -3.0 ];
 * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -234,7 +223,7 @@ interface NullaryFunction<T> {
 * var bool = ( out === x );
 * // returns true
 */
-declare function factory<T = unknown>( table: DispatchTable<T> | BaseDispatchTable<T>, odtypes: ArrayLike<ArrayLike<DataType>>, policies: Policies, options?: FactoryOptions ): NullaryFunction<T>;
+declare function factory<T = unknown>( table: DispatchTable<T> | BaseDispatchTable<T>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, options?: FactoryOptions ): NullaryFunction<T>;
 
 
 // EXPORTS //