feat: add support for enforcing traversal order

---
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: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - 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-strided1d-dispatch/README.md

@@ -30,7 +30,7 @@ limitations under the License.
 var UnaryStrided1dDispatch = require( '@stdlib/ndarray/base/unary-strided1d-dispatch' );
 ```
 
-#### UnaryStrided1dDispatch( table, idtypes, odtypes, policies )
+#### UnaryStrided1dDispatch( table, idtypes, odtypes, policies\[, options] )
 
 Returns an interface for applying a strided function to an input ndarray.
 
@@ -70,6 +70,12 @@ The constructor has the following parameters:
     -   **output**: output data type [policy][@stdlib/ndarray/output-dtype-policies].
     -   **casting**: input ndarray casting [policy][@stdlib/ndarray/input-casting-policies].
 
+-   **options**: function options (_optional_).
+
+The constructor supports the following options:
+
+-   **strictTraversalOrder**: boolean specifying whether the order of element traversal must match the memory layout order of an input ndarray. Default: `false`.
+
 #### UnaryStrided1dDispatch.prototype.apply( x\[, ...args]\[, options] )
 
 Applies a strided function to a provided input ndarray.

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

@@ -1,5 +1,5 @@
 
-{{alias}}( table, idtypes, odtypes, policies )
+{{alias}}( table, idtypes, odtypes, policies[, options] )
     Returns an ndarray function interface for applying a strided function to an
     input ndarray.
 
@@ -42,6 +42,13 @@
         - output: output data type policy.
         - casting: input ndarray casting policy.
 
+    options: Object (optional)
+        Function options.
+
+    options.strictTraversalOrder: boolean (optional)
+        Boolean specifying whether the order of element traversal must match the
+        memory layout order of an input ndarray.
+
     Returns
     -------
     out: Object

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

@@ -53,6 +53,16 @@ interface Options extends BaseOptions {
 	dtype?: DataType;
 }
 
+/**
+* Interface defining constructor options.
+*/
+interface ConstructorOptions {
+	/**
+	* Boolean specifying whether the order of element traversal must match the memory layout of an input ndarray.
+	*/
+	strictTraversalOrder?: boolean;
+}
+
 /**
 * Strided function.
 *
@@ -122,6 +132,7 @@ declare class UnaryStrided1dDispatch<T, U> {
 	* @param idtypes - list containing lists of supported input data types for each ndarray argument
 	* @param odtypes - list of supported output data types
 	* @param policies - dispatch policies
+	* @param options - function options
 	* @returns instance
 	*
 	* @example
@@ -151,7 +162,7 @@ declare class UnaryStrided1dDispatch<T, U> {
 	* var arr = ndarray2array( y );
 	* // returns [ -1.0, 2.0, 2.0 ]
 	*/
-	constructor( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies );
+	constructor( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies, options?: ConstructorOptions );
 
 	/**
 	* Applies a strided function to a provided input ndarray.
@@ -287,6 +298,7 @@ interface UnaryStrided1dDispatchConstructor {
 	* @param idtypes - list containing lists of supported input data types for each ndarray argument
 	* @param odtypes - list of supported output data types
 	* @param policies - dispatch policies
+	* @param options - function options
 	* @returns instance
 	*
 	* @example
@@ -316,7 +328,7 @@ interface UnaryStrided1dDispatchConstructor {
 	* var arr = ndarray2array( y );
 	* // returns [ -1.0, 2.0, 2.0 ]
 	*/
-	new<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): UnaryStrided1dDispatch<T, U>;
+	new<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies, options?: ConstructorOptions ): UnaryStrided1dDispatch<T, U>;
 
 	/**
 	* Constructor for applying a strided function to an input ndarray.
@@ -325,6 +337,7 @@ interface UnaryStrided1dDispatchConstructor {
 	* @param idtypes - list containing lists of supported input data types for each ndarray argument
 	* @param odtypes - list of supported output data types
 	* @param policies - dispatch policies
+	* @param options - function options
 	* @returns instance
 	*
 	* @example
@@ -354,7 +367,7 @@ interface UnaryStrided1dDispatchConstructor {
 	* var arr = ndarray2array( y );
 	* // returns [ -1.0, 2.0, 2.0 ]
 	*/
-	<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): UnaryStrided1dDispatch<T, U>;
+	<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies, options?: ConstructorOptions ): UnaryStrided1dDispatch<T, U>;
 }
 
 /**
@@ -364,6 +377,7 @@ interface UnaryStrided1dDispatchConstructor {
 * @param idtypes - list containing lists of supported input data types for each ndarray argument
 * @param odtypes - list of supported output data types
 * @param policies - dispatch policies
+* @param options - function options
 * @returns instance
 *
 * @example

lib/node_modules/@stdlib/ndarray/base/unary-strided1d-dispatch/docs/types/test.ts

@@ -41,8 +41,11 @@ import UnaryStrided1dDispatch = require( './index' );
 
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies ); // $ExpectType UnaryStrided1dDispatch<number, number>
 
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, {} ); // $ExpectType UnaryStrided1dDispatch<number, number>
+
 	const unary = UnaryStrided1dDispatch;
 	unary<number, number>( table, [ dtypes ], dtypes, policies ); // $ExpectType UnaryStrided1dDispatch<number, number>
+	unary<number, number>( table, [ dtypes ], dtypes, policies, {} ); // $ExpectType UnaryStrided1dDispatch<number, number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a dispatch table...
@@ -64,6 +67,17 @@ import UnaryStrided1dDispatch = require( './index' );
 	new UnaryStrided1dDispatch( {}, [ dtypes ], dtypes, policies ); // $ExpectError
 	new UnaryStrided1dDispatch( ( x: number, y: number ): number => x + y, [ dtypes ], dtypes, policies ); // $ExpectError
 
+	new UnaryStrided1dDispatch( '5', [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( 5, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( true, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( false, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( null, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( void 0, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( 'abc', [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( [], [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( {}, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch( ( x: number, y: number ): number => x + y, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+
 	const unary = UnaryStrided1dDispatch;
 	unary( '5', [ dtypes ], dtypes, policies ); // $ExpectError
 	unary( 5, [ dtypes ], dtypes, policies ); // $ExpectError
@@ -75,6 +89,17 @@ import UnaryStrided1dDispatch = require( './index' );
 	unary( [], [ dtypes ], dtypes, policies ); // $ExpectError
 	unary( {}, [ dtypes ], dtypes, policies ); // $ExpectError
 	unary( ( x: number, y: number ): number => x + y, [ dtypes ], dtypes, policies ); // $ExpectError
+
+	unary( '5', [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( 5, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( true, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( false, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( null, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( void 0, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( 'abc', [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( [], [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( {}, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary( ( x: number, y: number ): number => x + y, [ dtypes ], dtypes, policies, {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a second argument which is not a a list of data type lists...
@@ -98,6 +123,16 @@ import UnaryStrided1dDispatch = require( './index' );
 	new UnaryStrided1dDispatch<number, number>( table, {}, dtypes, policies ); // $ExpectError
 	new UnaryStrided1dDispatch<number, number>( table, ( x: number ): number => x, dtypes, policies ); // $ExpectError
 
+	new UnaryStrided1dDispatch<number, number>( table, '5', dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, 5, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, true, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, false, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, null, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, void 0, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, 'abc', dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, {}, dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, ( x: number ): number => x, dtypes, policies, {} ); // $ExpectError
+
 	const unary = UnaryStrided1dDispatch;
 	unary<number, number>( table, '5', dtypes, policies ); // $ExpectError
 	unary<number, number>( table, 5, dtypes, policies ); // $ExpectError
@@ -108,6 +143,16 @@ import UnaryStrided1dDispatch = require( './index' );
 	unary<number, number>( table, 'abc', dtypes, policies ); // $ExpectError
 	unary<number, number>( table, {}, dtypes, policies ); // $ExpectError
 	unary<number, number>( table, ( x: number ): number => x, dtypes, policies ); // $ExpectError
+
+	unary<number, number>( table, '5', dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, 5, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, true, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, false, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, null, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, void 0, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, 'abc', dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, {}, dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, ( x: number ): number => x, dtypes, policies, {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a third argument which is not a list of data types...
@@ -131,6 +176,16 @@ import UnaryStrided1dDispatch = require( './index' );
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], {}, policies ); // $ExpectError
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], ( x: number ): number => x, policies ); // $ExpectError
 
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], '5', policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], 5, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], true, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], false, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], null, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], void 0, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], 'abc', policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], {}, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], ( x: number ): number => x, policies, {} ); // $ExpectError
+
 	const unary = UnaryStrided1dDispatch;
 	unary<number, number>( table, [ dtypes ], '5', policies ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], 5, policies ); // $ExpectError
@@ -141,6 +196,16 @@ import UnaryStrided1dDispatch = require( './index' );
 	unary<number, number>( table, [ dtypes ], 'abc', policies ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], {}, policies ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], ( x: number ): number => x, policies ); // $ExpectError
+
+	unary<number, number>( table, [ dtypes ], '5', policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], 5, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], true, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], false, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], null, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], void 0, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], 'abc', policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], {}, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], ( x: number ): number => x, policies, {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a fourth argument which is not valid policy object...
@@ -160,6 +225,16 @@ import UnaryStrided1dDispatch = require( './index' );
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, {} ); // $ExpectError
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, ( x: number ): number => x ); // $ExpectError
 
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, '5', {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, 5, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, true, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, false, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, null, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, void 0, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, 'abc', {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, {}, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, ( x: number ): number => x, {} ); // $ExpectError
+
 	const unary = UnaryStrided1dDispatch;
 	unary<number, number>( table, [ dtypes ], dtypes, '5' ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], dtypes, 5 ); // $ExpectError
@@ -170,6 +245,45 @@ import UnaryStrided1dDispatch = require( './index' );
 	unary<number, number>( table, [ dtypes ], dtypes, 'abc' ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], dtypes, {} ); // $ExpectError
 	unary<number, number>( table, [ dtypes ], dtypes, ( x: number ): number => x ); // $ExpectError
+
+	unary<number, number>( table, [ dtypes ], dtypes, '5', {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, 5, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, true, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, false, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, null, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, void 0, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, 'abc', {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, {}, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, ( x: number ): number => x, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a fifth argument which is an object...
+{
+	const dtypes: Array<DataType> = [ 'float64', 'float32' ];
+	const table = {
+		'default': cumax
+	};
+	const policies = {
+		'output': 'same' as OutputPolicy,
+		'casting': 'none' as InputCastingPolicy
+	};
+
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, '5' ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, 5 ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, true ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, false ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, null ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, 'abc' ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, ( x: number ): number => x ); // $ExpectError
+
+	const unary = UnaryStrided1dDispatch;
+	unary<number, number>( table, [ dtypes ], dtypes, policies, '5' ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, 5 ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, true ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, false ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, null ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, 'abc' ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, ( x: number ): number => x ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
@@ -186,13 +300,13 @@ import UnaryStrided1dDispatch = require( './index' );
 	new UnaryStrided1dDispatch(); // $ExpectError
 	new UnaryStrided1dDispatch<number, number>( table ); // $ExpectError
 	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ] ); // $ExpectError
-	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	new UnaryStrided1dDispatch<number, number>( table, [ dtypes ], dtypes, policies, {}, {} ); // $ExpectError
 
 	const unary = UnaryStrided1dDispatch;
 	unary(); // $ExpectError
 	unary<number, number>( table ); // $ExpectError
 	unary<number, number>( table, [ dtypes ] ); // $ExpectError
-	unary<number, number>( table, [ dtypes ], dtypes, policies, {} ); // $ExpectError
+	unary<number, number>( table, [ dtypes ], dtypes, policies, {}, {} ); // $ExpectError
 }
 
 // The function returns an instance having an `apply` method which returns an ndarray...