korge-foundation/korlibs.bignumber/BigNum

BigNum

class BigNum(val int: BigInt, val scale: Int) : Comparable<BigNum>

Represents a BigNum, a numeric value with decimal places that is exact.

There are no precision issues like happens with Float or Double floating point types.

Constructors

BigNum

constructor(int: BigInt, scale: Int)

Types

Companion

object Companion

Properties

decimalPart

val decimalPart: BigInt

Returns the decimal part as a BigInt of this BigNum so for 1.9123.bn it will return 9123.bi

int

val int: BigInt

scale

val scale: Int

Functions

compareTo

open operator override fun compareTo(other: BigNum): Int

convertToScale

fun convertToScale(otherScale: Int): BigNum

Converts the internal scale of this BigNum to otherScale while keeping the same value.

div

operator fun div(other: BigNum): BigNum

Performs this / other returning a BigNum

fun div(other: BigNum, precision: Int): BigNum

Performs this / other returning a BigNum using a specific precision

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

minus

operator fun minus(other: BigNum): BigNum

Performs this - other returning a BigNum, if the scale is different for both numbers, it finds a common one

plus

operator fun plus(other: BigNum): BigNum

Performs this + other returning a BigNum, if the scale is different for both numbers, it finds a common one

pow

infix fun pow(exponent: Int): BigNum

Performs this ** exponent

fun pow(exponent: Int, precision: Int): BigNum

Performs this ** exponent with a specific precision

rangeTo

operator fun rangeTo(that: BigNum): ClosedBigNumRange

Creates a ClosedBigNumRange between this and that

times

operator fun times(other: BigNum): BigNum

Performs this * other returning a BigNum, the scale ends being the sum of both scales

toBigInt

fun toBigInt(): BigInt

Converts this BigInt effectively losing the decimal places

toBigIntCeil

fun toBigIntCeil(): BigInt

Converts this BigInt doing ceiling when there are decimals

toBigIntFloor

fun toBigIntFloor(): BigInt

Converts this BigInt doing flooring when there are decimals

toBigIntRound

fun toBigIntRound(): BigInt

Converts this BigInt doing rounding when there are decimals

toString

open override fun toString(): String