Class/Object

squants

Dimensionless

Related Docs: object Dimensionless | package squants

Permalink

final class Dimensionless extends Quantity[Dimensionless] with TimeIntegral[Frequency]

Represents a quantity of some thing for which there is no dimension.

This may be used to represent counts or other discrete amounts of everyday life, but may also represent ratios between like quantities where the units have cancelled out.

Source
Dimensionless.scala
Since

0.1

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dimensionless
  2. TimeIntegral
  3. Quantity
  4. Ordered
  5. Comparable
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def %(that: Dimensionless): Double

    Permalink
    Definition Classes
    Quantity
  4. def %(that: Double): Dimensionless

    Permalink
    Definition Classes
    Quantity
  5. def *(that: Quantity[_]): Any

    Permalink
  6. def *(that: Dimensionless): Dimensionless

    Permalink
  7. def *(that: Frequency): Frequency

    Permalink

    Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

    Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

    that

    Frequency - the rate at which this Quantity occurs

    Definition Classes
    TimeIntegral
  8. def *(that: Price[Dimensionless]): Money

    Permalink
    Definition Classes
    Quantity
  9. def *(that: Double): Dimensionless

    Permalink
    Definition Classes
    Quantity
  10. def +(that: Double): Dimensionless

    Permalink
  11. def +(that: Dimensionless): Dimensionless

    Permalink
    Definition Classes
    Quantity
  12. def +-(that: Dimensionless): QuantityRange[Dimensionless]

    Permalink
    Definition Classes
    Quantity
  13. def -(that: Dimensionless): Dimensionless

    Permalink
    Definition Classes
    Quantity
  14. def /(that: Frequency): time.Time

    Permalink

    Returns the amount time required to achieve the given change in the Derivative

    Returns the amount time required to achieve the given change in the Derivative

    that

    Derivative

    Definition Classes
    TimeIntegral
  15. def /(that: time.Time): Frequency

    Permalink

    Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

    Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

    that

    Time

    Definition Classes
    TimeIntegral
  16. def /(that: Dimensionless): Double

    Permalink
    Definition Classes
    Quantity
  17. def /(that: Double): Dimensionless

    Permalink
    Definition Classes
    Quantity
  18. def /%(that: Dimensionless): (Double, Dimensionless)

    Permalink
    Definition Classes
    Quantity
  19. def /%(that: Double): (Dimensionless, Dimensionless)

    Permalink
    Definition Classes
    Quantity
  20. def <(that: Dimensionless): Boolean

    Permalink
    Definition Classes
    Ordered
  21. def <=(that: Dimensionless): Boolean

    Permalink
    Definition Classes
    Ordered
  22. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def =~(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity
  24. def >(that: Dimensionless): Boolean

    Permalink
    Definition Classes
    Ordered
  25. def >=(that: Dimensionless): Boolean

    Permalink
    Definition Classes
    Ordered
  26. def abs: Dimensionless

    Permalink

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  27. def approx(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean

    Permalink

    Returns boolean result of approximate equality comparison

    Returns boolean result of approximate equality comparison

    that

    Quantity

    tolerance

    Quantity

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

    Permalink
    Definition Classes
    Any
  29. def ceil: Dimensionless

    Permalink

    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)

  30. def clone(): AnyRef

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

    Permalink

    Implements Ordered.compare

    Implements Ordered.compare

    that

    Quantity

    returns

    Int

    Definition Classes
    Quantity → Ordered
  32. def compareTo(that: Dimensionless): Int

    Permalink
    Definition Classes
    Ordered → Comparable
  33. def dimension: Dimensionless.type

    Permalink

    The Dimension this quantity represents

    The Dimension this quantity represents

    Definition Classes
    DimensionlessQuantity
  34. def divide(that: Dimensionless): Double

    Permalink

    Divide this quantity by a like quantity

    Divide this quantity by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  35. def divide(that: Double): Dimensionless

    Permalink

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  36. def divideAndRemainder(that: Dimensionless): (Double, Dimensionless)

    Permalink

    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
  37. def divideAndRemainder(that: Double): (Dimensionless, Dimensionless)

    Permalink

    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
  38. final def eq(arg0: AnyRef): Boolean

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

    Permalink

    Override of equals method

    Override of equals method

    that

    must be of matching value and unit

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

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

    Permalink

    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)

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

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

    Permalink

    Override of hashCode

    Override of hashCode

    Definition Classes
    Quantity → AnyRef → Any
  44. def in(uom: UnitOfMeasure[Dimensionless]): Dimensionless

    Permalink

    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
  45. final def isInstanceOf[T0]: Boolean

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

    Permalink

    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

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

    Permalink

    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: Dimensionless): Dimensionless

    Permalink

    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: Dimensionless): Dimensionless

    Permalink

    Subtract two like quantities

    Subtract two like quantities

    that

    Quantity

    returns

    Quantity

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

    Permalink
    Definition Classes
    AnyRef
  51. def negate: Dimensionless

    Permalink

    Returns the negative value of this Quantity

    Returns the negative value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  52. def notWithin(range: QuantityRange[Dimensionless]): Boolean

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef
  55. def per(that: time.Time): Frequency

    Permalink
    Definition Classes
    TimeIntegral
  56. def plus(that: Dimensionless): Dimensionless

    Permalink

    Add two like quantities

    Add two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  57. def plusOrMinus(that: Dimensionless): QuantityRange[Dimensionless]

    Permalink

    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
  58. def remainder(that: Dimensionless): Double

    Permalink

    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
  59. def remainder(that: Double): Dimensionless

    Permalink

    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
  60. def rint: Dimensionless

    Permalink

    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)

  61. def rounded(scale: Int, mode: RoundingMode = RoundingMode.HALF_EVEN): Dimensionless

    Permalink

    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
  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  63. def time: time.Time

    Permalink
    Attributes
    protected[squants]
    Definition Classes
    DimensionlessTimeIntegral
  64. def timeDerived: Frequency

    Permalink
    Attributes
    protected
    Definition Classes
    DimensionlessTimeIntegral
  65. def times(that: Double): Dimensionless

    Permalink

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  66. def to(uom: UnitOfMeasure[Dimensionless]): Double

    Permalink

    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
  67. def to(that: Dimensionless): QuantityRange[Dimensionless]

    Permalink

    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
  68. def toDozen: Double

    Permalink
  69. def toEach: Double

    Permalink
  70. def toGross: Double

    Permalink
  71. def toPercent: Double

    Permalink
  72. def toScore: Double

    Permalink
  73. def toString(uom: UnitOfMeasure[Dimensionless], format: String): String

    Permalink

    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
  74. def toString(uom: UnitOfMeasure[Dimensionless]): String

    Permalink

    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
  75. def toString(): String

    Permalink

    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
  76. def toTuple(uom: UnitOfMeasure[Dimensionless]): (Double, String)

    Permalink

    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]

    Definition Classes
    Quantity
  77. def toTuple: (Double, String)

    Permalink

    Returns a tuple representing the numeric value and the unit's symbol

    Returns a tuple representing the numeric value and the unit's symbol

    Definition Classes
    Quantity
  78. def unary_-: Dimensionless

    Permalink
    Definition Classes
    Quantity
  79. val unit: DimensionlessUnit

    Permalink

    The Unit of Measure the value represents

    The Unit of Measure the value represents

    returns

    UnitOfMeasure[A]

    Definition Classes
    DimensionlessQuantity
  80. val value: Double

    Permalink

    Double the amount

    Double the amount

    Definition Classes
    DimensionlessQuantity
  81. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def within(range: QuantityRange[Dimensionless]): Boolean

    Permalink

    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
  85. def ~=(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity
  86. def (that: Dimensionless)(implicit tolerance: Dimensionless): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity

Inherited from TimeIntegral[Frequency]

Inherited from Quantity[Dimensionless]

Inherited from Ordered[Dimensionless]

Inherited from Comparable[Dimensionless]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped