quantity/com.tomtom.quantity/Probability

Probability

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

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class Unit(val name: String, val factor: Long) : UnitBase

The unit of a probability's value.

Functions

Link copied to clipboard
open override fun abs(): Probability

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

Link copied to clipboard
open operator override fun compareTo(other: Probability): Int
Link copied to clipboard
fun complement(): Probability

Returns a complement of this probability.

Link copied to clipboard
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.

Link copied to clipboard
open override fun format(unit: Probability.Unit): Quantity.FormattedQuantity

Returns a FormattedQuantity representation of the value from this with the given unit.

Link copied to clipboard
fun inPercent(): Double

Expresses the probability's value in percents.

Link copied to clipboard
fun inUnitRange(): Double

Expresses the probability's value in the unit range.

Link copied to clipboard
fun inWholePercent(): Long

Expresses the probability's value in percents rounded down.

Link copied to clipboard
fun inWholeUnitRange(): Long

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

Link copied to clipboard
open operator override fun minus(other: Probability): Probability

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun toDouble(unit: Probability.Unit): Double

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

Link copied to clipboard
open override fun toLong(unit: Probability.Unit): Long

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

Link copied to clipboard
open operator override fun unaryMinus(): Probability

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