-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
71 lines (66 loc) · 1.78 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
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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
/**
* Evaluates the Heaviside function.
*
* ## Notes
*
* - The `continuity` parameter may be one of the following:
*
* - 'half-maximum': if `x == 0`, the function returns `0.5`.
* - 'left-continuous': if `x == 0`, the function returns `0`.
* - 'right-continuous': if `x == 0`, the function returns `1`.
*
* - By default, if `x == 0`, the function returns `NaN` (i.e., the function is discontinuous).
*
* @param x - input value
* @param continuity - continuity option
* @returns function value
*
* @example
* var v = heaviside( 3.14 );
* // returns 1.0
*
* @example
* var v = heaviside( -3.14 );
* // returns 0.0
*
* @example
* var v = heaviside( 0.0 );
* // returns NaN
*
* @example
* var v = heaviside( 0.0, 'half-maximum' );
* // returns 0.5
*
* @example
* var v = heaviside( 0.0, 'left-continuous' );
* // returns 0.0
*
* @example
* var v = heaviside( 0.0, 'right-continuous' );
* // returns 1.0
*
* @example
* var v = heaviside( NaN );
* // returns NaN
*/
declare function heaviside( x: number, continuity?: 'half-maximum' | 'left-continuous' | 'right-continuous' ): number; // tslint-disable-line max-lines-length
// EXPORTS //
export = heaviside;