quantity/com.tomtom.quantity/Quantity

Quantity

abstract class Quantity<Q : Quantity<Q, U>, U : UnitBase> : Comparable<Q> , Serializable

A base interface for quantities. Outlines the common operations to retrieve values and perform mathematical operations.

Parameters

The quantity type implementing this interface.

An enum type that contains the units that the quantity's values can be in.

Types

Companion

object Companion

FormattedQuantity

data class FormattedQuantity(val value: Double, val symbol: String)

Output structure of format.

Functions

abs

fun abs(): Q

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

compareTo

operator override fun compareTo(other: Q): Int

div

operator fun div(divisor: Q): Double

operator fun div(divisor: Double): Q

operator fun div(divisor: Int): Q

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

format

fun format(unit: U): Quantity.FormattedQuantity

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

hashCode

open override fun hashCode(): Int

minus

operator fun minus(other: Q): Q

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

plus

operator fun plus(other: Q): Q

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

times

operator fun times(factor: Double): Q

operator fun times(factor: Int): Q

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

unaryMinus

operator fun unaryMinus(): Q

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

Inheritors