net.jqwik.api.arbitraries.NumericalArbitrary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jqwik-api Show documentation

Jqwik API module

There is a newer version: 1.9.2

package net.jqwik.api.arbitraries;

import org.apiguardian.api.*;

import net.jqwik.api.*;

import static org.apiguardian.api.API.Status.*;

@API(status = EXPERIMENTAL, since = "1.3.0")
public interface NumericalArbitrary> extends Arbitrary {

	/**
	 * Set the {@linkplain RandomDistribution distribution} to use when generating random numerical values.
	 *
	 * 
	 * jqwik currently offers two built-in distributions:
	 * 

	 *     {@linkplain RandomDistribution#biased()} is the default
	 *     {@linkplain RandomDistribution#uniform()} creates a uniform probability distribution
	 * 
	 *
	 * @param distribution The distribution to use when generating random values
	 * @return a random distribution instance
	 */
	A withDistribution(RandomDistribution distribution);

}