squants.time

Frequency

case class Frequency(cycles: Dimensionless, time: Time) extends Quantity[Frequency] with TimeDerivative[Dimensionless] with Product with Serializable

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

cycles

Count the number of cycles per time

time

Time

Since

0.1

Linear Supertypes
Product, Equals, TimeDerivative[Dimensionless], Quantity[Frequency], Serializable, Serializable, Ordered[Frequency], Comparable[Frequency], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Frequency
  2. Product
  3. Equals
  4. TimeDerivative
  5. Quantity
  6. Serializable
  7. Serializable
  8. Ordered
  9. Comparable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Frequency(cycles: Dimensionless, time: Time)

    cycles

    Count the number of cycles per time

    time

    Time

Value Members

  1. def !=(that: Frequency): Boolean

    Return boolean result of inequality between this and that

    Return boolean result of inequality between this and that

    that

    Quantity

    returns

    Boolean

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

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

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

    Definition Classes
    AnyRef → Any
  5. def %(that: Frequency): Double

    Definition Classes
    Quantity
  6. def %(that: Double): Frequency

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

    returns

    Definition Classes
    TimeDerivative
  8. def *(that: Double): Frequency

    Definition Classes
    Quantity
  9. def +(that: Frequency): Frequency

    Definition Classes
    Quantity
  10. def +-(that: Frequency): QuantityRange[Frequency]

    Definition Classes
    Quantity
  11. def -(that: Frequency): Frequency

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

    Definition Classes
    Quantity
  13. def /(that: Double): Frequency

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

    Definition Classes
    Quantity
  15. def /%(that: Double): (Frequency, Frequency)

    Definition Classes
    Quantity
  16. def <(that: Frequency): Boolean

    Definition Classes
    Ordered
  17. def <=(that: Frequency): Boolean

    Definition Classes
    Ordered
  18. def ==(that: Frequency): Boolean

    Returns boolean result of equality between this and that

    Returns boolean result of equality between this and that

    that

    Quantity

    returns

    Boolean

    Definition Classes
    Quantity
  19. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  21. def >(that: Frequency): Boolean

    Definition Classes
    Ordered
  22. def >=(that: Frequency): Boolean

    Definition Classes
    Ordered
  23. def abs: Frequency

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

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

    Definition Classes
    Any
  25. def change: Dimensionless

    Definition Classes
    FrequencyTimeDerivative
  26. def clone(): AnyRef

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

    Implements Ordered.

    Implements Ordered.compare

    that

    Quantity

    returns

    Int

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

    Definition Classes
    Ordered → Comparable
  29. val cycles: Dimensionless

    Count the number of cycles per time

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

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  32. 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
  33. 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
  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. final def getClass(): Class[_]

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

    Override of hashCode

    Override of hashCode

    returns

    Definition Classes
    Quantity → AnyRef → Any
  39. def in(unit: UnitOfMeasure[Frequency] with UnitConverter): Frequency

    Returns an equivalent Quantity boxed with the supplied Unit

    Returns an equivalent Quantity boxed with the supplied Unit

    This is really only useful for Quantity classes that box at the UOM level e.g. Temperature and currently Time

    unit

    UnitOfMeasure[A] with UnitConverter

    returns

    Quantity

    Definition Classes
    Quantity
  40. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  41. def max(that: Frequency): Quantity[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): Quantity[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. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. val time: Time

    Time

    Time

    Definition Classes
    FrequencyTimeDerivative
  55. def times(that: Double): Frequency

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  56. def to(unit: UnitOfMeasure[Frequency] with UnitConverter): 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)
    unit

    UnitOfMeasure[A] with UnitConverter

    returns

    Double

    Definition Classes
    Quantity
  57. 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
  58. def toGigahertz: Double

  59. def toHertz: Double

  60. def toKilohertz: Double

  61. def toMegahertz: Double

  62. def toRevolutionsPerMinute: Double

  63. def toString(unit: UnitOfMeasure[Frequency] with UnitConverter): 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

    unit

    UnitOfMeasure[A] with UnitConverter

    returns

    String

    Definition Classes
    Quantity
  64. def toString(): String

    Returns a string representing the quantity's value in valueUnits

    Returns a string representing the quantity's value in valueUnits

    returns

    String

    Definition Classes
    Quantity → AnyRef → Any
  65. def toTerahertz: Double

  66. def unary_-(): Frequency

    Definition Classes
    Quantity
  67. def value: Double

    The value of the quantity given the valueUnits

    The value of the quantity given the valueUnits

    returns

    Double

    Definition Classes
    FrequencyQuantity
  68. def valueUnit: Hertz.type

    The Unit of Measure used for the quantity's underlying value

    The Unit of Measure used for the quantity's underlying value

    returns

    UnitOfMeasure[A]

    Definition Classes
    FrequencyQuantity
  69. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. 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

Inherited from Product

Inherited from Equals

Inherited from TimeDerivative[Dimensionless]

Inherited from Quantity[Frequency]

Inherited from Serializable

Inherited from Serializable

Inherited from Ordered[Frequency]

Inherited from Comparable[Frequency]

Inherited from AnyRef

Inherited from Any

Ungrouped