org.scalacheck

Gen

object Gen extends AnyRef

Contains combinators for building generators.

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

Type Members

  1. class Params(size: Int, rng: Random) extends Product

    Record that encapsulates all parameters required for data generation

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 alphaChar: Gen[Char]

  9. def alphaLowerChar: Gen[Char]

  10. def alphaNumChar: Gen[Char]

  11. def alphaStr: Gen[String]

  12. def alphaUpperChar: Gen[Char]

  13. def apply[T](g: (Params) ⇒ Option[T]): Gen[T]

  14. 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

  15. def choose(low: Double, high: Double): Gen[Double]

    A generator that generates a random Double in the given (inclusive) range.

    A generator that generates a random Double in the given (inclusive) range.

  16. def choose(low: Long, high: Long): Gen[Long]

    A generator that generates a random Long in the given (inclusive) range.

    A generator that generates a random Long in the given (inclusive) range.

  17. def choose(low: Int, high: Int): Gen[Int]

    A generator that generates a random Integer in the given (inclusive) range.

    A generator that generates a random Integer in the given (inclusive) range.

  18. 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

  19. def containerOf[C, T](g: Gen[T])(implicit b: Buildable[T, C[_][_]]): Gen[C[T]]

    Generates a container of any type for which there exists an implicit Buildable instance.

    Generates a container of any type for which there exists an implicit Buildable instance. The elements in the container will be generated by the given generator. The size of the container is bounded by the size parameter used when generating values.

  20. def containerOf1[C, T](g: Gen[T])(implicit b: Buildable[T, C[_][_]]): Gen[C[T]]

    Generates a non-empty container of any type for which there exists an implicit Buildable instance.

    Generates a non-empty container of any type for which there exists an implicit Buildable instance. The elements in the container will be generated by the given generator. The size of the container is bounded by the size parameter used when generating values.

  21. def containerOfN[C, T](n: Int, g: Gen[T])(implicit b: Buildable[T, C[_][_]]): Gen[C[T]]

    Generates a container of any type for which there exists an implicit Buildable instance.

    Generates a container of any type for which there exists an implicit Buildable instance. The elements in the container will be generated by the given generator. The size of the generated container is given by n.

  22. val defaultParams: Params

  23. def elements[T](xs: T*): Gen[T]

    A generator that returns a random element from a list

    A generator that returns a random element from a list

      deprecated:

    1. Use 'oneOf' with constant generators instead.

  24. def elementsFreq[T](vs: (Int, T)*): Gen[T]

    Chooses one of the given values, with a weighted random distribution.

    Chooses one of the given values, with a weighted random distribution.

      deprecated:

    1. Use 'frequency' with constant generators instead.

  25. 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

  26. 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

  27. def fail[T]: Gen[T]

    A generator that never generates a value

    A generator that never generates a value

  28. 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

  29. def fractionalGenerator[T](minT: T, maxT: T, chooser: (T, T) ⇒ Gen[T], specials: T*)(implicit num: Fractional[T]): Gen[T]

    Like integralGenerator for Float/Double - also makes sure to explore the -1.

    Like integralGenerator for Float/Double - also makes sure to explore the -1.0 to 1.0 range.

  30. implicit def freqTuple[T](t: (Int, T)): (Int, Gen[T])

    attributes: implicit

  31. def frequency[T](gs: (Int, Gen[T])*): Gen[T]

    Chooses one of the given generators with a weighted random distribution

    Chooses one of the given generators with a weighted random distribution

  32. def genAnyVal: Gen[AnyVal]

  33. def genBool: Gen[Boolean]

  34. def genByte: Gen[Byte]

  35. def genChar: Gen[Char]

  36. def genDouble: Gen[Double]

  37. def genFloat: Gen[Float]

  38. def genInt: Gen[Int]

  39. def genLong: Gen[Long]

  40. def genShort: Gen[Short]

  41. def genUnit: Gen[Unit]

  42. 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

  43. 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

  44. def identifier: Gen[String]

  45. def integralGenerator[T](minT: T, maxT: T, chooser: (T, T) ⇒ Gen[T])(implicit num: Integral[T]): Gen[T]

    Creates plausibly well-rounded generator for Byte/Short/Int/Long, including zero, +/- unity, and both extremities.

    Creates plausibly well-rounded generator for Byte/Short/Int/Long, including zero, +/- unity, and both extremities.

  46. 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

  47. def listOf[T](g: ⇒ Gen[T]): Gen[List[T]]

    Generates a list of random length.

    Generates a list of random length. The maximum length depends on the size parameter. This method is equal to calling containerOf[List,T](g).

  48. def listOf1[T](g: ⇒ Gen[T]): Gen[List[T]]

    Generates a non-empty list of random length.

    Generates a non-empty list of random length. The maximum length depends on the size parameter. This method is equal to calling containerOf1[List,T](g).

  49. def listOfN[T](n: Int, g: Gen[T]): Gen[List[T]]

    Generates a list of the given length.

    Generates a list of the given length. This method is equal to calling containerOfN[List,T](n,g).

  50. def lzy[T](g: ⇒ Gen[T]): Gen[T] {...}

    Wraps a generator lazily.

    Wraps a generator lazily. The given parameter is only evalutated once, and not until the wrapper generator is evaluated.

  51. 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

  52. def negInt: Gen[Int]

  53. 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

  54. 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

  55. def numChar: Gen[Char]

  56. def numStr: Gen[String]

  57. def oneOf[T](g1: Gen[T], g2: Gen[T], gs: Gen[T]*): Gen[T]

    Picks a random generator from a list

    Picks a random generator from a list

  58. def oneOf[T](xs: Seq[T]): Gen[T]

    Picks a random value from a list

    Picks a random value from a list

  59. def parameterized[T](f: (Params) ⇒ Gen[T]): Gen[T]

    Creates a generator that can access its generation parameters

    Creates a generator that can access its generation parameters

  60. def pick[T](n: Int, g1: Gen[T], g2: Gen[T], gs: Gen[T]*): Gen[Seq[T]]

    A generator that picks a given number of elements from a list, randomly

    A generator that picks a given number of elements from a list, randomly

  61. def pick[T](n: Int, l: Iterable[T]): Gen[Seq[T]]

    A generator that picks a given number of elements from a list, randomly

    A generator that picks a given number of elements from a list, randomly

  62. def posInt: Gen[Int]

  63. def resize[T](s: Int, g: Gen[T]): Gen[T]

    Creates a resized version of a generator

    Creates a resized version of a generator

  64. def sequence[C, T](gs: Iterable[Gen[T]])(implicit b: Buildable[T, C[_][_]]): Gen[C[T]]

    Sequences generators.

    Sequences generators. If any of the given generators fails, the resulting generator will also fail.

  65. def sized[T](f: (Int) ⇒ Gen[T]): Gen[T]

    Creates a generator that can access its generation size

    Creates a generator that can access its generation size

  66. def someOf[T](g1: Gen[T], g2: Gen[T], gs: Gen[T]*): Gen[Seq[T]]

    A generator that picks a random number of elements from a list

    A generator that picks a random number of elements from a list

  67. def someOf[T](l: Iterable[T]): Gen[Seq[T]]

    A generator that picks a random number of elements from a list

    A generator that picks a random number of elements from a list

  68. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

  69. 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

  70. implicit def value[T](x: T): Gen[T]

    A generator that always generates the given value

    A generator that always generates the given value

    attributes: implicit

  71. def vectorOf[T](n: Int, g: Gen[T]): Gen[List[T]]

    Generates a list of the given length.

    Generates a list of the given length. This method is equal to calling containerOfN[List,T](n,g).

      deprecated:

    1. Use 'listOfN' instead.

  72. def wait(): Unit

    attributes: final
    definition classes: AnyRef

  73. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

  74. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef

  75. def wrap[T](g: ⇒ Gen[T]): Gen[T]

    Wraps a generator for later evaluation.

    Wraps a generator for later evaluation. The given parameter is evaluated each time the wrapper generator is evaluated.