squants.thermal

Temperature

final class Temperature extends Quantity[Temperature]

Represents a quantity of temperature

Temperatures are somewhat unique in the world of quantities for a couple of reasons.

First, different units (scales) have different "zero" values. This means that these scales are not simple multiples of the others. There is a "zero offset" that must be applied to conversions from one scale to another.

Second, temperatures are often quoted as though they were quantities, when in fact they are just points on a scale. Similar to a mile marker on a highway, the quantity represented is the number degrees (miles) from a specific "zero" value on the scale.

In fact an absolute quantity of thermodynamic temperature should be measured from absolute zero. Thus, Kelvin, is the SI Base unit for temperature.

The other scales supported here, Celsius and Fahrenheit, are known as empirical scales. Of course, these scales set their respective zero values well above absolute zero. This is done to provide a granular and reasonably sized ranges of values for dealing with everyday temperatures.

This library supports another absolute scale, the Rankine scale. Rankine sets its zero at absolute zero, but degrees are measure in Fahrenheit (as opposed to Celsius, as the Kelvin scale uses).

In consideration of these more unique scale conversions, two conversion types are supported: Degrees and Scale.

Scale based conversions DO adjust for the zero offset. Thus 5 degrees C is the same as 41 degrees F on the thermometer.

Degrees based conversions DO NOT adjust for the zero point. Thus 5 degrees C|K is the same amount of temperature as 9 degrees F|R.

When creating a temperature it is not important to consider these differences. It is also irrelevant when performing operation on temperatures in the same scale. However, when performing operations on two temperatures of different scales these factors do become important.

The Quantity.to(unit) and Quantity.in(unit) methods are overridden to use Scale conversions for convenience

The Ordered.compare method is implemented to use Scale conversions

The Quantity.plus and Quantity.minus methods are implemented to treat right operands as Quantity of Degrees and not a scale Temperature. Operands that differ in scale will use Degree conversions. This supports mixed scale expressions:

val temp = Fahrenheit(100) - Celsius(5) // returns Fahrenheit(91)

This also supports declaring temperature ranges using typical nomenclature:

val tempRange = 65.F +- 5.C // returns QuantityRange(56.0°F,74.0°F)

The toDegrees(unit) methods are implemented to use Degree conversions.

Source
Temperature.scala
Since

0.1

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Temperature
  2. Quantity
  3. Ordered
  4. Comparable
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def %(that: Temperature): Double

    Definition Classes
    Quantity
  5. def %(that: Double): Temperature

    Definition Classes
    Quantity
  6. def *(that: ThermalCapacity): energy.Energy

  7. def *(that: Double): Temperature

    Definition Classes
    Quantity
  8. def +(that: Temperature): Temperature

    Definition Classes
    Quantity
  9. def +-(that: Temperature): QuantityRange[Temperature]

    Definition Classes
    Quantity
  10. def -(that: Temperature): Temperature

    Definition Classes
    Quantity
  11. def /(that: Temperature): Double

    Definition Classes
    Quantity
  12. def /(that: Double): Temperature

    Definition Classes
    Quantity
  13. def /%(that: Temperature): (Double, Temperature)

    Definition Classes
    Quantity
  14. def /%(that: Double): (Temperature, Temperature)

    Definition Classes
    Quantity
  15. def <(that: Temperature): Boolean

    Definition Classes
    Ordered
  16. def <=(that: Temperature): Boolean

    Definition Classes
    Ordered
  17. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  19. def =~(that: Temperature)(implicit tolerance: Temperature): Boolean

    approx

    approx

    Definition Classes
    Quantity
  20. def >(that: Temperature): Boolean

    Definition Classes
    Ordered
  21. def >=(that: Temperature): Boolean

    Definition Classes
    Ordered
  22. def abs: Temperature

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  23. def approx(that: Temperature)(implicit tolerance: Temperature): Boolean

    Returns boolean result of approximate equality comparison

    Returns boolean result of approximate equality comparison

    that

    Quantity

    tolerance

    Quantity

    returns

    Definition Classes
    Quantity
  24. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  25. def ceil: Temperature

    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

    Definition Classes
    Quantity
    See also

    java.lang.Math#ceil(double)

  26. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def compare(that: Temperature): Int

    Implements Ordered.

    Implements Ordered.compare

    that

    Quantity

    returns

    Int

    Definition Classes
    Quantity → Ordered
  28. def compareTo(that: Temperature): Int

    Definition Classes
    Ordered → Comparable
  29. def dimension: Temperature.type

    The Dimension this quantity represents

    The Dimension this quantity represents

    returns

    Definition Classes
    TemperatureQuantity
  30. def divide(that: Temperature): Double

    Divide this quantity by a like quantity

    Divide this quantity by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  31. def divide(that: Double): Temperature

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  32. def divideAndRemainder(that: Temperature): (Double, Temperature)

    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)

    Definition Classes
    Quantity
  33. def divideAndRemainder(that: Double): (Temperature, Temperature)

    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)

    Definition Classes
    Quantity
  34. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def equals(that: Any): Boolean

    Override of equals method

    Override of equals method

    that

    must be of matching value and unit

    returns

    Definition Classes
    Quantity → AnyRef → Any
  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def floor: Temperature

    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

    Definition Classes
    Quantity
    See also

    java.lang.Math#floor(double)

  38. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  39. def hashCode(): Int

    Override of hashCode

    Override of hashCode

    returns

    Definition Classes
    Quantity → AnyRef → Any
  40. def in(unit: TemperatureScale): Temperature

  41. def in(uom: UnitOfMeasure[Temperature]): Temperature

    Returns an equivalent Quantity boxed with the supplied Unit

    Returns an equivalent Quantity boxed with the supplied Unit

    uom

    UnitOfMeasure[A]

    returns

    Quantity

    Definition Classes
    Quantity
  42. def inCelsius: Temperature

  43. def inFahrenheit: Temperature

  44. def inKelvin: Temperature

  45. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  46. def map(f: (Double) ⇒ Double): Temperature

    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

    returns

    Definition Classes
    Quantity
  47. def max(that: Temperature): Temperature

    Returns the max of this and that Quantity

    Returns the max of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  48. def min(that: Temperature): Temperature

    Returns the min of this and that Quantity

    Returns the min of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  49. def minus(that: Temperature): Temperature

    Subtract two like quantities

    Subtract two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    TemperatureQuantity
  50. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  51. def negate: Temperature

    Returns the negative value of this Quantity

    Returns the negative value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  52. def notWithin(range: QuantityRange[Temperature]): 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

    Definition Classes
    Quantity
  53. final def notify(): Unit

    Definition Classes
    AnyRef
  54. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  55. def plus(that: Temperature): Temperature

    Add two like quantities

    Add two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    TemperatureQuantity
  56. def plusOrMinus(that: Temperature): QuantityRange[Temperature]

    Returns a QuantityRange representing the range for this value +- that

    Returns a QuantityRange representing the range for this value +- that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  57. def remainder(that: Temperature): 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

    Definition Classes
    Quantity
  58. def remainder(that: Double): Temperature

    Returns the remainder of a division by a number

    Returns the remainder of a division by a number

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  59. def rint: Temperature

    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

    Definition Classes
    Quantity
    See also

    java.lang.Math#rint(double)

  60. def rounded(scale: Int, mode: RoundingMode = RoundingMode.HALF_EVEN): Temperature

    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

    Definition Classes
    Quantity
  61. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  62. def times(that: Double): Temperature

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  63. def to(unit: TemperatureScale): Double

  64. def to(uom: UnitOfMeasure[Temperature]): 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

    Definition Classes
    Quantity
  65. def to(that: Temperature): QuantityRange[Temperature]

    Returns a QuantityRange that goes from this to that

    Returns a QuantityRange that goes from this to that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  66. def toCelsiusDegrees: Double

  67. def toCelsiusScale: Double

  68. def toDegrees(unit: TemperatureScale): Double

  69. def toFahrenheitDegrees: Double

  70. def toFahrenheitScale: Double

  71. def toKelvinDegrees: Double

  72. def toKelvinScale: Double

  73. def toScale(unit: TemperatureScale): Double

  74. def toString(unit: TemperatureScale): String

  75. 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
    TemperatureQuantity → AnyRef → Any
  76. def toString(uom: UnitOfMeasure[Temperature], format: String): 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

    uom

    UnitOfMeasure[A] with UnitConverter

    format

    String containing the format for the value (ie "%.3f")

    returns

    String

    Definition Classes
    Quantity
  77. def toString(uom: UnitOfMeasure[Temperature]): 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

    Definition Classes
    Quantity
  78. def toTuple(uom: UnitOfMeasure[Temperature]): (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]

    returns

    Definition Classes
    Quantity
  79. def toTuple: (Double, 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

    Definition Classes
    Quantity
  80. def unary_-(): Temperature

    Definition Classes
    Quantity
  81. val unit: TemperatureScale

    The Unit of Measure the value represents

    The Unit of Measure the value represents

    returns

    UnitOfMeasure[A]

    Definition Classes
    TemperatureQuantity
  82. val value: Double

    the value of the temperature

    the value of the temperature

    Definition Classes
    TemperatureQuantity
  83. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. def within(range: QuantityRange[Temperature]): 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

    Definition Classes
    Quantity
  87. def ~=(that: Temperature)(implicit tolerance: Temperature): Boolean

    approx

    approx

    Definition Classes
    Quantity
  88. def (that: Temperature)(implicit tolerance: Temperature): Boolean

    approx

    approx

    Definition Classes
    Quantity

Inherited from Quantity[Temperature]

Inherited from Ordered[Temperature]

Inherited from Comparable[Temperature]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped