api_quantity/com.tomtom.tools.android.api.quantity/Probability

Probability

@Serializable

data class Probability : Quantity<Probability, Probability.Unit>

A quantity describing probability. (For example, 10%.)

Types

object Companion

enum Unit : Enum<Probability.Unit>

The unit of a probability's value.

Functions

open override fun abs(): Probability

Returns a new instance with the value from this as absolute value.

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

fun complement(): Probability

Returns a complement of this probability.

open operator override fun div(divisor: Double): Probability

open operator override fun div(divisor: Int): Probability

Returns a new instance with the value from this divided by divisor.

fun inPercent(): Double

Expresses the probability's value in percents.

fun inUnitRange(): Double

Expresses the probability's value in the unit range.

fun inWholePercent(): Long

Expresses the probability's value in percents rounded down.

inWholeUnitRange

fun inWholeUnitRange(): Long

Expresses the probability's value in the unit range rounded down.

open operator override fun minus(other: Probability): Probability

Returns a new instance that has other's value subtracted from this.

open operator override fun plus(other: Probability): Probability

Returns a new instance with a value equal to the sum of values from this and other.

open operator override fun times(factor: Double): Probability

open operator override fun times(factor: Int): Probability

Returns a new instance with the value from this multiplied by factor.

open override fun toDouble(unit: Probability.Unit): Double

Expresses the value of this under the given unit as a Double.

open override fun toLong(unit: Probability.Unit): Long

Expresses the value of this under the given unit as a Long.

open override fun toString(): String

open override fun toString(unit: Probability.Unit, decimals: Int, suffixMode: Quantity.SuffixMode, decimalsMode: Quantity.DecimalsMode): String

Returns a string representation for the value from this with the given unit. Depending on decimalsMode, it will show either exactly or at most decimals amount of decimals after the separator. The unit will be suffixed depending on suffixMode.

open operator override fun unaryMinus(): Probability

Returns a new instance with the value from this as negative.