@stdlib/utils-map2-right 0.0.1

package/docs/types/index.d.ts

@@ -0,0 +1,363 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+import { Collection } from '@stdlib/types/object';
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @returns result
+*/
+type Nullary = () => any;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @returns result
+*/
+type Unary = ( v1: any ) => any;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @returns result
+*/
+type Binary = ( v1: any, v2: any ) => any;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @returns result
+*/
+type Ternary = ( v1: any, v2: any, index: number ) => any;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @returns result
+*/
+type Quaternary = ( v1: any, v2: any, index: number, x: ndarray ) => any;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @returns result
+*/
+type ArrayQuaternary = ( v1: any, v2: any, index: number, x: Collection ) => any; // tslint:disable-line:max-line-length
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @param y - second input array
+* @returns result
+*/
+type Quinary = ( v1: any, v2: any, index: number, x: ndarray, y: ndarray ) => any; // tslint:disable-line:max-line-length
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @param y - second input array
+* @returns result
+*/
+type ArrayQuinary = ( v1: any, v2: any, index: number, x: Collection, y: Collection ) => any; // tslint:disable-line:max-line-length
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @param y - second input array
+* @returns result
+*/
+type Callback = Nullary | Unary | Binary | Ternary | Quaternary | Quinary;
+
+/**
+* Callback invoked for each pair of array elements.
+*
+* @param v1 - element from the first input array
+* @param v2 - element from the second input array
+* @param index - element index
+* @param x - first input array
+* @param y - second input array
+* @returns result
+*/
+type ArrayCallback = Nullary | Unary | Binary | Ternary | ArrayQuaternary | ArrayQuinary; // tslint:disable-line:max-line-length
+
+/**
+* Interface describing the main export.
+*/
+interface Routine {
+	// NOTE: signature order matters here, as an ndarray is an array-like object...
+
+	/**
+	* Applies a function to elements in two input arrays while iterating from right to left and assigns the results to a new array.
+	*
+	* ## Notes
+	*
+	* -   The applied function is provided the following arguments:
+	*
+	*     -   **v1**: element from first input array.
+	*     -   **v2**: element from second input array.
+	*     -   **idx**: element index.
+	*     -   **x**: first input array.
+	*     -   **y**: second input array.
+	*
+	* @param x - first input array
+	* @param y - second input array
+	* @param fcn - function to apply
+	* @param thisArg - input function context
+	* @returns output array
+	*
+	* @example
+	* var naryFunction = require( `@stdlib/utils/nary-function` );
+	* var add = require( `@stdlib/math/base/ops/add` );
+	* var array = require( `@stdlib/ndarray/array` );
+	*
+	* var opts = {
+	*     'dtype': 'generic'
+	* };
+	* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
+	* var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );
+	*
+	* var out = map2Right( x, y, naryFunction( add, 2 ) );
+	* // returns <ndarray>
+	*
+	* var data = out.data;
+	* // returns [ 2, 3, 4, 5, 6, 7 ]
+	*/
+	( x: ndarray, y: ndarray, fcn: Callback, thisArg?: any ): ndarray;
+
+	/**
+	* Applies a function to elements in two input arrays while iterating from right to left and assigns the results to a new array.
+	*
+	* ## Notes
+	*
+	* -   The applied function is provided the following arguments:
+	*
+	*     -   **v1**: element from first input array.
+	*     -   **v2**: element from second input array.
+	*     -   **idx**: element index.
+	*     -   **x**: first input array.
+	*     -   **y**: second input array.
+	*
+	* @param x - first input array
+	* @param y - second input array
+	* @param fcn - function to apply
+	* @param thisArg - input function context
+	* @returns output array
+	*
+	* @example
+	* var naryFunction = require( `@stdlib/utils/nary-function` );
+	* var add = require( `@stdlib/math/base/ops/add` );
+	*
+	* var x = [ 1, 2, 3, 4, 5, 6 ];
+	* var y = [ 1, 1, 1, 1, 1, 1 ];
+	*
+	* var out = map2Right( x, y, naryFunction( add, 2 ) );
+	* // returns [ 2, 3, 4, 5, 6, 7 ]
+	*/
+	( x: Collection, y: Collection, fcn: ArrayCallback, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+
+	/**
+	* Applies a function to elements in two input arrays while iterating from right to left and assigns the results to an output array.
+	*
+	* ## Notes
+	*
+	* -   The applied function is provided the following arguments:
+	*
+	*     -   **v1**: element from first input array.
+	*     -   **v2**: element from second input array.
+	*     -   **idx**: element index.
+	*     -   **x**: first input array.
+	*     -   **y**: second input array.
+	*
+	* @param x - first input array
+	* @param y - second input array
+	* @param out - output array
+	* @param fcn - function to apply
+	* @param thisArg - input function context
+	* @returns output array
+	*
+	* @example
+	* var naryFunction = require( `@stdlib/utils/nary-function` );
+	* var add = require( `@stdlib/math/base/ops/add` );
+	* var array = require( `@stdlib/ndarray/array` );
+	*
+	* var opts = {
+	*     'dtype': 'generic',
+	*     'shape': [ 2, 3 ]
+	* };
+	* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
+	* var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );
+	* var out = array( opts );
+	*
+	* map2Right.assign( x, y, out, naryFunction( add, 2 ) );
+	*
+	* var data = out.data;
+	* // returns [ 2, 3, 4, 5, 6, 7 ]
+	*/
+	assign( x: ndarray, y: ndarray, out: ndarray, fcn: Callback, thisArg?: any ): ndarray; // tslint:disable-line:max-line-length
+
+	/**
+	* Applies a function to elements in two input arrays while iterating from right to left and assigns the results to an output array.
+	*
+	* ## Notes
+	*
+	* -   The applied function is provided the following arguments:
+	*
+	*     -   **v1**: element from first input array.
+	*     -   **v2**: element from second input array.
+	*     -   **idx**: element index.
+	*     -   **x**: first input array.
+	*     -   **y**: second input array.
+	*
+	* @param x - first input array
+	* @param y - second input array
+	* @param out - output array
+	* @param fcn - function to apply
+	* @param thisArg - input function context
+	* @returns output array
+	*
+	* @example
+	* var naryFunction = require( `@stdlib/utils/nary-function` );
+	* var add = require( `@stdlib/math/base/ops/add` );
+	*
+	* var x = [ 1, 2, 3, 4, 5, 6 ];
+	* var y = [ 1, 1, 1, 1, 1, 1 ];
+	* var out = [ 0, 0, 0, 0, 0, 0 ];
+	*
+	* map2Right.assign( x, y, out, naryFunction( add, 2 ) );
+	*
+	* console.log( out );
+	* // => [ 2, 3, 4, 5, 6, 7 ]
+	*/
+	assign( x: Collection, y: Collection, out: Collection, fcn: ArrayCallback, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+}
+
+/**
+* Applies a function to elements in two input arrays while iterating from right to left and assigns the results to a new array.
+*
+* ## Notes
+*
+* -   The applied function is provided the following arguments:
+*
+*     -   **v1**: element from first input array.
+*     -   **v2**: element from second input array.
+*     -   **idx**: element index.
+*     -   **x**: first input array.
+*     -   **y**: second input array.
+*
+* @param x - first input array
+* @param y - second input array
+* @param fcn - function to apply
+* @param thisArg - input function context
+* @returns output array
+*
+* @example
+* var naryFunction = require( `@stdlib/utils/nary-function` );
+* var add = require( `@stdlib/math/base/ops/add` );
+*
+* var x = [ 1, 2, 3, 4, 5, 6 ];
+* var y = [ 1, 1, 1, 1, 1, 1 ];
+*
+* var out = map2Right( x, y, naryFunction( add, 2 ) );
+* // returns [ 2, 3, 4, 5, 6, 7 ]
+*
+* @example
+* var naryFunction = require( `@stdlib/utils/nary-function` );
+* var add = require( `@stdlib/math/base/ops/add` );
+* var array = require( `@stdlib/ndarray/array` );
+*
+* var opts = {
+*     'dtype': 'generic'
+* };
+* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
+* var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );
+*
+* var out = map2Right( x, y, naryFunction( add, 2 ) );
+* // returns <ndarray>
+*
+* var data = out.data;
+* // returns [ 2, 3, 4, 5, 6, 7 ]
+*
+* @example
+* var naryFunction = require( `@stdlib/utils/nary-function` );
+* var add = require( `@stdlib/math/base/ops/add` );
+*
+* var x = [ 1, 2, 3, 4, 5, 6 ];
+* var y = [ 1, 1, 1, 1, 1, 1 ];
+* var out = [ 0, 0, 0, 0, 0, 0 ];
+*
+* map2Right.assign( x, y, out, naryFunction( add, 2 ) );
+*
+* console.log( out );
+* // => [ 2, 3, 4, 5, 6, 7 ]
+*
+* @example
+* var naryFunction = require( `@stdlib/utils/nary-function` );
+* var add = require( `@stdlib/math/base/ops/add` );
+* var array = require( `@stdlib/ndarray/array` );
+*
+* var opts = {
+*     'dtype': 'generic',
+*     'shape': [ 2, 3 ]
+* };
+* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
+* var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );
+* var out = array( opts );
+*
+* map2Right.assign( x, y, out, naryFunction( add, 2 ) );
+*
+* var data = out.data;
+* // returns [ 2, 3, 4, 5, 6, 7 ]
+*/
+declare var map2Right: Routine;
+
+
+// EXPORTS //
+
+export = map2Right;

package/docs/types/test.ts

@@ -0,0 +1,343 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2022 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import array = require( '@stdlib/ndarray-array' );
+import map2Right = require( './index' );
+
+/**
+* Callback function.
+*
+* @param v1 - first value
+* @param v2 - second value
+* @returns result
+*/
+function clbk( v1: number, v2: number ): number {
+	return v1 + v2;
+}
+
+
+// TESTS //
+
+// The function returns a collection when provided collections...
+{
+	const x = [ 1, 2, 3, 4, 5, 6 ];
+	const y = [ 1, 1, 1, 1, 1, 1 ];
+
+	map2Right( x, y, clbk ); // $ExpectType Collection
+	map2Right( x, y, clbk, {} ); // $ExpectType Collection
+}
+
+// The function returns an ndarray when provided ndarrays...
+{
+	const x = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y = array( [ 1, 1, 1, 1, 1, 1 ] );
+
+	map2Right( x, y, clbk ); // $ExpectType ndarray
+	map2Right( x, y, clbk, {} ); // $ExpectType ndarray
+}
+
+// The compiler throws an error if the function is provided a first argument other than a collection or ndarray...
+{
+	const y = [ 1, 1, 1, 1, 1, 1 ];
+
+	map2Right( 5, y, clbk ); // $ExpectError
+	map2Right( true, y, clbk ); // $ExpectError
+	map2Right( false, y, clbk ); // $ExpectError
+	map2Right( null, y, clbk, {} ); // $ExpectError
+	map2Right( {}, y, clbk ); // $ExpectError
+
+	map2Right( 5, y, clbk, {} ); // $ExpectError
+	map2Right( true, y, clbk, {} ); // $ExpectError
+	map2Right( false, y, clbk, {} ); // $ExpectError
+	map2Right( null, y, clbk, {} ); // $ExpectError
+	map2Right( {}, y, clbk, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument other than a collection or ndarray...
+{
+	const x = [ 1, 2, 3, 4, 5, 6 ];
+
+	map2Right( x, 5, clbk ); // $ExpectError
+	map2Right( x, true, clbk ); // $ExpectError
+	map2Right( x, false, clbk ); // $ExpectError
+	map2Right( x, null, clbk, {} ); // $ExpectError
+	map2Right( x, {}, clbk ); // $ExpectError
+
+	map2Right( x, 5, clbk, {} ); // $ExpectError
+	map2Right( x, true, clbk, {} ); // $ExpectError
+	map2Right( x, false, clbk, {} ); // $ExpectError
+	map2Right( x, null, clbk, {} ); // $ExpectError
+	map2Right( x, {}, clbk, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a third argument other than a function with a supported signature...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+
+	map2Right( x1, y1, '5' ); // $ExpectError
+	map2Right( x1, y1, true ); // $ExpectError
+	map2Right( x1, y1, false ); // $ExpectError
+	map2Right( x1, y1, 123 ); // $ExpectError
+	map2Right( x1, y1, null ); // $ExpectError
+	map2Right( x1, y1, {} ); // $ExpectError
+	map2Right( x1, y1, [] ); // $ExpectError
+
+	map2Right( x1, y1, '5', {} ); // $ExpectError
+	map2Right( x1, y1, true, {} ); // $ExpectError
+	map2Right( x1, y1, false, {} ); // $ExpectError
+	map2Right( x1, y1, 123, {} ); // $ExpectError
+	map2Right( x1, y1, null, {} ); // $ExpectError
+	map2Right( x1, y1, {}, {} ); // $ExpectError
+	map2Right( x1, y1, [], {} ); // $ExpectError
+
+	map2Right( x1, y1, ( x: number, y: number, z: number, w: number ): number => x + y + z + w ); // $ExpectError
+	map2Right( x1, y1, ( x: number, y: number, z: number, w: number ): number => x + y + z + w, {} ); // $ExpectError
+
+	const x2 = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+
+	map2Right( x2, y2, '5' ); // $ExpectError
+	map2Right( x2, y2, true ); // $ExpectError
+	map2Right( x2, y2, false ); // $ExpectError
+	map2Right( x2, y2, 123 ); // $ExpectError
+	map2Right( x2, y2, null ); // $ExpectError
+	map2Right( x2, y2, {} ); // $ExpectError
+	map2Right( x2, y2, [] ); // $ExpectError
+
+	map2Right( x2, y2, '5', {} ); // $ExpectError
+	map2Right( x2, y2, true, {} ); // $ExpectError
+	map2Right( x2, y2, false, {} ); // $ExpectError
+	map2Right( x2, y2, 123, {} ); // $ExpectError
+	map2Right( x2, y2, null, {} ); // $ExpectError
+	map2Right( x2, y2, {}, {} ); // $ExpectError
+	map2Right( x2, y2, [], {} ); // $ExpectError
+
+	map2Right( x2, y2, ( x: number, y: number, z: number, w: number ): number => x + y + z + w ); // $ExpectError
+	map2Right( x2, y2, ( x: number, y: number, z: number, w: number ): number => x + y + z + w, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+
+	map2Right(); // $ExpectError
+	map2Right( x1 ); // $ExpectError
+	map2Right( x1, y1 ); // $ExpectError
+	map2Right( x1, y1, clbk, {}, 4 ); // $ExpectError
+
+	const x2 = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+
+	map2Right(); // $ExpectError
+	map2Right( x2 ); // $ExpectError
+	map2Right( x2, y2 ); // $ExpectError
+	map2Right( x2, y2, clbk, {}, 4 ); // $ExpectError
+}
+
+// Attached to the main export is an `assign` method which returns a collection when provided collections...
+{
+	const x = [ 1, 2, 3, 4, 5, 6 ];
+	const y = [ 1, 1, 1, 1, 1, 1 ];
+	const out = [ 0, 0, 0, 0, 0, 0 ];
+
+	map2Right.assign( x, y, out, clbk ); // $ExpectType Collection
+	map2Right.assign( x, y, out, clbk, {} ); // $ExpectType Collection
+}
+
+// The `assign` method returns an ndarray when provided ndarrays...
+{
+	const x = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y = array( [ 1, 1, 1, 1, 1, 1 ] );
+	const out = array( [ 0, 0, 0, 0, 0, 0 ] );
+
+	map2Right.assign( x, y, out, clbk ); // $ExpectType ndarray
+	map2Right.assign( x, y, out, clbk, {} ); // $ExpectType ndarray
+}
+
+// The compiler throws an error if the `assign` method is provided a first argument other than a collection or ndarray...
+{
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+	const out1 = [ 0, 0, 0, 0, 0, 0 ];
+
+	map2Right.assign( 5, y1, out1, clbk ); // $ExpectError
+	map2Right.assign( true, y1, out1, clbk ); // $ExpectError
+	map2Right.assign( false, y1, out1, clbk ); // $ExpectError
+	map2Right.assign( null, y1, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( {}, y1, out1, clbk ); // $ExpectError
+
+	map2Right.assign( 5, y1, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( true, y1, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( false, y1, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( null, y1, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( {}, y1, out1, clbk, {} ); // $ExpectError
+
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+	const out2 = array( [ 0, 0, 0, 0, 0, 0 ] );
+
+	map2Right.assign( 5, y2, out2, clbk ); // $ExpectError
+	map2Right.assign( true, y2, out2, clbk ); // $ExpectError
+	map2Right.assign( false, y2, out2, clbk ); // $ExpectError
+	map2Right.assign( null, y2, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( {}, y2, out2, clbk ); // $ExpectError
+
+	map2Right.assign( 5, y2, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( true, y2, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( false, y2, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( null, y2, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( {}, y2, out2, clbk, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the `assign` method is provided a second argument other than a collection or ndarray...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const out1 = [ 0, 0, 0, 0, 0, 0 ];
+
+	map2Right.assign( x1, 5, out1, clbk ); // $ExpectError
+	map2Right.assign( x1, true, out1, clbk ); // $ExpectError
+	map2Right.assign( x1, false, out1, clbk ); // $ExpectError
+	map2Right.assign( x1, null, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, {}, out1, clbk ); // $ExpectError
+
+	map2Right.assign( x1, 5, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, true, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, false, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, null, out1, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, {}, out1, clbk, {} ); // $ExpectError
+
+	const x2 = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const out2 = array( [ 0, 0, 0, 0, 0, 0 ] );
+
+	map2Right.assign( x2, 5, out2, clbk ); // $ExpectError
+	map2Right.assign( x2, true, out2, clbk ); // $ExpectError
+	map2Right.assign( x2, false, out2, clbk ); // $ExpectError
+	map2Right.assign( x2, null, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, {}, out2, clbk ); // $ExpectError
+
+	map2Right.assign( x2, 5, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, true, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, false, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, null, out2, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, {}, out2, clbk, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the `assign` method is provided a third argument other than a collection or ndarray...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+
+	map2Right.assign( x1, y1, 5, clbk ); // $ExpectError
+	map2Right.assign( x1, y1, true, clbk ); // $ExpectError
+	map2Right.assign( x1, y1, false, clbk ); // $ExpectError
+	map2Right.assign( x1, y1, null, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, y1, {}, clbk ); // $ExpectError
+
+	map2Right.assign( x1, y1, 5, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, y1, true, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, y1, false, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, y1, null, clbk, {} ); // $ExpectError
+	map2Right.assign( x1, y1, {}, clbk, {} ); // $ExpectError
+
+	const x2 = array( [ 0, 0, 0, 0, 0, 0 ] );
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+
+	map2Right.assign( x2, y2, 5, clbk ); // $ExpectError
+	map2Right.assign( x2, y2, true, clbk ); // $ExpectError
+	map2Right.assign( x2, y2, false, clbk ); // $ExpectError
+	map2Right.assign( x2, y2, null, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, y2, {}, clbk ); // $ExpectError
+
+	map2Right.assign( x2, y2, 5, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, y2, true, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, y2, false, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, y2, null, clbk, {} ); // $ExpectError
+	map2Right.assign( x2, y2, {}, clbk, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the `assign` method is provided a third argument other than a function with a supported signature...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+	const out1 = [ 0, 0, 0, 0, 0, 0 ];
+
+	map2Right.assign( x1, y1, out1, '5' ); // $ExpectError
+	map2Right.assign( x1, y1, out1, true ); // $ExpectError
+	map2Right.assign( x1, y1, out1, false ); // $ExpectError
+	map2Right.assign( x1, y1, out1, 123 ); // $ExpectError
+	map2Right.assign( x1, y1, out1, null ); // $ExpectError
+	map2Right.assign( x1, y1, out1, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, [] ); // $ExpectError
+
+	map2Right.assign( x1, y1, out1, '5', {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, true, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, false, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, 123, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, null, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, {}, {} ); // $ExpectError
+	map2Right.assign( x1, y1, out1, [], {} ); // $ExpectError
+
+	map2Right.assign( x1, y1, out1, ( x: number, y: number, z: number, w: number ): number => x + y + z + w ); // $ExpectError
+	map2Right.assign( x1, y1, out1, ( x: number, y: number, z: number, w: number ): number => x + y + z + w, {} ); // $ExpectError
+
+	const x2 = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+	const out2 = array( [ 0, 0, 0, 0, 0, 0 ] );
+
+	map2Right.assign( x2, y2, out2, '5' ); // $ExpectError
+	map2Right.assign( x2, y2, out2, true ); // $ExpectError
+	map2Right.assign( x2, y2, out2, false ); // $ExpectError
+	map2Right.assign( x2, y2, out2, 123 ); // $ExpectError
+	map2Right.assign( x2, y2, out2, null ); // $ExpectError
+	map2Right.assign( x2, y2, out2, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, [] ); // $ExpectError
+
+	map2Right.assign( x2, y2, out2, '5', {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, true, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, false, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, 123, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, null, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, {}, {} ); // $ExpectError
+	map2Right.assign( x2, y2, out2, [], {} ); // $ExpectError
+
+	map2Right.assign( x2, y2, out2, ( x: number, y: number, z: number, w: number ): number => x + y + z + w ); // $ExpectError
+	map2Right.assign( x2, y2, out2, ( x: number, y: number, z: number, w: number ): number => x + y + z + w, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the `assign` method is provided an unsupported number of arguments...
+{
+	const x1 = [ 1, 2, 3, 4, 5, 6 ];
+	const y1 = [ 1, 1, 1, 1, 1, 1 ];
+	const out1 = [ 0, 0, 0, 0, 0, 0 ];
+
+	map2Right.assign(); // $ExpectError
+	map2Right.assign( x1 ); // $ExpectError
+	map2Right.assign( x1, y1 ); // $ExpectError
+	map2Right.assign( x1, y1, out1 ); // $ExpectError
+	map2Right.assign( x1, y1, out1, clbk, {}, 4 ); // $ExpectError
+
+	const x2 = array( [ 1, 2, 3, 4, 5, 6 ] );
+	const y2 = array( [ 1, 1, 1, 1, 1, 1 ] );
+	const out2 = array( [ 0, 0, 0, 0, 0, 0 ] );
+
+	map2Right.assign(); // $ExpectError
+	map2Right.assign( x2 ); // $ExpectError
+	map2Right.assign( x2, y2 ); // $ExpectError
+	map2Right.assign( x2, y2, out2 ); // $ExpectError
+	map2Right.assign( x2, y2, out2, clbk, {}, 4 ); // $ExpectError
+}