-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
88 lines (79 loc) · 2.2 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
/*
* @license Apache-2.0
*
* Copyright (c) 2020 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
/// <reference types="@stdlib/types"/>
import { NumericArray } from '@stdlib/types/array';
/**
* Interface describing `gnansumpw`.
*/
interface Routine {
/**
* Computes the sum of strided array elements, ignoring `NaN` values and using pairwise summation.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @returns sum
*
* @example
* var x = [ 1.0, -2.0, NaN, 2.0 ];
*
* var v = gnansumpw( x.length, x, 1 );
* // returns 1.0
*/
( N: number, x: NumericArray, stride: number ): number;
/**
* Computes the sum of strided array elements, ignoring `NaN` values and using pairwise summation and alternative indexing semantics.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param offset - starting index
* @returns sum
*
* @example
* var x = [ 1.0, -2.0, NaN, 2.0 ];
*
* var v = gnansumpw.ndarray( x.length, x, 1, 0 );
* // returns 1.0
*/
ndarray( N: number, x: NumericArray, stride: number, offset: number ): number; // tslint:disable-line:max-line-length
}
/**
* Computes the sum of strided array elements, ignoring `NaN` values and using pairwise summation.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @returns sum
*
* @example
* var x = [ 1.0, -2.0, NaN, 2.0 ];
*
* var v = gnansumpw( x.length, x, 1 );
* // returns 1.0
*
* @example
* var x = [ 1.0, -2.0, NaN, 2.0 ];
*
* var v = gnansumpw.ndarray( x.length, x, 1, 0 );
* // returns 1.0
*/
declare var gnansumpw: Routine;
// EXPORTS //
export = gnansumpw;