Class Decimal

A type for arbitrary precision, non-negative decimals.

Instances of this class are immutable.

Accessors

atomics fractionalDigits

Methods

ceil equals floor isGreaterThan isGreaterThanOrEqual isLessThan isLessThanOrEqual minus multiply plus toFloatApproximation toString compare fromAtomics fromUserInput one zero

Accessors

atomics

  • get atomics(): string

  • Returns string

fractionalDigits

  • get fractionalDigits(): number

  • Returns number

Methods

ceil

  • ceil(): Decimal

  • Returns the smallest decimal >= this which has no fractional part (rounding up)

    Returns Decimal

equals

  • equals(b): boolean

  • Parameters

    Returns boolean

floor

  • floor(): Decimal

  • Returns the greatest decimal <= this which has no fractional part (rounding down)

    Returns Decimal

isGreaterThan

  • isGreaterThan(b): boolean

  • Parameters

    Returns boolean

isGreaterThanOrEqual

  • isGreaterThanOrEqual(b): boolean

  • Parameters

    Returns boolean

isLessThan

  • isLessThan(b): boolean

  • Parameters

    Returns boolean

isLessThanOrEqual

  • isLessThanOrEqual(b): boolean

  • Parameters

    Returns boolean

minus

  • minus(b): Decimal

  • a.minus(b) returns a-b.

    Both values need to have the same fractional digits. The resulting difference needs to be non-negative.

    Parameters

    Returns Decimal

multiply

  • multiply(b): Decimal

  • a.multiply(b) returns a*b.

    We only allow multiplication by unsigned integers to avoid rounding errors.

    Parameters

    Returns Decimal

plus

  • plus(b): Decimal

  • a.plus(b) returns a+b.

    Both values need to have the same fractional digits.

    Parameters

    Returns Decimal

toFloatApproximation

  • toFloatApproximation(): number

  • Returns an approximation as a float type. Only use this if no exact calculation is required.

    Returns number

toString

  • toString(): string

  • Returns string

Staticcompare

  • compare(a, b): number

  • Parameters

    Returns number

StaticfromAtomics

  • fromAtomics(atomics, fractionalDigits): Decimal

  • Parameters

    • atomics: string
    • fractionalDigits: number

    Returns Decimal

StaticfromUserInput

  • fromUserInput(input, fractionalDigits): Decimal

  • Parameters

    • input: string
    • fractionalDigits: number

    Returns Decimal

Staticone

  • one(fractionalDigits): Decimal

  • Creates a Decimal with value 1.0 and the given number of fractial digits.

    Fractional digits are not relevant for the value but needed to be able to perform arithmetic operations with other decimals.

    Parameters

    • fractionalDigits: number

    Returns Decimal

Staticzero

  • zero(fractionalDigits): Decimal

  • Creates a Decimal with value 0.0 and the given number of fractial digits.

    Fractional digits are not relevant for the value but needed to be able to perform arithmetic operations with other decimals.

    Parameters

    • fractionalDigits: number

    Returns Decimal

Settings

Member Visibility

On This Page

Accessors
Methods