org.scalacheck

Arbitrary

object Arbitrary extends AnyRef

Defines implicit Arbitrary instances for common types.

ScalaCheck uses implicit Arbitrary instances when creating properties out of functions with the Prop.property method, and when the Arbitrary.arbitrary method is used. For example, the following code requires that there exists an implicit Arbitrary[MyClass] instance:

val myProp = Prop.forAll { myClass: MyClass =>
...
}

val myGen = Arbitrary.arbitrary[MyClass]

The required implicit definition could look like this:

implicit val arbMyClass: Arbitrary[MyClass] = Arbitrary(...)

The factory method Arbitrary(...) takes a generator of type Gen[T] and returns an instance of Arbitrary[T].

The Arbitrary module defines implicit Arbitrary instances for common types, for convenient use in your properties and generators.

go to: companion
Inherited
  1. Hide All
  2. Show all
  1. AnyRef
  2. Any
Visibility
  1. Public
  2. All

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def apply[T](g: ⇒ Gen[T]): Arbitrary[T]

    Creates an Arbitrary instance

    Creates an Arbitrary instance

  9. implicit lazy val arbAnyVal: Arbitrary[AnyVal]

    attributes: implicit
  10. implicit def arbArray[T](implicit a: Arbitrary[T], c: ClassManifest[T]): Arbitrary[Array[T]]

    Arbitrary instance of any array.

    Arbitrary instance of any array.

    attributes: implicit
  11. implicit lazy val arbBigDecimal: Arbitrary[BigDecimal]

    attributes: implicit
  12. implicit lazy val arbBigInt: Arbitrary[BigInt]

    attributes: implicit
  13. implicit lazy val arbBool: Arbitrary[Boolean]

    attributes: implicit
  14. implicit lazy val arbByte: Arbitrary[Byte]

    attributes: implicit
  15. implicit lazy val arbChar: Arbitrary[Char]

    attributes: implicit
  16. implicit def arbContainer[C, T](implicit a: Arbitrary[T], b: Buildable[T, C[_][_]]): Arbitrary[C[T]]

    Arbitrary instance of any buildable container (such as lists, arrays, streams, etc).

    Arbitrary instance of any buildable container (such as lists, arrays, streams, etc). The maximum size of the container depends on the size generation parameter.

    attributes: implicit
  17. implicit lazy val arbDate: Arbitrary[Date]

    attributes: implicit
  18. implicit lazy val arbDouble: Arbitrary[Double]

    attributes: implicit
  19. implicit def arbEither[T, U](implicit at: Arbitrary[T], au: Arbitrary[U]): Arbitrary[Either[T, U]]

    attributes: implicit
  20. implicit lazy val arbFloat: Arbitrary[Float]

    attributes: implicit
  21. implicit def arbFunction1[T1, R](implicit a: Arbitrary[R]): Arbitrary[(T1) ⇒ R]

    Arbitrary instance of Function1

    Arbitrary instance of Function1

    attributes: implicit
  22. implicit def arbFunction2[T1, T2, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2) ⇒ R]

    Arbitrary instance of Function2

    Arbitrary instance of Function2

    attributes: implicit
  23. implicit def arbFunction3[T1, T2, T3, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3) ⇒ R]

    Arbitrary instance of Function3

    Arbitrary instance of Function3

    attributes: implicit
  24. implicit def arbFunction4[T1, T2, T3, T4, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3, T4) ⇒ R]

    Arbitrary instance of Function4

    Arbitrary instance of Function4

    attributes: implicit
  25. implicit def arbFunction5[T1, T2, T3, T4, T5, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3, T4, T5) ⇒ R]

    Arbitrary instance of Function5

    Arbitrary instance of Function5

    attributes: implicit
  26. implicit def arbGen[T](implicit a: Arbitrary[T]): Arbitrary[Gen[T]]

    Arbitrary instance of Gen

    Arbitrary instance of Gen

    attributes: implicit
  27. implicit lazy val arbGenParams: Arbitrary[Params]

    attributes: implicit
  28. implicit def arbImmutableMap[T, U](implicit at: Arbitrary[T], au: Arbitrary[U]): Arbitrary[Map[T, U]]

    Arbitrary instance of immutable map

    Arbitrary instance of immutable map

    attributes: implicit
  29. implicit lazy val arbInt: Arbitrary[Int]

    attributes: implicit
  30. implicit lazy val arbLong: Arbitrary[Long]

    attributes: implicit
  31. implicit def arbMutableMap[T, U](implicit at: Arbitrary[T], au: Arbitrary[U]): Arbitrary[Map[T, U]]

    Arbitrary instance of mutable map

    Arbitrary instance of mutable map

    attributes: implicit
  32. implicit lazy val arbNumber: Arbitrary[Number]

    attributes: implicit
  33. implicit def arbOption[T](implicit a: Arbitrary[T]): Arbitrary[Option[T]]

    Arbitrary instance of option type

    Arbitrary instance of option type

    attributes: implicit
  34. implicit lazy val arbProp: Arbitrary[Prop]

    attributes: implicit
  35. implicit lazy val arbPropParams: Arbitrary[Params]

    attributes: implicit
  36. implicit lazy val arbShort: Arbitrary[Short]

    attributes: implicit
  37. implicit lazy val arbString: Arbitrary[String]

    attributes: implicit
  38. implicit lazy val arbTestParams: Arbitrary[Params]

    attributes: implicit
  39. implicit lazy val arbThrowable: Arbitrary[Throwable]

    attributes: implicit
  40. implicit def arbTuple2[T1, T2](implicit a1: Arbitrary[T1], a2: Arbitrary[T2]): Arbitrary[(T1, T2)]

    Arbitrary instance of 2-tuple

    Arbitrary instance of 2-tuple

    attributes: implicit
  41. implicit def arbTuple3[T1, T2, T3](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3]): Arbitrary[(T1, T2, T3)]

    Arbitrary instance of 3-tuple

    Arbitrary instance of 3-tuple

    attributes: implicit
  42. implicit def arbTuple4[T1, T2, T3, T4](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4]): Arbitrary[(T1, T2, T3, T4)]

    Arbitrary instance of 4-tuple

    Arbitrary instance of 4-tuple

    attributes: implicit
  43. implicit def arbTuple5[T1, T2, T3, T4, T5](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4], a5: Arbitrary[T5]): Arbitrary[(T1, T2, T3, T4, T5)]

    Arbitrary instance of 5-tuple

    Arbitrary instance of 5-tuple

    attributes: implicit
  44. implicit def arbTuple6[T1, T2, T3, T4, T5, T6](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4], a5: Arbitrary[T5], a6: Arbitrary[T6]): Arbitrary[(T1, T2, T3, T4, T5, T6)]

    Arbitrary instance of 6-tuple

    Arbitrary instance of 6-tuple

    attributes: implicit
  45. implicit def arbTuple7[T1, T2, T3, T4, T5, T6, T7](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4], a5: Arbitrary[T5], a6: Arbitrary[T6], a7: Arbitrary[T7]): Arbitrary[(T1, T2, T3, T4, T5, T6, T7)]

    Arbitrary instance of 7-tuple

    Arbitrary instance of 7-tuple

    attributes: implicit
  46. implicit def arbTuple8[T1, T2, T3, T4, T5, T6, T7, T8](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4], a5: Arbitrary[T5], a6: Arbitrary[T6], a7: Arbitrary[T7], a8: Arbitrary[T8]): Arbitrary[(T1, T2, T3, T4, T5, T6, T7, T8)]

    Arbitrary instance of 8-tuple

    Arbitrary instance of 8-tuple

    attributes: implicit
  47. implicit def arbTuple9[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit a1: Arbitrary[T1], a2: Arbitrary[T2], a3: Arbitrary[T3], a4: Arbitrary[T4], a5: Arbitrary[T5], a6: Arbitrary[T6], a7: Arbitrary[T7], a8: Arbitrary[T8], a9: Arbitrary[T9]): Arbitrary[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]

    Arbitrary instance of 9-tuple

    Arbitrary instance of 9-tuple

    attributes: implicit
  48. implicit lazy val arbUnit: Arbitrary[Unit]

    attributes: implicit
  49. def arbitrary[T](implicit a: Arbitrary[T]): Gen[T]

    Returns an arbitrary generator for the type T.

    Returns an arbitrary generator for the type T.

  50. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  51. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  52. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  53. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  54. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  55. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  56. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  57. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  58. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  59. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  60. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  61. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  62. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  63. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  64. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  65. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef