final case class Spread[T](pivot: T, tolerance: T)(implicit evidence$1: Numeric[T]) extends Product with Serializable
Class representing an spread (i.e., range) between two numbers.
The spread is expressed in terms of a Numeric
pivot and tolerance.
The spread extends from pivot - tolerance
to pivot + tolerance
, inclusive.
- pivot
the pivot number at the center of the spread
- tolerance
the tolerance that determines the high and low point of the spread
- Alphabetic
- By Inheritance
- Spread
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Spread(pivot: T, tolerance: T)(implicit arg0: Numeric[T])
- pivot
the pivot number at the center of the spread
- tolerance
the tolerance that determines the high and low point of the spread
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def !==(n: T): Boolean
Returns
false
if the passed number,n
, is within the spread represented by thisSpread
instanceReturns
false
if the passed number,n
, is within the spread represented by thisSpread
instanceThe purpose of this method, which will likely be used only rarely, is to achieve symmetry around the
!==
operator. TheTripleEquals
trait (and its type-checking siblingTypeCheckedTripleEquals
) enable you to write:a !== (1.0 +- 0.1)
This method ensures the following mirrored form means the same thing:
(1.0 +- 0.1) !== a
- n
a number that may or may not lie within this spread
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ===(n: T): Boolean
Returns
true
if the passed number,n
, is within the spread represented by thisSpread
instanceReturns
true
if the passed number,n
, is within the spread represented by thisSpread
instanceThe purpose of this method, which will likely be used only rarely, is to achieve symmetry around the
===
operator. TheTripleEquals
trait (and its type-checking siblingTypeCheckedTripleEquals
) enable you to write:a === (1.0 +- 0.1)
This method ensures the following mirrored form means the same thing:
(1.0 +- 0.1) === a
- n
a number that may or may not lie within this spread
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isWithin(n: T): Boolean
Determines whether the passed
Numeric
valuen
is within the spread represented by thisSpread
instance. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val pivot: T
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
Overrides toString to return "[pivot] +- [tolerance]"
Overrides toString to return "[pivot] +- [tolerance]"
- Definition Classes
- Spread → AnyRef → Any
- val tolerance: T
- 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()