base/com.splendo.kaluga.base.utils/Decimal

Decimal

sealed class Decimal : Comparable<Decimal>

Immutable, arbitrary-precision signed decimal numbers.

On JavaScript Decimal is backed by a custom implementation that may not cover every edge case; validate results when relying on it for JS.

Inheritors

Types

Companion

object Companion

Finite

data class Finite(finiteDecimal: FiniteDecimal) : Decimal

Decimal representing a finite number

NaN

data object NaN : Decimal

Decimal representing Not A Number

NegativeInfinity

data object NegativeInfinity : Decimal

Decimal representing Negative Infinity

PositiveInfinity

data object PositiveInfinity : Decimal

Decimal representing Positive Infinity

Functions

compareTo

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

div

operator fun Decimal.div(value: Decimal): Decimal

Divides two Decimal.

fun Decimal.div(value: Decimal, scale: Int): Decimal

fun Decimal.div(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Divides two Decimal to a given precision.

minus

operator fun Decimal.minus(value: Decimal): Decimal

Subtracts two Decimal.

fun Decimal.minus(value: Decimal, scale: Int): Decimal

fun Decimal.minus(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Subtracts two Decimal to a given precision.

plus

operator fun Decimal.plus(value: Decimal): Decimal

Adds two Decimal together.

fun Decimal.plus(value: Decimal, scale: Int): Decimal

fun Decimal.plus(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Adds two Decimal together scaled to a given precision.

pow

infix fun Decimal.pow(n: Int): Decimal

Raises two Decimal.

fun Decimal.pow(n: Int, scale: Int): Decimal

fun Decimal.pow(n: Int, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Raises two Decimal to a given precision.

round

fun Decimal.round(scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Rounds a Decimal to a scale.

times

operator fun Decimal.times(value: Decimal): Decimal

Multiplies two Decimal.

fun Decimal.times(value: Decimal, scale: Int): Decimal

fun Decimal.times(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Multiplies two Decimal to a given precision.

toDouble

fun Decimal.toDouble(): Double

Gets the double value of a Decimal

toInt

fun Decimal.toInt(): Int

Gets the integer value of a Decimal

toLong

fun Decimal.toLong(): Long

Gets the long value of a Decimal

toString

fun Decimal.toString(): String

Gets the string value of a Decimal