Class Decimal

A type for arbitrary precision, non-negative decimals.

Instances of this class are immutable.

Hierarchy

Decimal

Index

Accessors

Methods

Accessors

atomics

get atomics(): string

- Defined in decimal.ts:99
Returns string

fractionalDigits

get fractionalDigits(): number

- Defined in decimal.ts:103
Returns number

Methods

ceil

ceil(): Decimal

- Defined in decimal.ts:144
Returns the smallest decimal >= this which has no fractional part (rounding up)

Returns Decimal

equals

equals(b: Decimal): boolean

- Defined in decimal.ts:214
Parameters
- b: Decimal
Returns boolean

floor

floor(): Decimal

- Defined in decimal.ts:131
Returns the greatest decimal <= this which has no fractional part (rounding down)

Returns Decimal

isGreaterThan

isGreaterThan(b: Decimal): boolean

- Defined in decimal.ts:226
Parameters
- b: Decimal
Returns boolean

isGreaterThanOrEqual

isGreaterThanOrEqual(b: Decimal): boolean

- Defined in decimal.ts:230
Parameters
- b: Decimal
Returns boolean

isLessThan

isLessThan(b: Decimal): boolean

- Defined in decimal.ts:218
Parameters
- b: Decimal
Returns boolean

isLessThanOrEqual

isLessThanOrEqual(b: Decimal): boolean

- Defined in decimal.ts:222
Parameters
- b: Decimal
Returns boolean

minus

minus(b: Decimal): Decimal

- Defined in decimal.ts:197
a.minus(b) returns a-b.

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

Parameters
- b: Decimal
Returns Decimal

multiply

multiply(b: Uint32 | Uint53 | Uint64): Decimal

- Defined in decimal.ts:209
a.multiply(b) returns a*b.

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

Parameters
- b: Uint32 | Uint53 | Uint64
Returns Decimal

plus

plus(b: Decimal): Decimal

- Defined in decimal.ts:185
a.plus(b) returns a+b.

Both values need to have the same fractional digits.

Parameters
- b: Decimal
Returns Decimal

toFloatApproximation

toFloatApproximation(): number

- Defined in decimal.ts:174
Returns an approximation as a float type. Only use this if no exact calculation is required.

Returns number

toString

toString(): string

- Defined in decimal.ts:156
Returns string

Static compare

compare(a: Decimal, b: Decimal): number

- Defined in decimal.ts:94
Parameters
- a: Decimal
- b: Decimal
Returns number

Static fromAtomics

fromAtomics(atomics: string, fractionalDigits: number): Decimal

- Defined in decimal.ts:59
Parameters
- atomics: string
- fractionalDigits: number
Returns Decimal

Static fromUserInput

fromUserInput(input: string, fractionalDigits: number): Decimal

- Defined in decimal.ts:15
Parameters
- input: string
- fractionalDigits: number
Returns Decimal

Static one

one(fractionalDigits: number): Decimal

- Defined in decimal.ts:81
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

Static zero

zero(fractionalDigits: number): Decimal

- Defined in decimal.ts:70
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

Generated using TypeDoc