Companion object to trait TypeCheckedTripleEquals
that facilitates the importing of TypeCheckedTripleEquals
members as an alternative to mixing it in. One use case is to import TypeCheckedTripleEquals
members so you can use them in the Scala interpreter:
$ scala -classpath scalatest.jar Welcome to Scala 2.13.6 (OpenJDK 64-Bit Server VM, Java yyy). Type in expressions for evaluation. Or try :help. scala> import org.scalactic._ import org.scalactic._ scala> import TypeCheckedTripleEquals._ import TypeCheckedTripleEquals._ scala> 1 + 1 === 2 res0: Boolean = true
Attributes
- Companion
- trait
- Source
- TypeCheckedTripleEquals.scala
- Graph
-
- Supertypes
-
trait TypeCheckedTripleEqualstrait TripleEqualsSupportclass Objecttrait Matchableclass AnyShow all
- Self type
Members list
Type members
Inherited classlikes
Class used via an implicit conversion to enable two objects to be compared with ===
and !==
with a Boolean
result and an enforced type constraint between two object types. For example:
Class used via an implicit conversion to enable two objects to be compared with ===
and !==
with a Boolean
result and an enforced type constraint between two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Value parameters
- leftSide
-
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
Attributes
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Class used via an implicit conversion to enable any two objects to be compared with ===
and !==
with a Boolean
result and no enforced type constraint between two object types. For example:
Class used via an implicit conversion to enable any two objects to be compared with ===
and !==
with a Boolean
result and no enforced type constraint between two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
Value parameters
- leftSide
-
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
Attributes
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Value members
Inherited methods
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate the “<left> should !== (<pivot> +- <tolerance>)
” syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate the “<left> should !== (<pivot> +- <tolerance>)
” syntax of Matchers
.
Value parameters
- right
-
the
Spread[T]
against which to compare the left-hand value
Attributes
- Returns
-
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate the “<left> should !== null
” syntax of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate the “<left> should !== null
” syntax of Matchers
.
Value parameters
- right
-
a null reference
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate the “<left> should !== <right>
” syntax of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate the “<left> should !== <right>
” syntax of Matchers
.
Value parameters
- right
-
the right-hand side value for an equality assertion
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set tofalse
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate the “<left> should === (<pivot> +- <tolerance>)
” syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate the “<left> should === (<pivot> +- <tolerance>)
” syntax of Matchers
.
Value parameters
- right
-
the
Spread[T]
against which to compare the left-hand value
Attributes
- Returns
-
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate the “<left> should === null
” syntax of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate the “<left> should === null
” syntax of Matchers
.
Value parameters
- right
-
a null reference
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate the “<left> should === <right>
” syntax of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate the “<left> should === <right>
” syntax of Matchers
.
Value parameters
- right
-
the right-hand side value for an equality assertion
Attributes
- Returns
-
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set totrue
. - Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Converts to an Equalizer
that provides ===
and !==
operators that result in Boolean
and enforce no type constraint.
Converts to an Equalizer
that provides ===
and !==
operators that result in Boolean
and enforce no type constraint.
This method is overridden and made implicit by subtrait TripleEquals
and overriden as non-implicit by the other subtraits in this package.
Value parameters
- left
-
the object whose type to convert to
Equalizer
.
Attributes
- Throws
-
NullPointerException
if
left
isnull
. - Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
Returns an Equality[A]
for any type A
that determines equality by first calling .deep
on any Array
(on either the left or right side), then comparing the resulting objects with ==
.
Returns an Equality[A]
for any type A
that determines equality by first calling .deep
on any Array
(on either the left or right side), then comparing the resulting objects with ==
.
Attributes
- Returns
-
a default
Equality
for typeA
- Inherited from:
- TripleEqualsSupport
- Source
- TripleEqualsSupport.scala
Provides an A CanEqual B
instance for any two types A
and B
, with no type constraint enforced, given an implicit Equality[A]
.
Provides an A CanEqual B
instance for any two types A
and B
, with no type constraint enforced, given an implicit Equality[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equality[A]
's areEqual
method to determine equality.
This method is overridden and made implicit by subtraits TripleEquals
and overriden as non-implicit by the other subtraits in this package.
Value parameters
- equalityOfA
-
an
Equality[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEqual
method of the passedEquality[A]
. - Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
Deprecated and Inherited methods
The conversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The conversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
is implicitly convertible to A
, given an implicit Equivalence[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals
) and overriden as non-implicit by the other subtraits in this package.
Value parameters
- cnv
-
an implicit conversion from
B
to A - equivalenceOfA
-
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Deprecated
- true
- Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
The convertEquivalenceToAToBConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The convertEquivalenceToAToBConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that A
is implicitly convertible to B
, given an explicit Equivalence[B]
.
This method is used to enable the Explicitly
DSL for ConversionCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but taking an implicit function that converts from A
to B.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint
(extended by ConversionCheckedTripleEquals
), and overriden as non-implicit by the other subtraits in this package.
Value parameters
- cnv
-
an implicit conversion from
A
to B - equalityOfB
-
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Deprecated
- true
- Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
The convertEquivalenceToBToAConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The convertEquivalenceToBToAConversionConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
is implicitly convertible to A
, given an explicit Equivalence[A]
.
This method is used to enable the Explicitly
DSL for ConversionCheckedTripleEquals
by requiring an explicit Equivalance[A]
, but taking an implicit function that converts from B
to A. For example, under ConversionCheckedTripleEquals
, this method (as an implicit method), would be used to compile this statement:
def closeEnoughTo1(num: Double): Boolean = (num === 1.0)(decided by forgivingEquality)
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals
) and overriden as non-implicit by the other subtraits in this package.
Value parameters
- cnv
-
an implicit conversion from
B
to A - equivalenceOfA
-
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Deprecated
- true
- Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
The lowPriorityConversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
The lowPriorityConversionCheckedConstraint
method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals
has expired. It will not be replaced.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that A
is implicitly convertible to B
, given an implicit Equivalence[B]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint
(extended by ConversionCheckedTripleEquals
), and overriden as non-implicit by the other subtraits in this package.
Value parameters
- cnv
-
an implicit conversion from
A
to B - equalityOfB
-
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality.
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Deprecated
- true
- Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
Implicits
Inherited implicits
Provides a A CanEqual B
for any two types A
and B
, enforcing the type constraint that A
must be a subtype of B
, given an explicit Equivalence[B]
.
Provides a A CanEqual B
for any two types A
and B
, enforcing the type constraint that A
must be a subtype of B
, given an explicit Equivalence[B]
.
This method is used to enable the Explicitly
DSL for TypeCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but taking an implicit function that provides evidence that A
is a subtype of B.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[B]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint
(extended by TypeCheckedTripleEquals
), and overriden as non-implicit by the other subtraits in this package.
Value parameters
- equivalenceOfB
-
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality. - ev
-
evidence that
A
is a subype of B
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Definition Classes
- Inherited from:
- LowPriorityTypeCheckedConstraint
- Source
- LowPriorityTypeCheckedConstraint.scala
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
must be a subtype of A
, given an explicit Equivalence[A]
.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
must be a subtype of A
, given an explicit Equivalence[A]
.
This method is used to enable the Explicitly
DSL for TypeCheckedTripleEquals
by requiring an explicit Equivalance[B]
, but taking an implicit function that provides evidence that A
is a subtype of B. For example, under TypeCheckedTripleEquals
, this method (as an implicit method), would be used to compile this statement:
def closeEnoughTo1(num: Double): Boolean = (num === 1.0)(decided by forgivingEquality)
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits TypeCheckedTripleEquals
) and overriden as non-implicit by the other subtraits in this package.
Value parameters
- equalityOfA
-
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality. - ev
-
evidence that
B
is a subype of A
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
Converts to an CheckingEqualizer
that provides ===
and !==
operators that result in Boolean
and enforce a type constraint.
Converts to an CheckingEqualizer
that provides ===
and !==
operators that result in Boolean
and enforce a type constraint.
This method is overridden and made implicit by subtrait TypeCheckedTripleEquals
, and overriden as non-implicit by the other subtraits in this package.
Value parameters
- left
-
the object whose type to convert to
CheckingEqualizer
.
Attributes
- Throws
-
NullPointerException
if
left
isnull
. - Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala
Provides an A CanEqual B
for any two types A
and B
, enforcing the type constraint that A
must be a subtype of B
, given an implicit Equivalence[B]
.
Provides an A CanEqual B
for any two types A
and B
, enforcing the type constraint that A
must be a subtype of B
, given an implicit Equivalence[B]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint
(extended by TypeCheckedTripleEquals
), and overriden as non-implicit by the other subtraits in this package.
Value parameters
- equivalenceOfB
-
an
Equivalence[B]
type class to which theConstraint.areEqual
method will delegate to determine equality. - ev
-
evidence that
A
is a subype of B
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[B]
. - Definition Classes
- Inherited from:
- LowPriorityTypeCheckedConstraint
- Source
- LowPriorityTypeCheckedConstraint.scala
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
must be a subtype of A
, given an implicit Equivalence[A]
.
Provides an A CanEqual B
instance for any two types A
and B
, enforcing the type constraint that B
must be a subtype of A
, given an implicit Equivalence[A]
.
The returned Constraint
's areEqual
method uses the implicitly passed Equivalence[A]
's areEquivalent
method to determine equality.
This method is overridden and made implicit by subtraits TypeCheckedTripleEquals
) and overriden as non-implicit by the other subtraits in this package.
Value parameters
- equalityOfA
-
an
Equivalence[A]
type class to which theConstraint.areEqual
method will delegate to determine equality. - ev
-
evidence that
B
is a subype of A
Attributes
- Returns
-
an
A CanEqual B
instance whoseareEqual
method delegates to theareEquivalent
method of the passedEquivalence[A]
. - Definition Classes
- Inherited from:
- TypeCheckedTripleEquals
- Source
- TypeCheckedTripleEquals.scala