Quantity
A base class for measurable quantities, instances of which contain a value and a unit
A base class for measurable quantities, instances of which contain a value and a unit
- Authors
garyKeorkunian
- Since
0.1
Value members
Abstract methods
The Unit of Measure the value represents
The Unit of Measure the value represents
- Returns
UnitOfMeasure[A]
Concrete methods
Returns the absolute value of this Quantity
Returns the absolute value of this Quantity
- Returns
Quantity
Returns boolean result of approximate equality comparison
Returns boolean result of approximate equality comparison
- Value Params
- that
Quantity
- tolerance
Quantity
Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.
Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.
- Returns
Quantity
- See also
java.lang.Math#ceil(double)
Divide this quantity by some number
Divide this quantity by some number
- Value Params
- that
Double
- Returns
Quantity
Divide this quantity by a like quantity
Divide this quantity by a like quantity
- Value Params
- that
Quantity
- Returns
Double
Returns a Pair that includes the result of divideToInteger and remainder
Returns a Pair that includes the result of divideToInteger and remainder
- Value Params
- that
Double
- Returns
(Quantity, Quantity)
Returns a Pair that includes the result of divideToInteger and remainder
Returns a Pair that includes the result of divideToInteger and remainder
- Value Params
- that
Quantity
- Returns
(Double, Quantity)
Override of equals method
Override of equals method
- Value Params
- that
must be of matching value and unit
- Definition Classes
- Any
Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer
Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer
- Returns
Quantity
- See also
java.lang.Math#floor(double)
Returns an equivalent Quantity boxed with the supplied Unit
Returns an equivalent Quantity boxed with the supplied Unit
- Value Params
- uom
UnitOfMeasure[A]
- Returns
Quantity
Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit
Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit
- Value Params
- f
Double => Double function
Returns the max of this and that Quantity
Returns the max of this and that Quantity
- Value Params
- that
Quantity
- Returns
Quantity
Returns the min of this and that Quantity
Returns the min of this and that Quantity
- Value Params
- that
Quantity
- Returns
Quantity
Returns the negative value of this Quantity
Returns the negative value of this Quantity
- Returns
Quantity
Returns true if this value is not within (contains) the range
Returns true if this value is not within (contains) the range
- Value Params
- range
QuantityRange
- Returns
Boolean
Returns a QuantityRange representing the range for this value +- that
Returns a QuantityRange representing the range for this value +- that
- Value Params
- that
Quantity
- Returns
QuantityRange
Returns the remainder of a division by a number
Returns the remainder of a division by a number
- Value Params
- that
Quantity
- Returns
Quantity
Returns the remainder of a division by a like quantity
Returns the remainder of a division by a like quantity
- Value Params
- that
Quantity
- Returns
Double
Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.
Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.
- Returns
Quantity
- See also
java.lang.Math#rint(double)
Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.
Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.
- Value Params
- mode
RoundingMode - defaults to HALF_EVEN
- scale
Int - scale of the value to be returned
- Returns
Quantity
Multiply this quantity by some number
Multiply this quantity by some number
- Value Params
- that
Double
- Returns
Quantity
Returns a QuantityRange that goes from this to that
Returns a QuantityRange that goes from this to that
- Value Params
- that
Quantity
- Returns
QuantityRange
Returns a Double representing the quantity in terms of the supplied unit
Returns a Double representing the quantity in terms of the supplied unit
val d = Feet(3)
(d to Inches) should be(36)
- Value Params
- uom
UnitOfMeasure[A]
- Returns
Double
Returns a string representing the quantity's value in unit
Returns a string representing the quantity's value in unit
- Returns
String
- Definition Classes
- Any
Returns a string representing the quantity's value in the given unit
Returns a string representing the quantity's value in the given unit
- Value Params
- uom
UnitOfMeasure[A] with UnitConverter
- Returns
String
Returns a string representing the quantity's value in the given unit
in the given format
Returns a string representing the quantity's value in the given unit
in the given format
- Value Params
- format
String containing the format for the value (ie "%.3f")
- uom
UnitOfMeasure[A] with UnitConverter
- Returns
String
Returns a tuple representing the numeric value and the unit's symbol
Returns a tuple representing the numeric value and the unit's symbol
Returns a pair representing the numeric value and the uom's symbol
Returns a pair representing the numeric value and the uom's symbol
- Value Params
- uom
UnitOfMeasure[A]