@stdlib/utils-map2-right 0.0.1 → 0.1.0

package/docs/repl.txt

@@ -1,129 +0,0 @@
-
-{{alias}}( x, y, fcn[, thisArg] )
-    Applies a function to elements in two input arrays while iterating from
-    right to left and assigns the results to a new array.
-
-    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.
-
-    The returned output array always has a "generic" data type. For example, if
-    provided an array-like object, the function returns a generic array. If
-    provided an ndarray, the function returns an ndarray having a "generic" data
-    type.
-
-    Input arrays must be either both array-like objects or both ndarray-like
-    objects.
-
-    If input arrays are array-like objects, the arrays must have the same number
-    of elements.
-
-    If input arrays are ndarray-like objects, the arrays must be broadcast
-    compatible.
-
-    Parameters
-    ----------
-    x: ArrayLikeObject|ndarray
-        First input array.
-
-    y: ArrayLikeObject|ndarray
-        Second input array.
-
-    fcn: Function
-        Function to apply.
-
-    thisArg: any (optional)
-        Input function context.
-
-    Returns
-    -------
-    out: Array|ndarray
-        Output array.
-
-    Examples
-    --------
-    // array-like object:
-    > var f = {{alias:@stdlib/utils/nary-function}}( {{alias:@stdlib/math/base/ops/add}}, 2 );
-    > var x = [ 1, 2, 3, 4, 5, 6 ];
-    > var y = [ 1, 1, 1, 1, 1, 1 ];
-    > var out = {{alias}}( x, y, f )
-    [ 2, 3, 4, 5, 6, 7 ]
-
-    // ndarray:
-    > x = {{alias:@stdlib/ndarray/array}}( x, { 'shape': [ 2, 3 ] } );
-    > y = {{alias:@stdlib/ndarray/array}}( y, { 'shape': [ 2, 3 ] } );
-    > out = {{alias}}( x, y, f );
-    > var v = out.get( 1, 1 )
-    6
-
-
-{{alias}}.assign( x, y, out, fcn[, thisArg] )
-    Applies a function to elements in two input arrays while iterating from
-    right to left and assigns the results to an output array.
-
-    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.
-
-    Input and output arrays must be either all array-like objects or all
-    ndarray-like objects.
-
-    If input and output arrays are array-like objects, the arrays must have the
-    same number of elements.
-
-    If input and output arrays are ndarray-like objects, the arrays must be
-    broadcast compatible.
-
-    Parameters
-    ----------
-    x: ArrayLikeObject|ndarray
-        First input array.
-
-    y: ArrayLikeObject|ndarray
-        Second input array.
-
-    out: ArrayLikeObject|ndarray
-        Output array.
-
-    fcn: Function
-        Function to apply.
-
-    thisArg: any (optional)
-        Input function context.
-
-    Returns
-    -------
-    out: Array|ndarray
-        Output array.
-
-    Examples
-    --------
-    // array-like object:
-    > var f = {{alias:@stdlib/utils/nary-function}}( {{alias:@stdlib/math/base/ops/add}}, 2 );
-    > var x = [ 1, 2, 3, 4, 5, 6 ];
-    > var y = [ 1, 1, 1, 1, 1, 1 ];
-    > var out = [ 0, 0, 0, 0, 0, 0 ];
-    > {{alias}}.assign( x, y, out, f );
-    > out
-    [ 2, 3, 4, 5, 6, 7 ]
-
-    // ndarray:
-    > var opts = { 'shape': [ 2, 3 ] };
-    > x = {{alias:@stdlib/ndarray/array}}( x, opts );
-    > y = {{alias:@stdlib/ndarray/array}}( y, opts );
-    > out = {{alias:@stdlib/ndarray/array}}( [ 0, 0, 0, 0, 0, 0 ], opts );
-    > {{alias}}.assign( x, y, out, f );
-    > var v = out.get( 1, 1 )
-    6
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,343 +0,0 @@
-/*
-* @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
-}