Class Decimal

A type for arbitrary precision, non-negative decimals.

Instances of this class are immutable.

Hierarchy

Decimal

Index

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

fractionalDigits

get fractionalDigits(): number
Returns number
- Defined in decimal.ts:103

Methods

ceil

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

Returns Decimal
- Defined in decimal.ts:144

equals

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

floor

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

Returns Decimal
- Defined in decimal.ts:131

isGreaterThan

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

isGreaterThanOrEqual

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

isLessThan

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

isLessThanOrEqual

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

minus

minus(b: Decimal): 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
- b: Decimal
Returns Decimal
- Defined in decimal.ts:197

multiply

multiply(b: Uint32 | Uint53 | Uint64): Decimal
a.multiply(b) returns a*b.

We only allow multiplication by unsigned integers to avoid rounding errors.
Parameters
- b: Uint32 | Uint53 | Uint64
Returns Decimal
- Defined in decimal.ts:209

plus

plus(b: Decimal): Decimal
a.plus(b) returns a+b.

Both values need to have the same fractional digits.
Parameters
- b: Decimal
Returns Decimal
- Defined in decimal.ts:185

toFloatApproximation

toFloatApproximation(): number
Returns an approximation as a float type. Only use this if no exact calculation is required.

Returns number
- Defined in decimal.ts:174

toString

toString(): string
Returns string
- Defined in decimal.ts:156

`Static` compare

compare(a: Decimal, b: Decimal): number
Parameters
- a: Decimal
- b: Decimal
Returns number
- Defined in decimal.ts:94

`Static` fromAtomics

fromAtomics(atomics: string, fractionalDigits: number): Decimal
Parameters
- atomics: string
- fractionalDigits: number
Returns Decimal
- Defined in decimal.ts:59

`Static` fromUserInput

fromUserInput(input: string, fractionalDigits: number): Decimal
Parameters
- input: string
- fractionalDigits: number
Returns Decimal
- Defined in decimal.ts:15

`Static` one

one(fractionalDigits: number): 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
- Defined in decimal.ts:81

`Static` zero

zero(fractionalDigits: number): 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
- Defined in decimal.ts:70

Generated using TypeDoc