@stdlib/strided-base-binary-addon-dispatch 0.0.1 → 0.1.0

package/docs/types/test.ts

@@ -1,475 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
-
-/// <reference types="@stdlib/types"/>
-
-import { Collection } from '@stdlib/types/object';
-import dispatch = require( './index' );
-
-
-// FUNCTIONS //
-
-/**
-* Add-on function.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type (enumeration constant)
-* @param x - input array
-* @param strideX - `x` stride length
-* @param dtypeY - `y` data type (enumeration constant)
-* @param y - input array
-* @param strideY - `y` stride length
-* @param dtypeZ - `z` data type (enumeration constant)
-* @param z - output array
-* @param strideZ - `z` stride length
-*/
-function addon( N: number, dtypeX: number, x: Collection, strideX: number, dtypeY: number, y: Collection, strideY: number, dtypeZ: number, z: Collection, strideZ: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ]; // tslint:disable-line:restrict-plus-operands no-unsafe-any
-	}
-}
-
-/**
-* Fallback function.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type
-* @param x - input array
-* @param strideX - `x` stride length
-* @param dtypeY - `y` data type
-* @param y - input array
-* @param strideY - `y` stride length
-* @param dtypeZ - `z` data type
-* @param z - output array
-* @param strideZ - `z` stride length
-*/
-function fallback( N: number, dtypeX: any, x: Collection, strideX: number, dtypeY: any, y: Collection, strideY: number, dtypeZ: number, z: Collection, strideZ: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		z[ i * strideZ ] = x[ i * strideX ] + y[ i * strideY ]; // tslint:disable-line:restrict-plus-operands no-unsafe-any
-	}
-}
-
-/**
-* Fallback function with alternative indexing semantics.
-*
-* @param N - number of indexed elements
-* @param dtypeX - `x` data type
-* @param x - input array
-* @param strideX - `x` stride length
-* @param offsetX - starting `x` index
-* @param dtypeY - `y` data type
-* @param y - input array
-* @param strideY - `y` stride length
-* @param offsetY - starting `y` index
-* @param dtypeZ - `z` data type
-* @param z - output array
-* @param strideZ - `z` stride length
-* @param offsetZ - starting `z` index
-*/
-function fallbackWithOffsets( N: number, dtypeX: any, x: Collection, strideX: number, offsetX: number, dtypeY: any, y: Collection, strideY: number, offsetY: number, dtypeZ: any, z: Collection, strideZ: number, offsetZ: number ): void { // tslint:disable-line:max-line-length
-	let i;
-	if ( dtypeX !== dtypeY || dtypeY !== dtypeZ ) {
-		throw new Error( 'beep' );
-	}
-	for ( i = 0; i < N; i += 1 ) {
-		z[ offsetZ + ( i * strideZ ) ] = x[ offsetX + ( i * strideX ) ] + y[ offsetY + ( i * strideY ) ]; // tslint:disable-line:max-line-length restrict-plus-operands no-unsafe-any
-	}
-}
-
-
-// TESTS //
-
-// The function returns a dispatch function...
-{
-	dispatch( addon, fallback ); // $ExpectType Dispatcher
-}
-
-// The compiler throws an error if not provided a first argument which is an add-on function...
-{
-	dispatch( '10', fallback ); // $ExpectError
-	dispatch( 10, fallback ); // $ExpectError
-	dispatch( true, fallback ); // $ExpectError
-	dispatch( false, fallback ); // $ExpectError
-	dispatch( null, fallback ); // $ExpectError
-	dispatch( undefined, fallback ); // $ExpectError
-	dispatch( [], fallback ); // $ExpectError
-	dispatch( {}, fallback ); // $ExpectError
-	dispatch( ( x: string ): string => x, fallback ); // $ExpectError
-}
-
-// The compiler throws an error if not provided a second argument which is a fallback function...
-{
-	dispatch( addon, '10' ); // $ExpectError
-	dispatch( addon, 10 ); // $ExpectError
-	dispatch( addon, true ); // $ExpectError
-	dispatch( addon, false ); // $ExpectError
-	dispatch( addon, null ); // $ExpectError
-	dispatch( addon, undefined ); // $ExpectError
-	dispatch( addon, [] ); // $ExpectError
-	dispatch( addon, {} ); // $ExpectError
-	dispatch( addon, ( x: string ): string => x ); // $ExpectError
-}
-
-// The returned function returns a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the returned function is not provided a first argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( '10', 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( true, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( false, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( null, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( undefined, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( [], 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( {}, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( ( x: number ): number => x, 'float64', x, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a third argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', true, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', false, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', null, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', undefined, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', {}, 1, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fourth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, '10', 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, true, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, false, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, null, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, undefined, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, [], 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, {}, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, ( x: number ): number => x, 'float64', y, 1, 'float64', z, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a sixth argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( y.length, 'float64', x, 1, 'float64', true, 1, 'float64', z, 1 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 'float64', false, 1, 'float64', z, 1 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 'float64', null, 1, 'float64', z, 1 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 'float64', undefined, 1, 'float64', z, 1 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 'float64', {}, 1, 'float64', z, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a seventh argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, 1, 'float64', y, '10', 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, true, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, false, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, null, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, undefined, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, [], 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, {}, 'float64', z, 1 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, ( x: number ): number => x, 'float64', z, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a ninth argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( z.length, 'float64', x, 1, 'float64', y, 1, 'float64', true, 1 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 'float64', y, 1, 'float64', false, 1 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 'float64', y, 1, 'float64', null, 1 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 'float64', y, 1, 'float64', undefined, 1 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 'float64', y, 1, 'float64', {}, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a tenth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch( addon, fallback );
-
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, '10' ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, true ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, false ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, null ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, undefined ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, [] ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, {} ); // $ExpectError
-	f( x.length, 'float64', x, 1, 'float64', y, 1, 'float64', z, ( x: number ): number => x ); // $ExpectError
-}
-
-// Attached to the main export is an `ndarray` method which returns a dispatch function...
-{
-	dispatch.ndarray( addon, fallbackWithOffsets ); // $ExpectType DispatcherWithOffsets
-}
-
-// The compiler throws an error if the `ndarray` method is not provided a first argument which is an add-on function...
-{
-	dispatch.ndarray( '10', fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( 10, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( true, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( false, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( null, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( undefined, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( [], fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( {}, fallbackWithOffsets ); // $ExpectError
-	dispatch.ndarray( ( x: string ): string => x, fallbackWithOffsets ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is not provided a second argument which is a fallback function...
-{
-	dispatch.ndarray( addon, '10' ); // $ExpectError
-	dispatch.ndarray( addon, 10 ); // $ExpectError
-	dispatch.ndarray( addon, true ); // $ExpectError
-	dispatch.ndarray( addon, false ); // $ExpectError
-	dispatch.ndarray( addon, null ); // $ExpectError
-	dispatch.ndarray( addon, undefined ); // $ExpectError
-	dispatch.ndarray( addon, [] ); // $ExpectError
-	dispatch.ndarray( addon, {} ); // $ExpectError
-	dispatch.ndarray( addon, ( x: string ): string => x ); // $ExpectError
-}
-
-// The `ndarray` method returns a function which returns a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectType Collection
-}
-
-// The compiler throws an error if the returned function is not provided a first argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( '10', 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( true, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( false, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( null, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( undefined, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( [], 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( {}, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( ( x: number ): number => x, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a third argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', true, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', false, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', null, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', undefined, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', {}, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fourth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, '10', 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, true, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, false, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, null, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, undefined, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, [], 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, {}, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, ( x: number ): number => x, 0, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a fifth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, '10', 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, true, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, false, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, null, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, undefined, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, [], 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, {}, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, ( x: number ): number => x, 'float64', y, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a seventh argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( y.length, 'float64', x, 1, 0, 'float64', true, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 0, 'float64', false, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 0, 'float64', null, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 0, 'float64', undefined, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( y.length, 'float64', x, 1, 0, 'float64', {}, 1, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided an eighth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0, 'float64', y, '10', 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, true, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, false, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, null, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, undefined, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, [], 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, {}, 0, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, ( x: number ): number => x, 0, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a ninth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, '10', 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, true, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, false, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, null, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, undefined, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, [], 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, {}, 'float64', z, 1, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, ( x: number ): number => x, 'float64', z, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided an eleventh argument which is a collection...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( z.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', true, 1, 0 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', false, 1, 0 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', null, 1, 0 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', undefined, 1, 0 ); // $ExpectError
-	f( z.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', {}, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a twelfth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, '10', 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, true, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, false, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, null, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, undefined, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, [], 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, {}, 0 ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, ( x: number ): number => x, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the returned function is not provided a thirteenth argument which is a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( x.length );
-	const z = new Float64Array( x.length );
-
-	const f = dispatch.ndarray( addon, fallbackWithOffsets );
-
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, '10' ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, true ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, false ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, null ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, undefined ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, [] ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, {} ); // $ExpectError
-	f( x.length, 'float64', x, 1, 0, 'float64', y, 1, 0, 'float64', z, 1, ( x: number ): number => x ); // $ExpectError
-}

package/lib/binary.js

@@ -1,200 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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.
-*/
-
-/* eslint-disable max-len */
-
-'use strict';
-
-// MODULES //
-
-var isFunction = require( '@stdlib/assert-is-function' );
-var isTypedArrayLike = require( '@stdlib/assert-is-typed-array-like' );
-var resolve = require( '@stdlib/strided-base-dtype-resolve-enum' );
-var reinterpretComplex64 = require( '@stdlib/strided-base-reinterpret-complex64' );
-var reinterpretComplex128 = require( '@stdlib/strided-base-reinterpret-complex128' );
-
-
-// VARIABLES //
-
-var COMPLEX64 = resolve( 'complex64' );
-var COMPLEX128 = resolve( 'complex128' );
-
-
-// MAIN //
-
-/**
-* Returns a function which dispatches to a native add-on applying a binary function to two input strided arrays.
-*
-* ## Notes
-*
-* -   The returned function has the following signature:
-*
-*     ```text
-*     f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
-*     ```
-*
-*     where
-*
-*     -   **N**: number of indexed elements.
-*     -   **dtypeX**: `x` data type.
-*     -   **x**: input array.
-*     -   **strideX**: `x` stride length.
-*     -   **dtypeY**: `y` data type.
-*     -   **y**: input array.
-*     -   **strideY**: `y` stride length.
-*     -   **dtypeZ**: `z` data type.
-*     -   **z**: output array.
-*     -   **strideY**: `z` stride length.
-*
-* -   The add-on function should have the following signature:
-*
-*     ```text
-*     f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
-*     ```
-*
-*     where
-*
-*     -   **N**: number of indexed elements.
-*     -   **dtypeX**: `x` data type (enumeration constant).
-*     -   **x**: input array.
-*     -   **strideX**: `x` stride length.
-*     -   **dtypeY**: `y` data type (enumeration constant).
-*     -   **y**: input array.
-*     -   **strideY**: `y` stride length.
-*     -   **dtypeZ**: `z` data type (enumeration constant).
-*     -   **z**: output array.
-*     -   **strideZ**: `z` stride length.
-*
-* -   The fallback function should have the following signature:
-*
-*     ```text
-*     f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
-*     ```
-*
-*     where
-*
-*     -   **N**: number of indexed elements.
-*     -   **dtypeX**: `x` data type.
-*     -   **x**: input array.
-*     -   **strideX**: `x` stride length.
-*     -   **dtypeY**: `y` data type.
-*     -   **y**: input array.
-*     -   **strideY**: `y` stride length.
-*     -   **dtypeZ**: `z` data type.
-*     -   **z**: output array.
-*     -   **strideZ**: `z` stride length.
-*
-* @param {Function} addon - add-on interface
-* @param {Function} fallback - fallback function
-* @throws {TypeError} first argument must be a function
-* @throws {TypeError} second argument must be a function
-* @returns {Function} dispatch function
-*
-* @example
-* function addon( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ ) {
-*     // Call into native add-on...
-* }
-*
-* function fallback( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ ) {
-*     // Fallback JavaScript implementation...
-* }
-*
-* // Create a dispatch function:
-* var f = dispatch( addon, fallback );
-*
-* // ...
-*
-* // Invoke the dispatch function with strided array arguments:
-* f( 2, 'generic', [ 1, 2 ], 1, 'generic', [ 3, 4 ], 1, 'generic', [ 0, 0 ], 1 );
-*/
-function dispatch( addon, fallback ) {
-	if ( !isFunction( addon ) ) {
-		throw new TypeError( 'invalid argument. First argument must be a function. Value: `' + addon + '`.' );
-	}
-	if ( !isFunction( fallback ) ) {
-		throw new TypeError( 'invalid argument. Second argument must be a function. Value: `' + fallback + '`.' );
-	}
-	return dispatcher;
-
-	/**
-	* Dispatches to a native add-on.
-	*
-	* @private
-	* @param {integer} N - number of indexed elements
-	* @param {*} dtypeX - `x` data type
-	* @param {Collection} x - input array
-	* @param {integer} strideX - `x` stride length
-	* @param {*} dtypeY - `y` data type
-	* @param {Collection} y - input array
-	* @param {integer} strideY - `y` stride length
-	* @param {*} dtypeZ - `z` data type
-	* @param {Collection} z - destination array
-	* @param {integer} strideZ - `z` stride length
-	* @throws {TypeError} unable to resolve a strided array function supporting the provided array argument data types
-	* @returns {Collection} `z`
-	*/
-	function dispatcher( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ ) {
-		var viewX;
-		var viewY;
-		var viewZ;
-
-		// WARNING: we assume that, if we're provided something resembling a typed array, we're provided a typed array; however, this can lead to potential unintended errors as the native add-on may not work with non-typed array objects (e.g., generic arrays)...
-		if (
-			!isTypedArrayLike( x ) ||
-			!isTypedArrayLike( y ) ||
-			!isTypedArrayLike( z )
-		) {
-			fallback( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ );
-			return z;
-		}
-		dtypeX = resolve( dtypeX );
-		dtypeY = resolve( dtypeY );
-		dtypeZ = resolve( dtypeZ );
-		if ( dtypeX === null || dtypeY === null || dtypeZ === null ) {
-			throw new TypeError( 'invalid arguments. Unable to resolve a strided array function supporting the provided array argument data types.' );
-		}
-		if ( dtypeX === COMPLEX64 ) {
-			viewX = reinterpretComplex64( x, 0 );
-		} else if ( dtypeX === COMPLEX128 ) {
-			viewX = reinterpretComplex128( x, 0 );
-		} else {
-			viewX = x;
-		}
-		if ( dtypeY === COMPLEX64 ) {
-			viewY = reinterpretComplex64( y, 0 );
-		} else if ( dtypeY === COMPLEX128 ) {
-			viewY = reinterpretComplex128( y, 0 );
-		} else {
-			viewY = y;
-		}
-		if ( dtypeZ === COMPLEX64 ) {
-			viewZ = reinterpretComplex64( z, 0 );
-		} else if ( dtypeZ === COMPLEX128 ) {
-			viewZ = reinterpretComplex128( z, 0 );
-		} else {
-			viewZ = z;
-		}
-		addon( N, dtypeX, viewX, strideX, dtypeY, viewY, strideY, dtypeZ, viewZ, strideZ );
-		return z;
-	}
-}
-
-
-// EXPORTS //
-
-module.exports = dispatch;