case class MaxDiscardedFactor(value: PosZDouble) extends PropertyCheckConfigParam with Product with Serializable
A PropertyCheckConfigParam that specifies how many generated values may be discarded, as a multiple of the successful attempts, before the property check is considered to be org.scalatest.prop.PropertyCheckResult.Exhausted.
In GeneratorDrivenPropertyChecks
, a property evaluation is discarded if it throws
DiscardedEvaluationException
, which is produced by a whenever
clause that
evaluates to false. For example, consider this ScalaTest property check:
// forAll defined inGeneratorDrivenPropertyChecks
forAll { (n: Int) => whenever (n > 0) { doubleIt(n) should equal (n * 2) } }
In the above code, whenever a non-positive n
is passed, the property function will complete abruptly
with DiscardedEvaluationException
.
Similarly, in Checkers
, a property evaluation is discarded if the expression to the left
of ScalaCheck's ==>
operator is false. Here's an example:
// forAll defined inCheckers
forAll { (n: Int) => (n > 0) ==> doubleIt(n) == (n * 2) }
For either kind of property check, MaxDiscardedFactor
indicates the maximum fraction of
total tests that may be discarded, relative to the number of successful tests. For example, if this
is set to 4.0, and you are running 100 tests, it may discard up to 400 tries before considering the
test to be org.scalatest.prop.PropertyCheckResult.Exhausted.
- value
the permitted number of discarded tests, as a multiple of successful ones.
- Source
- Configuration.scala
- Alphabetic
- By Inheritance
- MaxDiscardedFactor
- PropertyCheckConfigParam
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MaxDiscardedFactor(value: PosZDouble)
- value
the permitted number of discarded tests, as a multiple of successful ones.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val value: PosZDouble
- 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()