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 to a native add-on applying a binary function to two input strided arrays.
import dispatch from 'https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary-addon-dispatch@esm/index.mjs';You can also import the following named exports from the package:
import { ndarray } from 'https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary-addon-dispatch@esm/index.mjs';Returns a function which dispatches to a native add-on applying a binary function to two input strided arrays.
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 );The returned function has the following signature:
f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type. - x: input array.
- strideX:
xstride length. - dtypeY:
ydata type. - y: input array.
- strideY:
ystride length. - dtypeZ:
zdata type. - z: output array.
- strideZ:
zstride length.
The addon function should have the following signature:
f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type (enumeration constant). - x: input array.
- strideX:
xstride length. - dtypeY:
ydata type (enumeration constant). - y: input array.
- strideY:
ystride length. - dtypeZ:
zdata type (enumeration constant). - z: output array.
- strideZ:
zstride length.
The fallback function should have the following signature:
f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type. - x: input array.
- strideX:
xstride length. - dtypeY:
ydata type. - y: input array.
- strideY:
ystride length. - dtypeZ:
zdata type. - z: output array.
- strideZ:
zstride length.
Returns a function which dispatches to a native add-on applying a binary function to two input strided arrays using alternative indexing semantics.
function addon( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ ) {
// Call into native add-on...
}
function fallback( N, dtypeX, x, strideX, offsetX, dtypeY, y, strideY, offsetY, dtypeZ, z, strideZ, offsetZ ) {
// 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, 'generic', [ 3, 4 ], 1, 0, 'generic', [ 0, 0 ], 1, 0 );The returned function has the following signature:
f( N, dtypeX, x, strideX, offsetX, dtypeY, y, strideY, offsetY, dtypeZ, z, strideZ, offsetZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type. - x: input array.
- strideX:
xstride length. - offsetX: starting
xindex. - dtypeY:
ydata type. - y: input array.
- strideY:
ystride length. - offsetY: starting
yindex. - dtypeZ:
zdata type. - z: output array.
- strideZ:
zstride length. - offsetZ: starting
zindex.
The addon function should have the following signature:
f( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type (enumeration constant). - x: input array.
- strideX:
xstride length. - dtypeY:
ydata type (enumeration constant). - y: input array.
- strideY:
ystride length. - dtypeZ:
zdata type (enumeration constant). - z: output array.
- strideZ:
zstride length.
The fallback function should have the following signature:
f( N, dtypeX, x, strideX, offsetX, dtypeY, y, strideY, offsetY, dtypeZ, z, strideZ, offsetZ )
where
- N: number of indexed elements.
- dtypeX:
xdata type. - x: input array.
- strideX:
xstride length. - offsetX: starting
xindex. - dtypeY:
ydata type. - y: input array.
- strideY:
ystride length. - offsetY: starting
yindex. - dtypeZ:
zdata type. - z: output array.
- strideZ:
zstride length. - offsetZ: starting
zindex.
- To determine whether to dispatch to the
addonfunction, the returned dispatch function checks whether the provided arrays are typed arrays. If the provided arrays are typed arrays, the dispatch function invokes theaddonfunction; otherwise, the dispatch function invokes thefallbackfunction.
<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">
import Float64Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float64@esm/index.mjs';
import dispatch from 'https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary-addon-dispatch@esm/index.mjs';
function addon( N, dtypeX, x, strideX, dtypeY, y, strideY, dtypeZ, z, strideZ ) {
console.log( x );
// => <Float64Array>[ 3, 4 ]
console.log( y );
// => <Float64Array>[ 7, 8 ]
console.log( z );
// => <Float64Array>[ 0, 0 ]
}
function fallback( N, dtypeX, x, strideX, offsetX, dtypeY, y, strideY, offsetY, dtypeZ, z, strideZ, offsetZ ) {
console.log( x );
// => [ 1, 2, 3, 4 ]
console.log( y );
// => [ 5, 6, 7, 8 ]
console.log( z );
// => [ 0, 0, 0, 0 ]
}
// Create a dispatch function:
var f = dispatch.ndarray( addon, fallback );
// Create strided arrays:
var x = new Float64Array( [ 1, 2, 3, 4 ] );
var y = new Float64Array( [ 5, 6, 7, 8 ] );
var z = new Float64Array( [ 0, 0, 0, 0 ] );
// Dispatch to the add-on function:
f( 2, 'float64', x, 1, 2, 'float64', y, 1, 2, 'float64', z, 1, 2 );
// Define new strided arrays:
x = [ 1, 2, 3, 4 ];
y = [ 5, 6, 7, 8 ];
z = [ 0, 0, 0, 0 ];
// Dispatch to the fallback function:
f( 2, 'generic', x, 1, 2, 'generic', y, 1, 2, 'generic', z, 1, 2 );
</script>
</body>
</html>This package is part of stdlib, a standard library 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.
See LICENSE.
Copyright © 2016-2026. The Stdlib Authors.