Arbitrary

Defines implicit org.scalacheck.Arbitrary instances for common types.

ScalaCheck uses implicit org.scalacheck.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 org.scalacheck.Arbitrary instances for common types, for convenient use in your properties and generators.

Linear Supertypes

AnyRef, Any

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
def apply[T](g: ⇒ Gen[T]): Arbitrary[T]

Creates an Arbitrary instance
implicit lazy val arbAnyVal: Arbitrary[AnyVal]

Arbitrary AnyVal
implicit lazy val arbBigDecimal: Arbitrary[BigDecimal]

Arbitrary BigDecimal
implicit lazy val arbBigInt: Arbitrary[BigInt]

Arbitrary BigInt
implicit lazy val arbBool: Arbitrary[Boolean]

Arbitrary instance of Boolean
implicit lazy val arbByte: Arbitrary[Byte]

Arbitrary instance of Byte
implicit lazy val arbChar: Arbitrary[Char]

Arbitrary instance of Char
implicit def arbContainer[C[_], T](implicit a: Arbitrary[T], b: Buildable[T, C], t: (C[T]) ⇒ Traversable[T]): Arbitrary[C[T]]

Arbitrary instance of any org.scalacheck.util.Buildable container (such as lists, arrays, streams, etc).
Arbitrary instance of any org.scalacheck.util.Buildable container (such as lists, arrays, streams, etc). The maximum size of the container depends on the size generation parameter.
implicit def arbContainer2[C[_, _], T, U](implicit a: Arbitrary[(T, U)], b: Buildable2[T, U, C], t: (C[T, U]) ⇒ Traversable[(T, U)]): Arbitrary[C[T, U]]

Arbitrary instance of any org.scalacheck.util.Buildable2 container (such as maps, etc).
Arbitrary instance of any org.scalacheck.util.Buildable2 container (such as maps, etc). The maximum size of the container depends on the size generation parameter.
implicit lazy val arbDate: Arbitrary[Date]

Arbitrary instance of Date
implicit lazy val arbDouble: Arbitrary[Double]

Arbitrary instance of Double
implicit def arbEither[T, U](implicit at: Arbitrary[T], au: Arbitrary[U]): Arbitrary[Either[T, U]]

Arbitrary instance of the Either type
implicit lazy val arbError: Arbitrary[Error]

Arbitrary instance of Error
implicit lazy val arbException: Arbitrary[Exception]

Arbitrary instance of Exception
implicit lazy val arbFloat: Arbitrary[Float]

Arbitrary instance of Float
implicit def arbFunction1[T1, R](implicit a: Arbitrary[R]): Arbitrary[(T1) ⇒ R]

Arbitrary instance of Function1
implicit def arbFunction2[T1, T2, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2) ⇒ R]

Arbitrary instance of Function2
implicit def arbFunction3[T1, T2, T3, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3) ⇒ R]

Arbitrary instance of Function3
implicit def arbFunction4[T1, T2, T3, T4, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3, T4) ⇒ R]

Arbitrary instance of Function4
implicit def arbFunction5[T1, T2, T3, T4, T5, R](implicit a: Arbitrary[R]): Arbitrary[(T1, T2, T3, T4, T5) ⇒ R]

Arbitrary instance of Function5
implicit def arbGen[T](implicit a: Arbitrary[T]): Arbitrary[Gen[T]]

Arbitrary instance of org.scalacheck.Gen
implicit lazy val arbGenParams: Arbitrary[Parameters]

Arbitrary instance of gen params
implicit lazy val arbInt: Arbitrary[Int]

Arbitrary instance of Int
implicit lazy val arbLong: Arbitrary[Long]

Arbitrary instance of Long
implicit lazy val arbNumber: Arbitrary[Number]

Arbitrary java.lang.Number
implicit def arbOption[T](implicit a: Arbitrary[T]): Arbitrary[Option[T]]

Arbitrary instance of the Option type
implicit lazy val arbProp: Arbitrary[Prop]

Generates an arbitrary property
implicit lazy val arbShort: Arbitrary[Short]

Arbitrary instance of Short
implicit lazy val arbString: Arbitrary[String]

Arbitrary instance of String
implicit lazy val arbTestParameters: Arbitrary[Parameters]

Arbitrary instance of test parameters
implicit lazy val arbThrowable: Arbitrary[Throwable]

Arbitrary instance of Throwable
implicit def arbTuple2[T1, T2](implicit a1: Arbitrary[T1], a2: Arbitrary[T2]): Arbitrary[(T1, T2)]

Arbitrary instance of 2-tuple
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
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
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
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
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
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
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
implicit lazy val arbUnit: Arbitrary[Unit]

Absolutely, totally, 100% arbitrarily chosen Unit.
def arbitrary[T](implicit a: Arbitrary[T]): Gen[T]

Returns an arbitrary generator for the type T.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class Arbitrary | package scalacheck

object Arbitrary

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[T](g: ⇒ Gen[T]): Arbitrary[T]

implicit lazy val arbAnyVal: Arbitrary[AnyVal]

implicit lazy val arbBigDecimal: Arbitrary[BigDecimal]

implicit lazy val arbBigInt: Arbitrary[BigInt]

implicit lazy val arbBool: Arbitrary[Boolean]

implicit lazy val arbByte: Arbitrary[Byte]

implicit lazy val arbChar: Arbitrary[Char]

implicit def arbContainer[C[_], T](implicit a: Arbitrary[T], b: Buildable[T, C], t: (C[T]) ⇒ Traversable[T]): Arbitrary[C[T]]

implicit def arbContainer2[C[_, _], T, U](implicit a: Arbitrary[(T, U)], b: Buildable2[T, U, C], t: (C[T, U]) ⇒ Traversable[(T, U)]): Arbitrary[C[T, U]]

implicit lazy val arbDate: Arbitrary[Date]

implicit lazy val arbDouble: Arbitrary[Double]

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

implicit lazy val arbError: Arbitrary[Error]

implicit lazy val arbException: Arbitrary[Exception]

implicit lazy val arbFloat: Arbitrary[Float]

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

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

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

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

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

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

implicit lazy val arbGenParams: Arbitrary[Parameters]

implicit lazy val arbInt: Arbitrary[Int]

implicit lazy val arbLong: Arbitrary[Long]

implicit lazy val arbNumber: Arbitrary[Number]

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

implicit lazy val arbProp: Arbitrary[Prop]

implicit lazy val arbShort: Arbitrary[Short]

implicit lazy val arbString: Arbitrary[String]

implicit lazy val arbTestParameters: Arbitrary[Parameters]

implicit lazy val arbThrowable: Arbitrary[Throwable]

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

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

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

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

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

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

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

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

implicit lazy val arbUnit: Arbitrary[Unit]

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

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped