Packages

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

Represents a quantity of frequency, which is the number cycles (count) over time

Source
Frequency.scala
Since

0.1

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Frequency
  2. TimeDerivative
  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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def %(that: Frequency): Double
    Definition Classes
    Quantity
  4. def %(that: Double): Frequency
    Definition Classes
    Quantity
  5. def *(that: Time): Dimensionless

    Returns the amount of change in the integral that will happen over the given Time

    Returns the amount of change in the integral that will happen over the given Time

    that

    Time

    Definition Classes
    TimeDerivative
  6. def *(that: Double): Frequency
    Definition Classes
    Quantity
  7. def +(that: Frequency): Frequency
    Definition Classes
    Quantity
  8. def +-(that: Frequency): QuantityRange[Frequency]
    Definition Classes
    Quantity
  9. def -(that: Frequency): Frequency
    Definition Classes
    Quantity
  10. def /(that: Frequency): Double
    Definition Classes
    Quantity
  11. def /(that: Double): Frequency
    Definition Classes
    Quantity
  12. def /%(that: Frequency): (Double, Frequency)
    Definition Classes
    Quantity
  13. def /%(that: Double): (Frequency, Frequency)
    Definition Classes
    Quantity
  14. def <(that: Frequency): Boolean
    Definition Classes
    Ordered
  15. def <=(that: Frequency): Boolean
    Definition Classes
    Ordered
  16. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def =~(that: Frequency)(implicit tolerance: Frequency): Boolean

    approx

    approx

    Definition Classes
    Quantity
  18. def >(that: Frequency): Boolean
    Definition Classes
    Ordered
  19. def >=(that: Frequency): Boolean
    Definition Classes
    Ordered
  20. def abs: Frequency

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  21. def approx(that: Frequency)(implicit tolerance: Frequency): Boolean

    Returns boolean result of approximate equality comparison

    Returns boolean result of approximate equality comparison

    that

    Quantity

    tolerance

    Quantity

    Definition Classes
    Quantity
  22. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  23. def ceil: Frequency

    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)

  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def compare(that: Frequency): Int

    Implements Ordered.compare

    Implements Ordered.compare

    that

    Quantity

    returns

    Int

    Definition Classes
    Quantity → Ordered
  26. def compareTo(that: Frequency): Int
    Definition Classes
    Ordered → Comparable
  27. def dimension: Frequency.type

    The Dimension this quantity represents

    The Dimension this quantity represents

    Definition Classes
    FrequencyQuantity
  28. def divide(that: Frequency): Double

    Divide this quantity by a like quantity

    Divide this quantity by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  29. def divide(that: Double): Frequency

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  30. def divideAndRemainder(that: Frequency): (Double, Frequency)

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

    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
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. 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
  34. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def floor: Frequency

    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)

  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  37. def hashCode(): Int

    Override of hashCode

    Override of hashCode

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

    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
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. def map(f: (Double) ⇒ Double): Frequency

    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
  41. def max(that: Frequency): Frequency

    Returns the max of this and that Quantity

    Returns the max of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  42. def min(that: Frequency): Frequency

    Returns the min of this and that Quantity

    Returns the min of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  43. def minus(that: Frequency): Frequency

    Subtract two like quantities

    Subtract two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def negate: Frequency

    Returns the negative value of this Quantity

    Returns the negative value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  46. def notWithin(range: QuantityRange[Frequency]): 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
  47. final def notify(): Unit
    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  49. def plus(that: Frequency): Frequency

    Add two like quantities

    Add two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  50. def plusOrMinus(that: Frequency): QuantityRange[Frequency]

    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
  51. def remainder(that: Frequency): 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
  52. def remainder(that: Double): Frequency

    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
  53. def rint: Frequency

    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)

  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def time: Time
    Attributes
    protected[squants]
    Definition Classes
    FrequencyTimeDerivative
  56. def timeIntegrated: Dimensionless
    Attributes
    protected[squants]
    Definition Classes
    FrequencyTimeDerivative
  57. def times(that: Double): Frequency

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  58. def to(uom: UnitOfMeasure[Frequency]): 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
  59. def to(that: Frequency): QuantityRange[Frequency]

    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
  60. def toGigahertz: Double
  61. def toHertz: Double
  62. def toKilohertz: Double
  63. def toMegahertz: Double
  64. def toRevolutionsPerMinute: Double
  65. def toString(uom: UnitOfMeasure[Frequency], 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
  66. def toString(uom: UnitOfMeasure[Frequency]): 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
  67. 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
  68. def toTerahertz: Double
  69. def toTuple(uom: UnitOfMeasure[Frequency]): (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]

    Definition Classes
    Quantity
  70. 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

    Definition Classes
    Quantity
  71. def unary_-(): Frequency
    Definition Classes
    Quantity
  72. val unit: FrequencyUnit
    Definition Classes
    FrequencyQuantity
  73. val value: Double
    Definition Classes
    FrequencyQuantity
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. def within(range: QuantityRange[Frequency]): 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
  78. def ~=(that: Frequency)(implicit tolerance: Frequency): Boolean

    approx

    approx

    Definition Classes
    Quantity
  79. def (that: Frequency)(implicit tolerance: Frequency): Boolean

    approx

    approx

    Definition Classes
    Quantity

Inherited from TimeDerivative[Dimensionless]

Inherited from Quantity[Frequency]

Inherited from Ordered[Frequency]

Inherited from Comparable[Frequency]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped