Package com.pholser.junit.quickcheck.generator.java.math

Class BigIntegerGenerator

java.lang.Object
com.pholser.junit.quickcheck.generator.Generator<T>
com.pholser.junit.quickcheck.generator.IntegralGenerator<BigInteger>
com.pholser.junit.quickcheck.generator.java.math.BigIntegerGenerator
All Implemented Interfaces:
Gen<BigInteger>, Shrink<BigInteger>
public class BigIntegerGenerator extends IntegralGenerator<BigInteger>

Produces values of type BigInteger.

With no additional configuration, the generated values are chosen from a range with a magnitude decided by GenerationStatus.size().

  • Field Details

  • Constructor Details

    • BigIntegerGenerator

      public BigIntegerGenerator()

  • Method Details

    • configure

      public void configure(InRange range)

      Tells this generator to produce values within a specified minimum and/or maximum inclusive, with uniform distribution.

      If an endpoint of the range is not specified, its value takes on a magnitude influenced by GenerationStatus.size().

      Parameters:
      range - annotation that gives the range's constraints

    • generate

      public BigInteger generate(SourceOfRandomness random, GenerationStatus status)
      Description copied from interface: Gen
      Generates a value, possibly influenced by a source of randomness and metadata about the generation.
      Parameters:
      random - source of randomness to be used when generating the value
      status - an object that can be used to influence the generated value. For example, generating lists can use the size method to generate lists with a given number of elements.
      Returns:
      the generated value

    • narrow

      protected Function<BigInteger,BigInteger> narrow()
      Specified by:
      narrow in class IntegralGenerator<BigInteger>
      Returns:
      a function converting a BigInteger into the equivalent value in the base type

    • inRange

      protected Predicate<BigInteger> inRange()
      Specified by:
      inRange in class IntegralGenerator<BigInteger>
      Returns:
      a predicate checking whether its input is in the configured range

    • leastMagnitude

      protected BigInteger leastMagnitude()
      Specified by:
      leastMagnitude in class IntegralGenerator<BigInteger>
      Returns:
      the lowest magnitude number, respecting the configured range. The ideal shrink value is always this value (i.e. this value cannot be shrunk any further).

    • negative

      protected boolean negative(BigInteger target)
      Specified by:
      negative in class IntegralGenerator<BigInteger>
      Returns:
      whether the given number is negative or not

    • negate

      protected BigInteger negate(BigInteger target)
      Description copied from class: IntegralGenerator
      Used when shrinking negative numbers to add the positive equivalent value at the top of shrinks list.
      Specified by:
      negate in class IntegralGenerator<BigInteger>
      Parameters:
      target - always a negative number
      Returns:
      the positive equivalent to target

    • magnitude

      public BigDecimal magnitude(Object value)
      Description copied from class: Generator

      Gives a hint to the shrinking process as to the magnitude of the given value. The shrinking process will prefer trying values of greater magnitude before values of lesser magnitude. If not overridden, this implementation returns "one".

      Note to generator writers: Do not worry about normalizing a magnitude to a positive value; the shrinking mechanism will take care of it.

      Overrides:
      magnitude in class Generator<BigInteger>
      Parameters:
      value - the value to assess
      Returns:
      a measure of the given value's magnitude
      See Also: