refactor!: replace policy string argument with a policy object

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: skipped
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

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

@@ -32,7 +32,7 @@ limitations under the License.
 var unaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory' );
 ```
 
-#### unaryStrided1dDispatchFactory( table, idtypes, odtypes, policy )
+#### unaryStrided1dDispatchFactory( table, idtypes, odtypes, policies )
 
 Returns a function for performing a reduction on an input ndarray.
 
@@ -46,9 +46,12 @@ var table = {
 };
 
 var dtypes = [ 'float64', 'float32', 'generic' ];
-var policy = 'same';
+var policies = {
+    'output': 'same',
+    'casting': 'none'
+};
 
-var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policy );
+var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policies );
 ```
 
 The function has the following parameters:
@@ -66,7 +69,10 @@ The function has the following parameters:
 
 -   **odtypes**: list of supported output data types.
 
--   **policy**: output data type policy.
+-   **policies**: dispatch policies. Must have the following properties:
+
+    -   **output**: output data type [policy][@stdlib/ndarray/output-dtype-policies].
+    -   **casting**: input ndarray casting [policy][@stdlib/ndarray/input-casting-policies].
 
 #### unary( x\[, ...args]\[, options] )
 
@@ -83,9 +89,12 @@ var table = {
 };
 
 var dtypes = [ 'float64', 'float32', 'generic' ];
-var policy = 'same';
+var policies = {
+    'output': 'same',
+    'casting': 'none'
+};
 
-var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policy );
+var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policies );
 
 var xbuf = [ -1.0, 2.0, -3.0 ];
 var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -123,9 +132,12 @@ var table = {
 };
 
 var dtypes = [ 'float64', 'float32', 'generic' ];
-var policy = 'same';
+var policies = {
+    'output': 'same',
+    'casting': 'none'
+};
 
-var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policy );
+var unary = unaryStrided1dDispatchFactory( table, [ dtypes ], dtypes, policies );
 
 var xbuf = [ -1.0, 2.0, -3.0 ];
 var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -152,12 +164,15 @@ var ndarray = require( '@stdlib/ndarray/base/ctor' );
 
 var idt = dtypes( 'real_and_generic' );
 var odt = idt;
-var policy = 'same';
+var policies = {
+    'output': 'same',
+    'casting': 'none'
+};
 
 var table = {
     'default': base
 };
-var unary = unaryStrided1dDispatchFactory( table, [ idt ], odt, policy );
+var unary = unaryStrided1dDispatchFactory( table, [ idt ], odt, policies );
 
 var xbuf = [ -1.0, 2.0, -3.0 ];
 var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -233,8 +248,11 @@ var unaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/unary-reduce-
 var idt = dtypes( 'real_and_generic' );
 var odt = dtypes( 'real_and_generic' );
 
-// Define the policy mapping an input data type to an output data type:
-var policy = 'same';
+// Define dispatch policies:
+var policies = {
+    'output': 'same',
+    'casting': 'none'
+};
 
 // Define a dispatch table:
 var table = {
@@ -250,7 +268,7 @@ var table = {
 };
 
 // Create an interface for performing a reduction:
-var max = unaryStrided1dDispatchFactory( table, [ idt ], odt, policy );
+var max = unaryStrided1dDispatchFactory( table, [ idt ], odt, policies );
 
 // Generate an array of random numbers:
 var xbuf = uniform( 100, -1.0, 1.0, {
@@ -289,6 +307,10 @@ console.log( ndarray2array( y ) );
 
 <section class="links">
 
+[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/output-dtype-policies
+
+[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/input-casting-policies
+
 </section>
 
 <!-- /.links -->

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

@@ -42,6 +42,7 @@ var factory = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
+	var policies;
 	var unary;
 	var table;
 	var out;
@@ -52,7 +53,11 @@ function createBenchmark( len ) {
 		'default': max
 	};
 	dt = dtypes( 'real_floating_point' );
-	unary = factory( table, [ dt ], dt, 'same' );
+	policies = {
+		'output': 'same',
+		'casting': 'none'
+	};
+	unary = factory( table, [ dt ], dt, policies );
 
 	x = uniform( len, -50.0, 50.0, {
 		'dtype': 'float64'

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

@@ -29,6 +29,7 @@ var factory = require( './../lib' );
 // MAIN //
 
 bench( pkg+'::factory', function benchmark( b ) {
+	var policies;
 	var dtypes;
 	var table;
 	var v;
@@ -41,10 +42,14 @@ bench( pkg+'::factory', function benchmark( b ) {
 		'float64',
 		'float32'
 	];
+	policies = {
+		'output': 'same',
+		'casting': 'none'
+	};
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = factory( table, [ dtypes ], dtypes, 'same' );
+		v = factory( table, [ dtypes ], dtypes, policies );
 		if ( typeof v !== 'function' ) {
 			b.fail( 'should return a function' );
 		}

lib/node_modules/@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory/benchmark/benchmark.length.js

@@ -41,6 +41,7 @@ var factory = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
+	var policies;
 	var unary;
 	var table;
 	var dt;
@@ -50,7 +51,11 @@ function createBenchmark( len ) {
 		'default': max
 	};
 	dt = dtypes( 'real_floating_point' );
-	unary = factory( table, [ dt ], dt, 'same' );
+	policies = {
+		'output': 'same',
+		'casting': 'none'
+	};
+	unary = factory( table, [ dt ], dt, policies );
 
 	x = uniform( len, -50.0, 50.0, {
 		'dtype': 'float64'

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

@@ -1,5 +1,5 @@
 
-{{alias}}( table, idtypes, odtypes, policy )
+{{alias}}( table, idtypes, odtypes, policies )
     Returns function for performing a reduction on an input ndarray.
 
     Parameters
@@ -35,8 +35,11 @@
     odtypes: Array<string>
         List of supported output array data types.
 
-    policy: string
-        Output data type policy.
+    policies: Object
+        Dispatch policies. Must have the following properties:
+
+        - output: output data type policy.
+        - casting: input ndarray casting policy.
 
     Returns
     -------
@@ -46,8 +49,9 @@
     Examples
     --------
     > var dt = [ 'float64', 'float32', 'generic' ];
+    > var p = { 'output': 'same', 'casting': 'none' };
     > var t = { 'default': {{alias:@stdlib/stats/base/ndarray/max}} };
-    > var f = {{alias}}( t, [ dt ], dt, 'same' );
+    > var f = {{alias}}( t, [ dt ], dt, p );
 
 
 fcn( x[, ...args][, options] )
@@ -84,9 +88,10 @@ fcn( x[, ...args][, options] )
 
     Examples
     --------
-    > var dtypes = [ 'float64', 'float32', 'generic' ];
+    > var dts = [ 'float64', 'float32', 'generic' ];
+    > var p = { 'output': 'same', 'casting': 'none' };
     > var t = { 'default': {{alias:@stdlib/stats/base/ndarray/max}} };
-    > var f = {{alias}}( t, [ dtypes ], dtypes, 'same' );
+    > var f = {{alias}}( t, [ dts ], dts, p );
     > var buf = [ -1.0, 2.0, -3.0, -4.0 ];
     > var dt = 'generic';
     > var sh = [ buf.length ];
@@ -129,9 +134,10 @@ fcn.assign( x[, ...args], out[, options] )
 
     Examples
     --------
-    > var dtypes = [ 'float64', 'float32', 'generic' ];
+    > var dts = [ 'float64', 'float32', 'generic' ];
+    > var p = { 'output': 'same', 'casting': 'none' };
     > var t = { 'default': {{alias:@stdlib/stats/base/ndarray/max}} };
-    > var f = {{alias}}( t, [ dtypes ], dtypes, 'same' );
+    > var f = {{alias}}( t, [ dts ], dts, p );
     > var buf = [ -1.0, 2.0, -3.0, -4.0 ];
     > var dt = 'generic';
     > var sh = [ buf.length ];

lib/node_modules/@stdlib/ndarray/base/unary-reduce-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 { OutputPolicy, InputCastingPolicy, DataType, typedndarray } from '@stdlib/types/ndarray';
 
 /**
 * Input array.
@@ -101,6 +101,21 @@ interface DispatchTable<T, U> extends BaseDispatchTable<T, U> {
 	fcns: ArrayLike<Unary<T, U> | UnaryWithAdditionalArrays<T, U>>;
 }
 
+/**
+* Dispatch policies.
+*/
+interface Policies {
+	/**
+	* Output data type policy.
+	*/
+	output: OutputPolicy;
+
+	/**
+	* Input ndarray casting policy.
+	*/
+	casting: InputCastingPolicy;
+}
+
 /**
 * Interface for performing a reduction on an ndarray.
 */
@@ -119,12 +134,15 @@ interface UnaryFunction<T, U> {
 	*
 	* var idt = dtypes( 'real_and_generic' );
 	* var odt = idt;
-	* var policy = 'same';
+	* var policies = {
+	*     'output': 'same',
+	*     'casting': 'none'
+	* };
 	*
 	* var table = {
 	*     'default': base
 	* };
-	* var max = factory( table, [ idt ], odt, policy );
+	* var max = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -152,12 +170,15 @@ interface UnaryFunction<T, U> {
 	*
 	* var idt = dtypes( 'real_and_generic' );
 	* var odt = idt;
-	* var policy = 'same';
+	* var policies = {
+	*     'output': 'same',
+	*     'casting': 'none'
+	* };
 	*
 	* var table = {
 	*     'default': base
 	* };
-	* var max = factory( table, [ idt ], odt, policy );
+	* var max = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -191,12 +212,15 @@ interface UnaryFunction<T, U> {
 	*
 	* var idt = dtypes( 'real_and_generic' );
 	* var odt = idt;
-	* var policy = 'same';
+	* var policies = {
+	*     'output': 'same',
+	*     'casting': 'none'
+	* };
 	*
 	* var table = {
 	*     'default': base
 	* };
-	* var max = factory( table, [ idt ], odt, policy );
+	* var max = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -222,7 +246,7 @@ interface UnaryFunction<T, U> {
 * @param table - dispatch table
 * @param idtypes - list containing lists of supported input data types for each ndarray argument
 * @param odtypes - list of supported output data types
-* @param policy - output data type policy
+* @param policies - dispatch policies
 * @returns function for applying a unary function
 *
 * @example
@@ -232,12 +256,15 @@ interface UnaryFunction<T, U> {
 *
 * var idt = dtypes( 'real_and_generic' );
 * var odt = idt;
-* var policy = 'same';
+* var policies = {
+*     'output': 'same',
+*     'casting': 'none'
+* };
 *
 * var table = {
 *     'default': base
 * };
-* var max = factory( table, [ idt ], odt, policy );
+* var max = factory( table, [ idt ], odt, policies );
 *
 * var xbuf = [ -1.0, 2.0, -3.0 ];
 * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -248,7 +275,7 @@ interface UnaryFunction<T, U> {
 * var v = y.get();
 * // returns 2.0
 */
-declare function factory<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policy: OutputPolicy ): UnaryFunction<T, U>;
+declare function factory<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): UnaryFunction<T, U>;
 
 
 // EXPORTS //