Scalactic is brought to you by:

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])

    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. def !==(n: T): Boolean

    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

  2. def ===(n: T): Boolean

    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

  3. def isWithin(n: T): Boolean

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

  4. val pivot: T
  5. def toString(): String

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

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

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