Apache Commons Math 3.6.1 · org.apache.commons.math3.random.RandomAdaptor

Modifier and Type	Field and Description
private final RandomGenerator	randomGenerator Wrapped randomGenerator instance
private static final long	serialVersionUID Hides java.util.Random.serialVersionUID. Serializable version identifier.

Access	Constructor and Description
private	RandomAdaptor() Prevent instantiation without a generator argument
public	RandomAdaptor(RandomGenerator the wrapped generator randomGenerator) Construct a RandomAdaptor wrapping the supplied RandomGenerator.

Method Summary

Modifier and Type	Method and Description
public static Random	Returns: a Random instance wrapping the RandomGenerator createAdaptor(RandomGenerator wrapped RandomGenerator instance randomGenerator) Factory method to create a `Random` using the supplied `RandomGenerator`.
public boolean	Returns: the next pseudorandom, uniformly distributed `boolean` value from this random number generator's sequence nextBoolean() Overrides java.util.Random.nextBoolean. Overrides default java.util.random.RandomGenerator.nextBoolean. Implements org.apache.commons.math3.random.RandomGenerator.nextBoolean. Returns the next pseudorandom, uniformly distributed `boolean` value from this random number generator's sequence.
public void	nextBytes(byte[] the non-null byte array in which to put the random bytes bytes) Overrides java.util.Random.nextBytes. Overrides default java.util.random.RandomGenerator.nextBytes. Implements org.apache.commons.math3.random.RandomGenerator.nextBytes. Generates random bytes and places them into a user-supplied byte array.
public double	Returns: the next pseudorandom, uniformly distributed `double` value between `0.0` and `1.0` from this random number generator's sequence nextDouble() Overrides java.util.Random.nextDouble. Overrides default java.util.random.RandomGenerator.nextDouble. Implements org.apache.commons.math3.random.RandomGenerator.nextDouble. Returns the next pseudorandom, uniformly distributed `double` value between `0.0` and `1.0` from this random number generator's sequence.
public float	Returns: the next pseudorandom, uniformly distributed `float` value between `0.0` and `1.0` from this random number generator's sequence nextFloat() Overrides java.util.Random.nextFloat. Overrides default java.util.random.RandomGenerator.nextFloat. Implements org.apache.commons.math3.random.RandomGenerator.nextFloat. Returns the next pseudorandom, uniformly distributed `float` value between `0.0` and `1.0` from this random number generator's sequence.
public double	Returns: the next pseudorandom, Gaussian ("normally") distributed `double` value with mean `0.0` and standard deviation `1.0` from this random number generator's sequence nextGaussian() Overrides java.util.Random.nextGaussian. Overrides default java.util.random.RandomGenerator.nextGaussian. Implements org.apache.commons.math3.random.RandomGenerator.nextGaussian. Returns the next pseudorandom, Gaussian ("normally") distributed `double` value with mean `0.0` and standard deviation `1.0` from this random number generator's sequence.
public int	Returns: the next pseudorandom, uniformly distributed `int` value from this random number generator's sequence nextInt() Overrides java.util.Random.nextInt. Overrides default java.util.random.RandomGenerator.nextInt. Implements org.apache.commons.math3.random.RandomGenerator.nextInt. Returns the next pseudorandom, uniformly distributed `int` value from this random number generator's sequence.
public int	Returns: a pseudorandom, uniformly distributed `int` value between 0 (inclusive) and n (exclusive). nextInt(int the bound on the random number to be returned. Must be positive. n) Overrides java.util.Random.nextInt. Overrides default java.util.random.RandomGenerator.nextInt. Implements org.apache.commons.math3.random.RandomGenerator.nextInt. Returns a pseudorandom, uniformly distributed `int` value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.
public long	Returns: the next pseudorandom, uniformly distributed `long` value from this random number generator's sequence nextLong() Overrides java.util.Random.nextLong. Implements org.apache.commons.math3.random.RandomGenerator.nextLong, java.util.random.RandomGenerator.nextLong. Returns the next pseudorandom, uniformly distributed `long` value from this random number generator's sequence.
public void	setSeed(int the seed value seed) Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using an `int` seed.
public void	setSeed(int[] the seed value seed) Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using an `int` array seed.
public void	setSeed(long the seed value seed) Overrides java.util.Random.setSeed. Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using a `long` seed.

Inherited from java.util.Random:: doubles doubles doubles doubles from ints ints ints ints longs longs longs longs next

randomGenerator	back to summary
private final RandomGenerator randomGenerator Wrapped randomGenerator instance

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.Random.serialVersionUID. Serializable version identifier.

RandomAdaptor	back to summary
private RandomAdaptor() Prevent instantiation without a generator argument Annotations @SuppressWarnings:unused

RandomAdaptor	back to summary
public RandomAdaptor(RandomGenerator randomGenerator) Construct a RandomAdaptor wrapping the supplied RandomGenerator. Parameters randomGenerator:RandomGenerator the wrapped generator

Method Detail

createAdaptor back to summary

createAdaptor	back to summary
public static Random createAdaptor(RandomGenerator randomGenerator) Factory method to create a `Random` using the supplied `RandomGenerator`. Parameters randomGenerator:RandomGenerator wrapped RandomGenerator instance Returns:Random a Random instance wrapping the RandomGenerator

public static Random createAdaptor(RandomGenerator randomGenerator)

Factory method to create a Random using the supplied RandomGenerator.

Parameters

randomGenerator:RandomGenerator: wrapped RandomGenerator instance

Returns:Random

a Random instance wrapping the RandomGenerator

nextBoolean back to summary

nextBoolean	back to summary
public boolean nextBoolean() Overrides java.util.Random.nextBoolean. Overrides default java.util.random.RandomGenerator.nextBoolean. Implements org.apache.commons.math3.random.RandomGenerator.nextBoolean. Returns the next pseudorandom, uniformly distributed `boolean` value from this random number generator's sequence. Returns:boolean the next pseudorandom, uniformly distributed `boolean` value from this random number generator's sequence Annotations @Override

public boolean nextBoolean()

Overrides java.util.Random.nextBoolean.

Overrides default java.util.random.RandomGenerator.nextBoolean.

Implements org.apache.commons.math3.random.RandomGenerator.nextBoolean.

Returns the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence.

Returns:boolean

the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence

Annotations

@Override

nextBytes	back to summary
public void nextBytes(byte[] bytes) Overrides java.util.Random.nextBytes. Overrides default java.util.random.RandomGenerator.nextBytes. Implements org.apache.commons.math3.random.RandomGenerator.nextBytes. Generates random bytes and places them into a user-supplied byte array. The number of random bytes produced is equal to the length of the byte array. Parameters bytes:byte[] the non-null byte array in which to put the random bytes Annotations @Override

nextBytes

back to summary

public void nextBytes(byte[] bytes)

Overrides java.util.Random.nextBytes.

Overrides default java.util.random.RandomGenerator.nextBytes.

Implements org.apache.commons.math3.random.RandomGenerator.nextBytes.

Generates random bytes and places them into a user-supplied byte array. The number of random bytes produced is equal to the length of the byte array.

Parameters

bytes:byte[]: the non-null byte array in which to put the random bytes

Annotations

@Override

nextDouble back to summary

nextDouble	back to summary
public double nextDouble() Overrides java.util.Random.nextDouble. Overrides default java.util.random.RandomGenerator.nextDouble. Implements org.apache.commons.math3.random.RandomGenerator.nextDouble. Returns the next pseudorandom, uniformly distributed `double` value between `0.0` and `1.0` from this random number generator's sequence. Returns:double the next pseudorandom, uniformly distributed `double` value between `0.0` and `1.0` from this random number generator's sequence Annotations @Override

public double nextDouble()

Overrides java.util.Random.nextDouble.

Overrides default java.util.random.RandomGenerator.nextDouble.

Implements org.apache.commons.math3.random.RandomGenerator.nextDouble.

Returns the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence.

Returns:double

the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence

Annotations

@Override

nextFloat back to summary

nextFloat	back to summary
public float nextFloat() Overrides java.util.Random.nextFloat. Overrides default java.util.random.RandomGenerator.nextFloat. Implements org.apache.commons.math3.random.RandomGenerator.nextFloat. Returns the next pseudorandom, uniformly distributed `float` value between `0.0` and `1.0` from this random number generator's sequence. Returns:float the next pseudorandom, uniformly distributed `float` value between `0.0` and `1.0` from this random number generator's sequence Annotations @Override

public float nextFloat()

Overrides java.util.Random.nextFloat.

Overrides default java.util.random.RandomGenerator.nextFloat.

Implements org.apache.commons.math3.random.RandomGenerator.nextFloat.

Returns the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence.

Returns:float

the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence

Annotations

@Override

nextGaussian back to summary

nextGaussian	back to summary
public double nextGaussian() Overrides java.util.Random.nextGaussian. Overrides default java.util.random.RandomGenerator.nextGaussian. Implements org.apache.commons.math3.random.RandomGenerator.nextGaussian. Returns the next pseudorandom, Gaussian ("normally") distributed `double` value with mean `0.0` and standard deviation `1.0` from this random number generator's sequence. Returns:double the next pseudorandom, Gaussian ("normally") distributed `double` value with mean `0.0` and standard deviation `1.0` from this random number generator's sequence Annotations @Override

public double nextGaussian()

Overrides java.util.Random.nextGaussian.

Overrides default java.util.random.RandomGenerator.nextGaussian.

Implements org.apache.commons.math3.random.RandomGenerator.nextGaussian.

Returns the next pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence.

Returns:double

the next pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence

Annotations

@Override

nextInt back to summary

nextInt	back to summary
public int nextInt() Overrides java.util.Random.nextInt. Overrides default java.util.random.RandomGenerator.nextInt. Implements org.apache.commons.math3.random.RandomGenerator.nextInt. Returns the next pseudorandom, uniformly distributed `int` value from this random number generator's sequence. All 2³² possible `int` values should be produced with (approximately) equal probability. Returns:int the next pseudorandom, uniformly distributed `int` value from this random number generator's sequence Annotations @Override

public int nextInt()

Overrides java.util.Random.nextInt.

Overrides default java.util.random.RandomGenerator.nextInt.

Implements org.apache.commons.math3.random.RandomGenerator.nextInt.

Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. All 2³² possible int values should be produced with (approximately) equal probability.

Returns:int

the next pseudorandom, uniformly distributed int value from this random number generator's sequence

Annotations

@Override

nextInt back to summary

nextInt	back to summary
public int nextInt(int n) Overrides java.util.Random.nextInt. Overrides default java.util.random.RandomGenerator.nextInt. Implements org.apache.commons.math3.random.RandomGenerator.nextInt. Returns a pseudorandom, uniformly distributed `int` value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence. Parameters n:int the bound on the random number to be returned. Must be positive. Returns:int a pseudorandom, uniformly distributed `int` value between 0 (inclusive) and n (exclusive). Annotations @Override Exceptions IllegalArgumentException: if n is not positive.

public int nextInt(int n)

Overrides java.util.Random.nextInt.

Overrides default java.util.random.RandomGenerator.nextInt.

Implements org.apache.commons.math3.random.RandomGenerator.nextInt.

Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.

Parameters

n:int: the bound on the random number to be returned. Must be positive.

Returns:int

a pseudorandom, uniformly distributed int value between 0 (inclusive) and n (exclusive).

Annotations

@Override

Exceptions

IllegalArgumentException:: if n is not positive.

nextLong back to summary

nextLong	back to summary
public long nextLong() Overrides java.util.Random.nextLong. Implements org.apache.commons.math3.random.RandomGenerator.nextLong, java.util.random.RandomGenerator.nextLong. Returns the next pseudorandom, uniformly distributed `long` value from this random number generator's sequence. All 2⁶⁴ possible `long` values should be produced with (approximately) equal probability. Returns:long the next pseudorandom, uniformly distributed `long` value from this random number generator's sequence Annotations @Override

public long nextLong()

Overrides java.util.Random.nextLong.

Implements org.apache.commons.math3.random.RandomGenerator.nextLong, java.util.random.RandomGenerator.nextLong.

Returns the next pseudorandom, uniformly distributed long value from this random number generator's sequence. All 2⁶⁴ possible long values should be produced with (approximately) equal probability.

Returns:long

the next pseudorandom, uniformly distributed long value from this random number generator's sequence

Annotations

@Override

setSeed back to summary

setSeed	back to summary
public void setSeed(int seed) Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Doc from org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using an `int` seed. Sequences of values generated starting with the same seeds should be identical. Parameters seed:int the seed value

public void setSeed(int seed)

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Doc from org.apache.commons.math3.random.RandomGenerator.setSeed.

Sets the seed of the underlying random number generator using an int seed.

Sequences of values generated starting with the same seeds should be identical.

Parameters

seed:int: the seed value

setSeed back to summary

setSeed	back to summary
public void setSeed(int[] seed) Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Doc from org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using an `int` array seed. Sequences of values generated starting with the same seeds should be identical. Parameters seed:int[] the seed value

public void setSeed(int[] seed)

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Doc from org.apache.commons.math3.random.RandomGenerator.setSeed.

Sets the seed of the underlying random number generator using an int array seed.

Sequences of values generated starting with the same seeds should be identical.

Parameters

seed:int[]: the seed value

setSeed back to summary

setSeed	back to summary
public void setSeed(long seed) Overrides java.util.Random.setSeed. Implements org.apache.commons.math3.random.RandomGenerator.setSeed. Doc from org.apache.commons.math3.random.RandomGenerator.setSeed. Sets the seed of the underlying random number generator using a `long` seed. Sequences of values generated starting with the same seeds should be identical. Parameters seed:long the seed value Annotations @Override

public void setSeed(long seed)

Overrides java.util.Random.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Doc from org.apache.commons.math3.random.RandomGenerator.setSeed.

Sets the seed of the underlying random number generator using a long seed.

Sequences of values generated starting with the same seeds should be identical.

Parameters

seed:long: the seed value

Annotations

@Override

public Class RandomAdaptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail