quantity/com.tomtom.quantity/Ratio

Ratio

class Ratio : Quantity<Ratio, Ratio.Unit>

A quantity describing a ratio, also commonly used for probabilities. (For example, 10%.)

Types

Companion

object Companion

Unit

abstract class Unit(name: String, factor: Long) : UnitBase

Ratio units.

Functions

abs

fun abs(): Ratio

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

compareTo

operator override fun compareTo(other: Ratio): Int

complement

fun complement(): Ratio

Returns a complement of this ratio. Useful if the ratio represents a probability.

div

operator fun div(divisor: Ratio): Double

operator fun div(divisor: Double): Ratio

operator fun div(divisor: Int): Ratio

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

equals

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

format

fun format(unit: Ratio.Unit): Quantity.FormattedQuantity

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

hashCode

open override fun hashCode(): Int

inPercent

fun inPercent(): Double

Expresses the ratio's value in percent.

inUnitRange

fun inUnitRange(): Double

Expresses the ratio's value as a unit range.

inWholePercent

fun inWholePercent(): Long

Expresses the ratio's value in percent.

minus

operator fun minus(other: Ratio): Ratio

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

plus

operator fun plus(other: Ratio): Ratio

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

times

operator fun times(factor: Double): Ratio

operator fun times(factor: Int): Ratio

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

operator fun times(factor: Ratio): Ratio

toString

open override fun toString(): String

unaryMinus

operator fun unaryMinus(): Ratio

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