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
- Alphabetic
- By Inheritance
- Dimensionless
- TimeIntegral
- Quantity
- Ordered
- Comparable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def %(that: Dimensionless): Double
- Definition Classes
- Quantity
- def %(that: Double): Dimensionless
- Definition Classes
- Quantity
- def *(that: Quantity[_]): Any
- def *(that: Dimensionless): Dimensionless
- def *(that: Frequency): Frequency
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
- def *(that: Price[Dimensionless]): Money
- Definition Classes
- Quantity
- def *(that: Double): Dimensionless
- Definition Classes
- Quantity
- def +(that: Double): Dimensionless
- def +(that: Dimensionless): Dimensionless
- Definition Classes
- Quantity
- def +-(that: Dimensionless): QuantityRange[Dimensionless]
- Definition Classes
- Quantity
- def -(that: Dimensionless): Dimensionless
- Definition Classes
- Quantity
- def /(that: Frequency): time.Time
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
- def /(that: time.Time): Frequency
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
- def /(that: Dimensionless): Double
- Definition Classes
- Quantity
- def /(that: Double): Dimensionless
- Definition Classes
- Quantity
- def /%(that: Dimensionless): (Double, Dimensionless)
- Definition Classes
- Quantity
- def /%(that: Double): (Dimensionless, Dimensionless)
- Definition Classes
- Quantity
- def <(that: Dimensionless): Boolean
- Definition Classes
- Ordered
- def <=(that: Dimensionless): Boolean
- Definition Classes
- Ordered
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def =~(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean
approx
approx
- Definition Classes
- Quantity
- def >(that: Dimensionless): Boolean
- Definition Classes
- Ordered
- def >=(that: Dimensionless): Boolean
- Definition Classes
- Ordered
- def abs: Dimensionless
Returns the absolute value of this Quantity
- def approx(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean
Returns boolean result of approximate equality comparison
Returns boolean result of approximate equality comparison
- that
Quantity
- tolerance
Quantity
- Definition Classes
- Quantity
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def ceil: Dimensionless
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)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compare(that: Dimensionless): Int
Implements Ordered.compare
- def compareTo(that: Dimensionless): Int
- Definition Classes
- Ordered → Comparable
- def dimension: Dimensionless
The Dimension this quantity represents
The Dimension this quantity represents
- Definition Classes
- Dimensionless → Quantity
- def divide(that: Dimensionless): Double
Divide this quantity by a like quantity
- def divide(that: Double): Dimensionless
Divide this quantity by some number
- def divideAndRemainder(that: Dimensionless): (Double, Dimensionless)
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
- def divideAndRemainder(that: Double): (Dimensionless, Dimensionless)
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
- 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: Dimensionless
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)
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
Override of hashCode
Override of hashCode
- Definition Classes
- Quantity → AnyRef → Any
- def in(uom: UnitOfMeasure[Dimensionless]): Dimensionless
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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def map(f: (Double) => Double): Dimensionless
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
- def max(that: Dimensionless): Dimensionless
Returns the max of this and that Quantity
- def min(that: Dimensionless): Dimensionless
Returns the min of this and that Quantity
- def minus(that: Dimensionless): Dimensionless
Subtract two like quantities
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def negate: Dimensionless
Returns the negative value of this Quantity
- def notWithin(range: QuantityRange[Dimensionless]): 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def per(that: time.Time): Frequency
- Definition Classes
- TimeIntegral
- def plus(that: Dimensionless): Dimensionless
Add two like quantities
- def plusOrMinus(that: Dimensionless): QuantityRange[Dimensionless]
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
- def remainder(that: Dimensionless): 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
- def remainder(that: Double): Dimensionless
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
- def rint: Dimensionless
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)
- def rounded(scale: Int, mode: RoundingMode = RoundingMode.HALF_EVEN): Dimensionless
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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def time: time.Time
- Attributes
- protected[squants]
- Definition Classes
- Dimensionless → TimeIntegral
- def timeDerived: Frequency
- Attributes
- protected
- Definition Classes
- Dimensionless → TimeIntegral
- def times(that: Double): Dimensionless
Multiply this quantity by some number
- def to(uom: UnitOfMeasure[Dimensionless]): 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
- def to(that: Dimensionless): QuantityRange[Dimensionless]
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
- def toDozen: Double
- def toEach: Double
- def toGross: Double
- def toPercent: Double
- def toScore: Double
- def toString(uom: UnitOfMeasure[Dimensionless], format: String): String
Returns a string representing the quantity's value in the given
unitin the givenformatReturns a string representing the quantity's value in the given
unitin the givenformat- uom
UnitOfMeasure[A] with UnitConverter
- format
String containing the format for the value (ie "%.3f")
- returns
String
- Definition Classes
- Quantity
- def toString(uom: UnitOfMeasure[Dimensionless]): String
Returns a string representing the quantity's value in the given
unitReturns a string representing the quantity's value in the given
unit- uom
UnitOfMeasure[A] with UnitConverter
- returns
String
- Definition Classes
- Quantity
- 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[Dimensionless]): (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
- 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
- def unary_-(): Dimensionless
- Definition Classes
- Quantity
- val unit: DimensionlessUnit
The Unit of Measure the value represents
The Unit of Measure the value represents
- returns
UnitOfMeasure[A]
- Definition Classes
- Dimensionless → Quantity
- val value: Double
The value of the quantity given the unit
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def within(range: QuantityRange[Dimensionless]): 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
- def ~=(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean
approx
approx
- Definition Classes
- Quantity
- def ≈(that: Dimensionless)(implicit tolerance: Dimensionless): Boolean
approx
approx
- Definition Classes
- Quantity