-
-
Notifications
You must be signed in to change notification settings - Fork 399
/
index.d.ts
130 lines (122 loc) · 4.53 KB
/
index.d.ts
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
/*
* @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.
*/
// TypeScript Version: 2.0
/**
* Callback invoked for indexed strided input array elements.
*
* @param x - strided array element
* @param y - strided array element
* @returns result
*/
type Binary = ( x: number, y: number ) => number;
/**
* Interface describing `smap2`.
*/
interface Routine {
/**
* Applies a binary function to single-precision floating-point strided input arrays and assigns results to a single-precision floating-point strided output array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param y - input array
* @param strideY - `y` stride length
* @param z - destination array
* @param strideZ - `z` stride length
* @param fcn - binary function to apply
* @returns `z`
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var addf = require( `@stdlib/math/base/ops/addf` );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* smap2( x.length, x, 1, y, 1, z, 1, addf );
* // z => <Float32Array>[ 2.0, 4.0, 6.0, 8.0, 10.0 ]
*/
( N: number, x: Float32Array, strideX: number, y: Float32Array, strideY: number, z: Float32Array, strideZ: number, fcn: Binary ): Float32Array; // tslint:disable-line:max-line-length
/**
* Applies a binary function to single-precision floating-point strided input arrays and assigns results to a single-precision floating-point strided output array using alternative indexing semantics.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param offsetX - starting index for `x`
* @param y - input array
* @param strideY - `y` stride length
* @param offsetY - starting index for `y`
* @param z - destination array
* @param strideZ - `z` stride length
* @param offsetZ - starting index for `z`
* @param fcn - binary function to apply
* @returns `z`
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var addf = require( `@stdlib/math/base/ops/addf` );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* smap2.ndarray( x.length, x, 1, 0, y, 1, 0, z, 1, 0, addf );
* // z => <Float32Array>[ 2.0, 4.0, 6.0, 8.0, 10.0 ]
*/
ndarray( N: number, x: Float32Array, strideX: number, offsetX: number, y: Float32Array, strideY: number, offsetY: number, z: Float32Array, strideZ: number, offsetZ: number, fcn: Binary ): Float32Array; // tslint:disable-line:max-line-length
}
/**
* Applies a binary function to single-precision floating-point strided input arrays and assigns results to a single-precision floating-point strided output array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param y - input array
* @param strideY - `y` stride length
* @param z - destination array
* @param strideZ - `z` stride length
* @param fcn - binary function to apply
* @returns `z`
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var addf = require( `@stdlib/math/base/ops/addf` );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* smap2( x.length, x, 1, y, 1, z, 1, addf );
* // z => <Float32Array>[ 2.0, 4.0, 6.0, 8.0, 10.0 ]
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var addf = require( `@stdlib/math/base/ops/addf` );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* smap2.ndarray( x.length, x, 1, 0, y, 1, 0, z, 1, 0, addf );
* // z => <Float32Array>[ 2.0, 4.0, 6.0, 8.0, 10.0 ]
*/
declare var smap2: Routine;
// EXPORTS //
export = smap2;