@stdlib/strided
Version:
Strided.
139 lines (104 loc) • 4.14 kB
Plain Text
{{alias}}( N, x, sx, y, sy, z, sz, fcn )
Applies a binary function to double-precision floating-point strided input
arrays and assigns results to a double-precision floating-point strided
output array.
The `N` and stride parameters determine which strided array elements are
accessed at runtime.
Indexing is relative to the first index. To introduce an offset, use typed
array views.
Parameters
----------
N: integer
Number of indexed elements.
x: Float64Array
Input array.
sx: integer
Index increment for `x`.
y: Float64Array
Input array.
sy: integer
Index increment for `y`.
z: Float64Array
Destination array.
sz: integer
Index increment for `z`.
fcn: Function
Binary function to apply.
Returns
-------
z: Float64Array
Input array `z`.
Examples
--------
// Standard usage:
> var x = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var y = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var z = new {{alias:/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}( x.length, x, 1, y, 1, z, 1, {{alias:/math/base/ops/add}} )
<Float64Array>[ 2.0, 4.0, 6.0, 8.0 ]
// Using `N` and stride parameters:
> z = new {{alias:/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}( 2, x, 2, y, -1, z, 1, {{alias:/math/base/ops/add}} )
<Float64Array>[ 3.0, 4.0, 0.0, 0.0 ]
// Using view offsets:
> var x0 = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var y0 = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var z0 = new {{alias:/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> var x1 = new {{alias:/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> var y1 = new {{alias:/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
> var z1 = new {{alias:/array/float64}}( z0.buffer, z0.BYTES_PER_ELEMENT*2 );
> {{alias}}( 2, x1, -2, y1, 1, z1, 1, {{alias:/math/base/ops/add}} )
<Float64Array>[ 7.0, 6.0 ]
> z0
<Float64Array>[ 0.0, 0.0, 7.0, 6.0 ]
{{alias}}.ndarray( N, x, sx, ox, y, sy, oy, z, sz, oz, fcn )
Applies a unary function to each element retrieved from a strided input
array according to a callback function and assigns results to a strided
output array using alternative indexing semantics.
While typed array views mandate a view offset based on the underlying
buffer, the offset parameters support indexing semantics based on starting
indices.
Parameters
----------
N: integer
Number of indexed elements.
x: Float64Array
Input array.
sx: integer
Index increment for `x`.
ox: integer
Starting index for `x`.
y: Float64Array
Input array.
sy: integer
Index increment for `y`.
oy: integer
Starting index for `y`.
z: Float64Array
Destination array.
sz: integer
Index increment for `z`.
oz: integer
Starting index for `z`.
fcn: Function
Binary function to apply.
Returns
-------
z: Float64Array
Input array `z`.
Examples
--------
// Standard usage:
> var x = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var y = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var z = new {{alias:/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0, z, 1, 0, {{alias:/math/base/ops/add}} )
<Float64Array>[ 2.0, 4.0, 6.0, 8.0 ]
// Advanced indexing:
> x = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> y = new {{alias:/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> z = new {{alias:/array/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] );
> {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1, z, 1, 1, {{alias:/math/base/ops/add}} )
<Float64Array>[ 0.0, 6.0, 7.0, 0.0 ]
See Also
--------