com.tomtom.quantity:quantity/com.tomtom.quantity/Ratio

Ratio

@JvmInline
value class Ratio : Quantity<Ratio, Ratio.Unit>

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

Types

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

Ratio units.

Functions

Link copied to clipboard
open fun abs(): Ratio

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

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

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

Link copied to clipboard
open operator override fun div(divisor: Ratio): Double

open operator override fun div(divisor: Double): Ratio
open operator override fun div(divisor: Int): Ratio

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

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

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

Link copied to clipboard
fun inPercent(): Double

Expresses the ratio's value in percent.

Link copied to clipboard
fun inUnitRange(): Double

Expresses the ratio's value as a unit range.

Link copied to clipboard
fun inWholePercent(): Long

Expresses the ratio's value in percent.

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

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

Link copied to clipboard
open operator override fun plus(other: Ratio): Ratio

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

Link copied to clipboard
open override fun selfFactory(rawValue: Long): Ratio
Link copied to clipboard
operator fun times(factor: Ratio): Ratio

open operator override fun times(factor: Double): Ratio
open operator override fun times(factor: Int): Ratio

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

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

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

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

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

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open operator override fun unaryMinus(): Ratio

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

Properties

Link copied to clipboard
open override val rawValue: Long