-
Notifications
You must be signed in to change notification settings - Fork 67
/
fraction.d.ts
143 lines (113 loc) · 4.58 KB
/
fraction.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
131
132
133
134
135
136
137
138
139
140
141
142
143
declare module 'Fraction';
/**
* Interface representing a fraction with numerator and denominator.
*/
export interface NumeratorDenominator {
n: number | BigInt;
d: number | BigInt;
}
/**
* Type for handling multiple types of input for Fraction operations.
* Allows passing fractions, numbers, strings, or objects containing
* a numerator and denominator.
*/
type FractionInput = Fraction | number | string | [number | string, number | string] | NumeratorDenominator;
/**
* Function signature for Fraction operations like add, sub, mul, etc.
* Accepts various types of inputs and returns a Fraction.
*/
type FractionParam = {
(fraction: Fraction): Fraction;
(num: number | BigInt | string): Fraction;
(numerator: number | BigInt, denominator: number | BigInt): Fraction;
(numbers: [number | BigInt | string, number | BigInt | string]): Fraction;
(fraction: NumeratorDenominator): Fraction;
(firstValue: FractionInput): Fraction;
};
/**
* Fraction class representing a rational number with numerator and denominator.
* Supports arithmetic, comparison, and formatting operations.
*/
export default class Fraction {
/**
* Constructs a new Fraction instance.
* Can accept another Fraction, a number, a string, a tuple, or an object with numerator and denominator.
*/
constructor(fraction: Fraction);
constructor(num: number | BigInt | string);
constructor(numerator: number | BigInt, denominator: number | BigInt);
constructor(numbers: [number | BigInt | string, number | BigInt | string]);
constructor(fraction: NumeratorDenominator);
constructor(firstValue: FractionInput, secondValue?: number);
/** The sign of the fraction (-1 or 1) */
s: BigInt;
/** The numerator of the fraction */
n: BigInt;
/** The denominator of the fraction */
d: BigInt;
/** Returns the absolute value of the fraction */
abs(): Fraction;
/** Negates the fraction */
neg(): Fraction;
/** Adds a fraction or number */
add: FractionParam;
/** Subtracts a fraction or number */
sub: FractionParam;
/** Multiplies by a fraction or number */
mul: FractionParam;
/** Divides by a fraction or number */
div: FractionParam;
/** Raises the fraction to a given power */
pow: FractionParam;
/** Finds the greatest common divisor (gcd) with another fraction or number */
gcd: FractionParam;
/** Finds the least common multiple (lcm) with another fraction or number */
lcm: FractionParam;
/**
* Returns the modulo of the fraction with respect to another fraction or number.
* If no argument is passed, it returns the fraction modulo 1.
*/
mod(n?: number | BigInt | string | Fraction): Fraction;
/** Rounds the fraction up to the nearest integer, optionally specifying the number of decimal places */
ceil(places?: number): Fraction;
/** Rounds the fraction down to the nearest integer, optionally specifying the number of decimal places */
floor(places?: number): Fraction;
/** Rounds the fraction to the nearest integer, optionally specifying the number of decimal places */
round(places?: number): Fraction;
/** Rounds the fraction to the nearest multiple of another fraction or number */
roundTo: FractionParam;
/** Returns the inverse of the fraction (numerator and denominator swapped) */
inverse(): Fraction;
/**
* Simplifies the fraction to its simplest form.
* Optionally accepts an epsilon value for controlling precision in approximation.
*/
simplify(eps?: number): Fraction;
/** Checks if two fractions or numbers are equal */
equals(n: number | BigInt | string | Fraction): boolean;
/** Compares two fractions or numbers. Returns -1, 0, or 1 based on the comparison. */
compare(n: number | BigInt | string | Fraction): number;
/** Checks if the fraction is divisible by another fraction or number */
divisible(n: number | BigInt | string | Fraction): boolean;
/** Returns the decimal representation of the fraction */
valueOf(): number;
/**
* Returns a string representation of the fraction.
* Optionally specifies the number of decimal places.
*/
toString(decimalPlaces?: number): string;
/**
* Returns a LaTeX string representing the fraction.
* Optionally excludes the whole part in the LaTeX string.
*/
toLatex(showMixed?: boolean): string;
/**
* Returns a string representing the fraction in fraction format.
* Optionally excludes the whole part of the fraction.
*/
toFraction(showMixed?: boolean): string;
/** Returns an array representing the continued fraction form of the fraction */
toContinued(): BigInt[];
/** Returns a clone of the current fraction */
clone(): Fraction;
}