Spread

org.scalactic.TripleEqualsSupport.Spread
final case class Spread[T](pivot: T, tolerance: T)(implicit evidence$1: Numeric[T])

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.

Value parameters

pivot

the pivot number at the center of the spread

tolerance

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

Attributes

Source
TripleEqualsSupport.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

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 sibling TypeCheckedTripleEquals) 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

Value parameters

n

a number that may or may not lie within this spread

Attributes

Source
TripleEqualsSupport.scala
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 sibling TypeCheckedTripleEquals) 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

Value parameters

n

a number that may or may not lie within this spread

Attributes

Source
TripleEqualsSupport.scala
def isWithin(n: T): Boolean

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.

Attributes

Source
TripleEqualsSupport.scala
override def toString: String

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

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

Attributes

Definition Classes
Any
Source
TripleEqualsSupport.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product