Interface ExactNumberType

interface ExactNumberType {
    type: "fraction" | "fixed";
    abs(): ExactNumberType;
    add(x: string | number | bigint | ExactNumberType): ExactNumberType;
    bitwiseAnd(x: string | number | bigint | ExactNumberType): ExactNumberType;
    bitwiseOr(x: string | number | bigint | ExactNumberType): ExactNumberType;
    bitwiseXor(x: string | number | bigint | ExactNumberType): ExactNumberType;
    ceil(decimals?: number): ExactNumberType;
    clamp(
        min: string | number | bigint | ExactNumberType,
        max: string | number | bigint | ExactNumberType,
    ): ExactNumberType;
    cmp(x: string | number | bigint | ExactNumberType): -1 | 0 | 1;
    div(x: string | number | bigint | ExactNumberType): ExactNumberType;
    divToInt(x: string | number | bigint | ExactNumberType): ExactNumberType;
    eq(x: string | number | bigint | ExactNumberType): boolean;
    floor(decimals?: number): ExactNumberType;
    fracPart(): ExactNumberType;
    getFractionParts(
        normalize?: boolean,
    ): { denominator: ExactNumberType; numerator: ExactNumberType };
    gt(x: string | number | bigint | ExactNumberType): boolean;
    gte(x: string | number | bigint | ExactNumberType): boolean;
    intPart(): ExactNumberType;
    inv(): ExactNumberType;
    isInteger(): boolean;
    isNegative(): boolean;
    isOne(): boolean;
    isZero(): boolean;
    limitDecimals(
        maxDecimals: number,
        roundingMode?: RoundingMode,
    ): ExactNumberType;
    lt(x: string | number | bigint | ExactNumberType): boolean;
    lte(x: string | number | bigint | ExactNumberType): boolean;
    mod(
        x: string | number | bigint | ExactNumberType,
        type?: ModType,
    ): ExactNumberType;
    mul(x: string | number | bigint | ExactNumberType): ExactNumberType;
    neg(): ExactNumberType;
    normalize(): ExactNumberType;
    pow(x: string | number | bigint | ExactNumberType): ExactNumberType;
    powm(
        exponent: string | number | bigint | ExactNumberType,
        modulus: string | number | bigint | ExactNumberType,
        type?: ModType,
    ): ExactNumberType;
    round(decimals?: number, roundingMode?: RoundingMode): ExactNumberType;
    roundToDigits(digits: number, roundingMode: RoundingMode): ExactNumberType;
    shiftLeft(bitCount: number): ExactNumberType;
    shiftRight(bitCount: number): ExactNumberType;
    sign(): -1 | 1;
    sub(x: string | number | bigint | ExactNumberType): ExactNumberType;
    toExponential(
        digits: number,
        roundingMode?: RoundingMode,
        trimZeros?: boolean,
    ): string;
    toFixed(
        decimals: number,
        roundingMode?: RoundingMode,
        trimZeros?: boolean,
    ): string;
    toFraction(): string;
    toNumber(): number;
    toPrecision(
        digits: number,
        roundingMode?: RoundingMode,
        trimZeros?: boolean,
    ): string;
    toString(radix?: number, maxDigits?: number): string;
    trunc(decimals?: number): ExactNumberType;
}

Properties

type

type: "fraction" | "fixed"

Methods

abs

abs(): ExactNumberType
Returns the absolute value of this number.

Returns ExactNumberType
- Defined in types.ts:66

add

add(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the sum of this number and the given one.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:39

bitwiseAnd

bitwiseAnd(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the integer bitwise-and combined with another integer.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:121

bitwiseOr

bitwiseOr(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the integer bitwise-or combined with another integer.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:124

bitwiseXor

bitwiseXor(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the integer bitwise-xor combined with another integer.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:127

ceil

ceil(decimals?: number): ExactNumberType
Returns a number which is rounded up to the next largest integer. Same as round(RoundingMode.TO_POSITIVE).
Parameters
- Optionaldecimals: number
Returns ExactNumberType
- Defined in types.ts:99

clamp

clamp(
min: string | number | bigint | ExactNumberType,
max: string | number | bigint | ExactNumberType,
): ExactNumberType
Returns number which is clamped to the range delineated by min and max.
Parameters
- min: string | number | bigint | ExactNumberType
- max: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:158

cmp

cmp(x: string | number | bigint | ExactNumberType): -1 | 0 | 1
Compares the current number to the provided number. Returns -1 when the provided number is smaller than the current one. Returns 0 when the provided number is equal with the current one. Returns 1 when the provided number is greater than the current one.
Parameters
- x: string | number | bigint | ExactNumberType
Returns -1 | 0 | 1
- Defined in types.ts:140

div

div(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the result of the division of this number by the given one.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:58

divToInt

divToInt(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the result of the integer division of this number by the given one. The fractional part is truncated.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:61

eq

eq(x: string | number | bigint | ExactNumberType): boolean
Returns true if the current number is equal to the provided number
Parameters
- x: string | number | bigint | ExactNumberType
Returns boolean
- Defined in types.ts:143

floor

floor(decimals?: number): ExactNumberType
Returns the largest number, but less than or equal to the current number. Same as round(RoundingMode.TO_NEGATIVE).
Parameters
- Optionaldecimals: number
Returns ExactNumberType
- Defined in types.ts:96

fracPart

fracPart(): ExactNumberType
Returns the fractional part of the number (|res| < 1).

Returns ExactNumberType
- Defined in types.ts:81

getFractionParts

getFractionParts(
normalize?: boolean,
): { denominator: ExactNumberType; numerator: ExactNumberType }
Returns the numerator and the denominator of the current number. By default it simplifies the fraction
Parameters
- Optionalnormalize: boolean
Returns { denominator: ExactNumberType; numerator: ExactNumberType }
- Defined in types.ts:165

gt

gt(x: string | number | bigint | ExactNumberType): boolean
Returns true if the current number is greater than the provided number
Parameters
- x: string | number | bigint | ExactNumberType
Returns boolean
- Defined in types.ts:152

gte

gte(x: string | number | bigint | ExactNumberType): boolean
Returns true if the current number is greater than or equal to the provided number
Parameters
- x: string | number | bigint | ExactNumberType
Returns boolean
- Defined in types.ts:155

intPart

intPart(): ExactNumberType
Returns the integer part of the number.

Returns ExactNumberType
- Defined in types.ts:78

inv

inv(): ExactNumberType
Returns the inverse of the number. (1/x)

Returns ExactNumberType
- Defined in types.ts:75

isInteger

isInteger(): boolean
Returns true if the number does not have a fractional part.

Returns boolean
- Defined in types.ts:90

isNegative

isNegative(): boolean
Returns true if the number is negative.

Returns boolean
- Defined in types.ts:93

isOne

isOne(): boolean
Returns true if the number is equal with one.

Returns boolean
- Defined in types.ts:87

isZero

isZero(): boolean
Returns true if the number is equal with zero.

Returns boolean
- Defined in types.ts:84

limitDecimals

limitDecimals(maxDecimals: number, roundingMode?: RoundingMode): ExactNumberType
Ensures that number can be represented with specified amount of decimals. In contrary to round(), this function keeps the repeating decimals in place if cycle length fits into the limit. RoundingMode.NEAREST_TO_POSITIVE is the default
Parameters
- maxDecimals: number
- OptionalroundingMode: RoundingMode
Returns ExactNumberType
- Defined in types.ts:118

lt

lt(x: string | number | bigint | ExactNumberType): boolean
Returns true if the current number is less than the provided number
Parameters
- x: string | number | bigint | ExactNumberType
Returns boolean
- Defined in types.ts:146

lte

lte(x: string | number | bigint | ExactNumberType): boolean
Returns true if the current number is less than or equal to the provided number
Parameters
- x: string | number | bigint | ExactNumberType
Returns boolean
- Defined in types.ts:149

mod

mod(
x: string | number | bigint | ExactNumberType,
type?: ModType,
): ExactNumberType
Parameters
- x: string | number | bigint | ExactNumberType
- Optionaltype: ModType
Returns ExactNumberType
- Defined in types.ts:63

mul

mul(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the product of this number and the given one.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:45

neg

neg(): ExactNumberType
Returns the number with inverted sign. (-x)

Returns ExactNumberType
- Defined in types.ts:72

normalize

normalize(): ExactNumberType
Returns opimized internal representation of the current number (e.g. it simplifies fractions using GCD) This is may be a slow operation, but in some cases normalization might help with performance of repeated operations.

Returns ExactNumberType
- Defined in types.ts:169

pow

pow(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns this number exponentiated to the given value.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:48

powm

powm(
    exponent: string | number | bigint | ExactNumberType,
    modulus: string | number | bigint | ExactNumberType,
    type?: ModType,
): ExactNumberType
Returns modulo of this number exponentiated to the given value (modular exponentiation)
Parameters
- exponent: string | number | bigint | ExactNumberType
- modulus: string | number | bigint | ExactNumberType
- Optionaltype: ModType
Returns ExactNumberType
- Defined in types.ts:51

round

round(decimals?: number, roundingMode?: RoundingMode): ExactNumberType
Rounds current number to the specified amount of decimals. RoundingMode.NEAREST_TO_POSITIVE is the default
Parameters
- Optionaldecimals: number
- OptionalroundingMode: RoundingMode
Returns ExactNumberType
- Defined in types.ts:107

roundToDigits

roundToDigits(digits: number, roundingMode: RoundingMode): ExactNumberType
Rounds current number to the specified amount of significant digits. RoundingMode.NEAREST_TO_POSITIVE is the default
Parameters
- digits: number
- roundingMode: RoundingMode
Returns ExactNumberType
- Defined in types.ts:112

shiftLeft

shiftLeft(bitCount: number): ExactNumberType
Returns the integer left shifted by a given number of bits.
Parameters
- bitCount: number
Returns ExactNumberType
- Defined in types.ts:130

shiftRight

shiftRight(bitCount: number): ExactNumberType
Returns the integer right shifted by a given number of bits.
Parameters
- bitCount: number
Returns ExactNumberType
- Defined in types.ts:133

sign

sign(): -1 | 1
Returns the sign of the current value as a number (-1 or 1)

Returns -1 | 1
- Defined in types.ts:69

sub

sub(x: string | number | bigint | ExactNumberType): ExactNumberType
Returns the difference of this number and the given one.
Parameters
- x: string | number | bigint | ExactNumberType
Returns ExactNumberType
- Defined in types.ts:42

toExponential

toExponential(
    digits: number,
    roundingMode?: RoundingMode,
    trimZeros?: boolean,
): string
Returns a string representing the number in exponential notation. Defaults to RoundingMode.TO_ZERO
Parameters
- digits: number
- OptionalroundingMode: RoundingMode
- OptionaltrimZeros: boolean
Returns string
- Defined in types.ts:179

toFixed

toFixed(
    decimals: number,
    roundingMode?: RoundingMode,
    trimZeros?: boolean,
): string
Returns a string representing the number using fixed-point notation, rounded to the specified number of decimals. Defaults to RoundingMode.TO_ZERO
Parameters
- decimals: number
- OptionalroundingMode: RoundingMode
- OptionaltrimZeros: boolean
Returns string
- Defined in types.ts:174

toFraction

toFraction(): string
Returns string representation of the current number in a fractional format like "1/2". It always simplifies the fraction before output.

Returns string
- Defined in types.ts:191

toNumber

toNumber(): number
Converts current value to a JavaScript Number

Returns number
- Defined in types.ts:188

toPrecision

toPrecision(
    digits: number,
    roundingMode?: RoundingMode,
    trimZeros?: boolean,
): string
Returns a string representing the number using fixed-point notation, rounded to the specified number of significant digits. In contrary to JS Number.toPrecision(), this function never returns exponential notation. Defaults to RoundingMode.TO_ZERO
Parameters
- digits: number
- OptionalroundingMode: RoundingMode
- OptionaltrimZeros: boolean
Returns string
- Defined in types.ts:185

toString

toString(radix?: number, maxDigits?: number): string
Returns string representation in decimal format. The result might contain repeating digit sequences formatted like "1.4(3)" It is recommended to set a maximum length for the fractional part to avoid performance issues when having long cycles. When such limit is provided, toString() truncates the undesired digits
Parameters
- Optionalradix: number
- OptionalmaxDigits: number
Returns string
- Defined in types.ts:197

trunc

trunc(decimals?: number): ExactNumberType
Truncates the number to the specified number of decimals. Same as round(RoundingMode.TO_ZERO).
Parameters
- Optionaldecimals: number
Returns ExactNumberType
- Defined in types.ts:102

Interface ExactNumberType

Index

Properties

Methods

Properties

type

Methods

abs

Returns ExactNumberType

add

Parameters

Returns ExactNumberType

bitwiseAnd

Parameters

Returns ExactNumberType

bitwiseOr

Parameters

Returns ExactNumberType

bitwiseXor

Parameters

Returns ExactNumberType

ceil

Parameters

Returns ExactNumberType

clamp

Parameters

Returns ExactNumberType

cmp

Parameters

Returns -1 | 0 | 1

div

Parameters

Returns ExactNumberType

divToInt

Parameters

Returns ExactNumberType

eq

Parameters

Returns boolean

floor

Parameters

Returns ExactNumberType

fracPart

Returns ExactNumberType

getFractionParts

Parameters

Returns { denominator: ExactNumberType; numerator: ExactNumberType }

gt

Parameters

Returns boolean

gte

Parameters

Returns boolean

intPart

Returns ExactNumberType

inv

Returns ExactNumberType

isInteger

Returns boolean

isNegative

Returns boolean

isOne

Returns boolean

isZero

Returns boolean

limitDecimals

Parameters

Returns ExactNumberType

lt

Parameters

Returns boolean

lte

Parameters

Returns boolean

mod

Parameters

Returns ExactNumberType

mul

Parameters

Returns ExactNumberType