About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
dispatch
Dispatch to a native add-on applying a nullary function.
Installation
npm install @stdlib/strided-base-nullary-addon-dispatch
Usage
var dispatch = require( '@stdlib/strided-base-nullary-addon-dispatch' );
dispatch( addon, fallback )
Returns a function which dispatches to a native add-on applying a nullary function.
function addon( N, dtypeX, x, strideX ) {
// Call into native add-on...
}
function fallback( N, dtypeX, x, strideX ) {
// 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 );
The returned function has the following signature:
f( N, dtypeX, x, strideX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type. - x: output array.
-
strideX:
x
stride length.
The addon
function should have the following signature:
f( N, dtypeX, x, strideX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type (enumeration constant). - x: output array.
-
strideX:
x
stride length.
The fallback
function should have the following signature:
f( N, dtypeX, x, strideX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type. - x: output array.
-
strideX:
x
stride length.
dispatch.ndarray( addon, fallback )
Returns a function which dispatches to a native add-on applying a nullary function using alternative indexing semantics.
function addon( N, dtypeX, x, strideX ) {
// Call into native add-on...
}
function fallback( N, dtypeX, x, strideX, offsetX ) {
// Fallback JavaScript implementation...
}
// Create a dispatch function:
var f = dispatch.ndarray( addon, fallback );
// ...
// Invoke the dispatch function with strided array arguments:
f( 2, 'generic', [ 1, 2 ], 1, 0 );
The returned function has the following signature:
f( N, dtypeX, x, strideX, offsetX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type. - x: output array.
-
strideX:
x
stride length. -
offsetX: starting
x
index.
The addon
function should have the following signature:
f( N, dtypeX, x, strideX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type (enumeration constant). - x: output array.
-
strideX:
x
stride length.
The fallback
function should have the following signature:
f( N, dtypeX, x, strideX, offsetX )
where
- N: number of indexed elements.
-
dtypeX:
x
data type. - x: output array.
-
strideX:
x
stride length. -
offsetX: starting
x
index.
Notes
- To determine whether to dispatch to the
addon
function, the returned dispatch function checks whether the provided arrays are typed arrays. If the provided arrays are typed arrays, the dispatch function invokes theaddon
function; otherwise, the dispatch function invokes thefallback
function.
Examples
var Float64Array = require( '@stdlib/array-float64' );
var dispatch = require( '@stdlib/strided-base-nullary-addon-dispatch' );
function addon( N, dtypeX, x, strideX ) {
console.log( x );
// => <Float64Array>[ 3, 4 ]
}
function fallback( N, dtypeX, x, strideX, offsetX ) {
console.log( x );
// => [ 1, 2, 3, 4 ]
}
// Create a dispatch function:
var f = dispatch.ndarray( addon, fallback );
// Create a strided array:
var x = new Float64Array( [ 1, 2, 3, 4 ] );
// Dispatch to the add-on function:
f( 2, 'float64', x, 1, 2 );
// Define a new strided array:
x = [ 1, 2, 3, 4 ];
// Dispatch to the fallback function:
f( 2, 'generic', x, 1, 2 );
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.