-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
91 lines (82 loc) · 1.95 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
/*
* @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
/// <reference types="@stdlib/types"/>
/**
* Evaluates a Lucas polynomial.
*
* @param x - value at which to evaluate a Lucas polynomial
* @returns result
*/
type EvaluationFunction = ( x: number ) => number;
/**
* Interface for evaluating Lucas polynomials.
*/
interface Lucaspoly {
/**
* Evaluates a Lucas polynomial.
*
* @param n - Lucas polynomial to evaluate
* @param x - value at which to evaluate a Lucas polynomial
* @returns result
*
* @example
* var v = lucaspoly( 5, 1.0 );
* // returns 11.0
*/
( n: number, x: number ): number;
/**
* Returns a function for evaluating a Lucas polynomial.
*
* @param n - Lucas polynomial to evaluate
* @returns function for evaluating a Lucas polynomial
*
* @example
* var polyval = lucaspoly.factory( 5 );
*
* var v = polyval( 1.0 );
* // returns 11.0
*
* v = polyval( 2.0 );
* // returns 82.0
*/
factory( n: number ): EvaluationFunction;
}
/**
* Evaluates a Lucas polynomial.
*
* @param n - Lucas polynomial to evaluate
* @param x - value at which to evaluate a Lucas polynomial
* @returns result
*
* @example
* var v = lucaspoly( 5, 1.0 );
* // returns 11.0
*
* @example
* var polyval = lucaspoly.factory( 5 );
*
* var v = polyval( 1.0 );
* // returns 11.0
*
* v = polyval( 2.0 );
* // returns 82.0
*/
declare var lucaspoly: Lucaspoly;
// EXPORTS //
export = lucaspoly;