# Ratio

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

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

## Types

object Companion
abstract class Unit : UnitBase

Ratio units.

## Properties

open override val rawValue: Long

Raw unformatted value.

## Functions

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

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.

Expresses the ratio's value in percent.

Expresses the ratio's value as a unit range.

Expresses the ratio's value in percent.

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

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

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.

open override fun selfFactory(rawValue: Long): Ratio

Creates a new instance with the provided rawValue.

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.

open override fun toString(): String

Returns a formatted value.

open operator override fun unaryMinus(): Ratio

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

## Inherited functions

open fun abs(): Ratio

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

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

Compares this object with the other object.

Returns a FormattedQuantity representation of the value from `this` in the given unit.
Expresses the value of `this` under the given unit as a Double.
Expresses the value of `this` under the given unit as a Long.