Class

org.scalactic.TripleEqualsSupport

Spread

Related Doc: package TripleEqualsSupport

Permalink

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

Source
TripleEqualsSupport.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spread
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Spread(pivot: T, tolerance: T)(implicit arg0: Numeric[T])

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !==(n: T): Boolean

    Permalink

    Returns false if the passed number, n, is within the spread represented by this Spread instance

    Returns false if the passed number, n, is within the spread represented by this Spread instance

    The purpose of this method, which will likely be used only rarely, is to achieve symmetry around the !== operator. The TripleEquals trait (and its type-checking siblings TypeCheckedTripleEquals and ConversionCheckedTripleEquals) 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

  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def ===(n: T): Boolean

    Permalink

    Returns true if the passed number, n, is within the spread represented by this Spread instance

    Returns true if the passed number, n, is within the spread represented by this Spread instance

    The purpose of this method, which will likely be used only rarely, is to achieve symmetry around the === operator. The TripleEquals trait (and its type-checking siblings TypeCheckedTripleEquals and ConversionCheckedTripleEquals) 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

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. def isWithin(n: T): Boolean

    Permalink

    Determines whether the passed Numeric value n is within the spread represented by this Spread instance.

    Determines whether the passed Numeric value n is within the spread represented by this Spread instance.

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. val pivot: T

    Permalink

    the pivot number at the center of the spread

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink

    Overrides toString to return "[pivot] +- [tolerance]"

    Overrides toString to return "[pivot] +- [tolerance]"

    Definition Classes
    Spread → AnyRef → Any
  19. val tolerance: T

    Permalink

    the tolerance that determines the high and low point of the spread

  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped