abstract class Quantity[A <: Quantity[A]] extends Serializable with Ordered[A]
A base class for measurable quantities, instances of which contain a value and a unit
- Self Type
- A
- Source
- Quantity.scala
- Since
0.1
- Alphabetic
- By Inheritance
- Quantity
- Ordered
- Comparable
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Quantity()
Abstract Value Members
-
abstract
def
dimension: Dimension[A]
The Dimension this quantity represents
-
abstract
def
unit: UnitOfMeasure[A]
The Unit of Measure the value represents
The Unit of Measure the value represents
- returns
UnitOfMeasure[A]
-
abstract
def
value: Double
The value of the quantity given the unit
The value of the quantity given the unit
- returns
Double
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def %(that: A): Double
- def %(that: Double): A
- def *(that: Price[A]): Money
- def *(that: Double): A
- def +(that: A): A
- def +-(that: A): QuantityRange[A]
- def -(that: A): A
- def /(that: A): Double
- def /(that: Double): A
- def /%(that: A): (Double, A)
- def /%(that: Double): (A, A)
-
def
<(that: A): Boolean
- Definition Classes
- Ordered
-
def
<=(that: A): Boolean
- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
=~(that: A)(implicit tolerance: A): Boolean
approx
-
def
>(that: A): Boolean
- Definition Classes
- Ordered
-
def
>=(that: A): Boolean
- Definition Classes
- Ordered
-
def
abs: A
Returns the absolute value of this Quantity
Returns the absolute value of this Quantity
- returns
Quantity
-
def
approx(that: A)(implicit tolerance: A): Boolean
Returns boolean result of approximate equality comparison
Returns boolean result of approximate equality comparison
- that
Quantity
- tolerance
Quantity
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
ceil: A
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)
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compare(that: A): Int
Implements Ordered.compare
-
def
compareTo(that: A): Int
- Definition Classes
- Ordered → Comparable
-
def
divide(that: A): Double
Divide this quantity by a like quantity
Divide this quantity by a like quantity
- that
Quantity
- returns
Double
-
def
divide(that: Double): A
Divide this quantity by some number
Divide this quantity by some number
- that
Double
- returns
Quantity
-
def
divideAndRemainder(that: A): (Double, A)
Returns a Pair that includes the result of divideToInteger and remainder
Returns a Pair that includes the result of divideToInteger and remainder
- that
Quantity
- returns
(Double, Quantity)
-
def
divideAndRemainder(that: Double): (A, A)
Returns a Pair that includes the result of divideToInteger and remainder
Returns a Pair that includes the result of divideToInteger and remainder
- that
Double
- returns
(Quantity, Quantity)
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(that: Any): Boolean
Override of equals method
Override of equals method
- that
must be of matching value and unit
- Definition Classes
- Quantity → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
floor: A
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)
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
Override of hashCode
Override of hashCode
- Definition Classes
- Quantity → AnyRef → Any
-
def
in(uom: UnitOfMeasure[A]): A
Returns an equivalent Quantity boxed with the supplied Unit
Returns an equivalent Quantity boxed with the supplied Unit
- uom
UnitOfMeasure[A]
- returns
Quantity
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
map(f: (Double) ⇒ Double): A
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
- f
Double => Double function
-
def
max(that: A): A
Returns the max of this and that Quantity
Returns the max of this and that Quantity
- that
Quantity
- returns
Quantity
-
def
min(that: A): A
Returns the min of this and that Quantity
Returns the min of this and that Quantity
- that
Quantity
- returns
Quantity
-
def
minus(that: A): A
Subtract two like quantities
Subtract two like quantities
- that
Quantity
- returns
Quantity
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
negate: A
Returns the negative value of this Quantity
Returns the negative value of this Quantity
- returns
Quantity
-
def
notWithin(range: QuantityRange[A]): Boolean
Returns true if this value is not within (contains) the range
Returns true if this value is not within (contains) the range
- range
QuantityRange
- returns
Boolean
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
plus(that: A): A
Add two like quantities
Add two like quantities
- that
Quantity
- returns
Quantity
-
def
plusOrMinus(that: A): QuantityRange[A]
Returns a QuantityRange representing the range for this value +- that
Returns a QuantityRange representing the range for this value +- that
- that
Quantity
- returns
QuantityRange
-
def
remainder(that: A): Double
Returns the remainder of a division by a like quantity
Returns the remainder of a division by a like quantity
- that
Quantity
- returns
Double
-
def
remainder(that: Double): A
Returns the remainder of a division by a number
Returns the remainder of a division by a number
- that
Quantity
- returns
Quantity
-
def
rint: A
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)
-
def
rounded(scale: Int, mode: RoundingMode = RoundingMode.HALF_EVEN): A
Returns the Quantity with its coefficient value rounded using scale and mode.
Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.
- scale
Int - scale of the value to be returned
- mode
RoundingMode - defaults to HALF_EVEN
- returns
Quantity
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
times(that: Double): A
Multiply this quantity by some number
Multiply this quantity by some number
- that
Double
- returns
Quantity
-
def
to(uom: UnitOfMeasure[A]): Double
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)
- uom
UnitOfMeasure[A]
- returns
Double
-
def
to(that: A): QuantityRange[A]
Returns a QuantityRange that goes from this to that
Returns a QuantityRange that goes from this to that
- that
Quantity
- returns
QuantityRange
-
def
toString(uom: UnitOfMeasure[A], format: String): String
Returns a string representing the quantity's value in the given
unit
in the givenformat
Returns a string representing the quantity's value in the given
unit
in the givenformat
- uom
UnitOfMeasure[A] with UnitConverter
- format
String containing the format for the value (ie "%.3f")
- returns
String
-
def
toString(uom: UnitOfMeasure[A]): String
Returns a string representing the quantity's value in the given
unit
Returns a string representing the quantity's value in the given
unit
- uom
UnitOfMeasure[A] with UnitConverter
- returns
String
-
def
toString(): String
Returns a string representing the quantity's value in unit
Returns a string representing the quantity's value in unit
- returns
String
- Definition Classes
- Quantity → AnyRef → Any
-
def
toTuple(uom: UnitOfMeasure[A]): (Double, String)
Returns a pair representing the numeric value and the uom's symbol
Returns a pair representing the numeric value and the uom's symbol
- uom
UnitOfMeasure[A]
-
def
toTuple: (Double, String)
Returns a tuple representing the numeric value and the unit's symbol
- def unary_-: A
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
within(range: QuantityRange[A]): Boolean
Returns true if this value is within (contains) the range
Returns true if this value is within (contains) the range
- range
QuantityRange
- returns
Boolean
-
def
~=(that: A)(implicit tolerance: A): Boolean
approx
-
def
≈(that: A)(implicit tolerance: A): Boolean
approx