All files / unary-addon-dispatch/lib main.js

65.53% Statements 116/177
100% Branches 1/1
0% Functions 0/1
65.53% Lines 116/177

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 1781x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                                                           1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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.
*/
 
'use strict';
 
// MODULES //
 
var isFunction = require( '@stdlib/assert/is-function' );
var isTypedArrayLike = require( '@stdlib/assert/is-typed-array-like' );
var resolveEnum = require( '@stdlib/ndarray/base/dtype-resolve-enum' );
var reinterpretComplex64 = require( '@stdlib/strided/base/reinterpret-complex64' );
var reinterpretComplex128 = require( '@stdlib/strided/base/reinterpret-complex128' );
var reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var getDType = require( '@stdlib/ndarray/base/dtype' );
var serialize = require( '@stdlib/ndarray/base/serialize-meta-data' );
var format = require( '@stdlib/string/format' );
 
 
// VARIABLES //
 
var COMPLEX64 = resolveEnum( 'complex64' );
var COMPLEX128 = resolveEnum( 'complex128' );
var BOOLEAN = resolveEnum( 'bool' );
 
 
// MAIN //
 
/**
* Returns a function which dispatches to a native add-on applying a unary function to an input ndarray.
*
* ## Notes
*
* -   The returned function has the following signature:
*
*     ```text
*     f( x, y )
*     ```
*
*     where
*
*     -   **x**: input ndarray.
*     -   **y**: output ndarray.
*
* -   The add-on function should have the following signature:
*
*     ```text
*     f( xbuf, metaX, ybuf, metaY )
*     ```
*
*     where
*
*     -   **xbuf**: input ndarray data buffer.
*     -   **metaX**: serialized input ndarray meta data.
*     -   **ybuf**: output array data buffer.
*     -   **metaY**: serialized output ndarray meta data.
*
* -   The fallback function should have the following signature:
*
*     ```text
*     f( x, y )
*     ```
*
*     where
*
*     -   **x**: input ndarray.
*     -   **y**: output ndarray.
*
* @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
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* function addon( x, metaX, y, metaY ) {
*     // Call into native add-on...
* }
*
* function fallback( x, y ) {
*     // Fallback JavaScript implementation...
* }
*
* // Create a dispatch function:
* var f = dispatch( addon, fallback );
*
* // ...
*
* // Invoke the dispatch function with ndarray arguments:
* var x = array( [ [ 1, 2], [ 3, 4 ] ] );
* var y = zeros( [ 2, 2 ] );
* f( x, y );
*/
function dispatch( addon, fallback ) {
	if ( !isFunction( addon ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', addon ) );
	}
	if ( !isFunction( fallback ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fallback ) );
	}
	return dispatcher;

	/**
	* Dispatches to a native add-on.
	*
	* @private
	* @param {ndarray} x - input array
	* @param {ndarray} y - output array
	* @throws {TypeError} unable to resolve an ndarray function supporting the provided argument data types
	* @returns {ndarray} output array
	*/
	function dispatcher( x, y ) {
		var dtypeX;
		var dtypeY;
		var dataX;
		var dataY;
		var viewX;
		var viewY;

		dataX = getData( x );
		dataY = getData( y );

		// WARNING: we assume that, if we're provided something which has a data buffer resembling a typed array, we're provided an ndarray with a typed array buffer; 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( dataX ) || !isTypedArrayLike( dataY ) ) {
			fallback( x, y );
			return y;
		}
		dtypeX = resolveEnum( getDType( x ) );
		dtypeY = resolveEnum( getDType( y ) );
		if ( dtypeX === null || dtypeY === null ) {
			throw new TypeError( 'invalid arguments. Unable to resolve an ndarray function supporting the provided argument data types.' );
		}
		if ( dtypeX === COMPLEX64 ) {
			viewX = reinterpretComplex64( dataX, 0 );
		} else if ( dtypeX === COMPLEX128 ) {
			viewX = reinterpretComplex128( dataX, 0 );
		} else if ( dtypeX === BOOLEAN ) {
			viewX = reinterpretBoolean( dataX, 0 );
		} else {
			viewX = dataX;
		}
		if ( dtypeY === COMPLEX64 ) {
			viewY = reinterpretComplex64( dataY, 0 );
		} else if ( dtypeY === COMPLEX128 ) {
			viewY = reinterpretComplex128( dataY, 0 );
		} else if ( dtypeY === BOOLEAN ) {
			viewY = reinterpretBoolean( dataY, 0 );
		} else {
			viewY = dataY;
		}
		addon( viewX, serialize( x ), viewY, serialize( y ) );
		return y;
	}
}
 
 
// EXPORTS //
 
module.exports = dispatch;