squidpony.squidmath

Class JavaRNG

java.lang.Object

squidpony.squidmath.JavaRNG

All Implemented Interfaces:

java.io.Serializable, squidpony.squidmath.RandomnessSource

public class JavaRNG
extends java.lang.Object
implements squidpony.squidmath.RandomnessSource, java.io.Serializable

This makes java.util.Random available for testing purposes. It is relevant mainly as example code, or if you want to compare what your results would have been without using a better RNG. Results might not be apparent in some cases, although the terrible performance of java.util.Random is likely to be the first thing a user notices if this is used heavily (i.e. to generate white noise with one call to nextDouble() per cell).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Random	random

Constructor Summary

Constructors

Constructor and Description
JavaRNG() Creates a new generator seeded using Math.random.
JavaRNG(long seed)
JavaRNG(java.util.Random random)

Method Summary

Modifier and Type	Method and Description
JavaRNG	copy()
boolean	equals(java.lang.Object o)
int	hashCode()
int	next(int bits)
boolean	nextBoolean() Gets a random value, true or false.
void	nextBytes(byte[] bytes) Given a byte array as a parameter, this will fill the array with random bytes (modifying it in-place).
double	nextDouble()
double	nextDouble(double outer)
float	nextFloat() Gets a uniform random float in the range [0.0,1.0)
int	nextInt()
int	nextInt(int bound)
int	nextInt(int lower, int upper) Inclusive lower, exclusive upper.
long	nextLong()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

random

public java.util.Random random

Constructor Detail

JavaRNG

public JavaRNG()

Creates a new generator seeded using Math.random.

JavaRNG

public JavaRNG(long seed)

JavaRNG

public JavaRNG(java.util.Random random)

Method Detail

next

public int next(int bits)

Specified by:

next in interface squidpony.squidmath.RandomnessSource

nextLong

public long nextLong()

Specified by:

nextLong in interface squidpony.squidmath.RandomnessSource

copy

public JavaRNG copy()

Specified by:

copy in interface squidpony.squidmath.RandomnessSource

nextInt

public int nextInt()

nextInt

public int nextInt(int bound)

nextInt

public int nextInt(int lower,
                   int upper)

Inclusive lower, exclusive upper.

Parameters:

lower - the lower bound, inclusive, can be positive or negative

upper - the upper bound, exclusive, should be positive, must be greater than lower

Returns:

a random int at least equal to lower and less than upper

nextDouble

public double nextDouble()

nextDouble

public double nextDouble(double outer)

nextFloat

public float nextFloat()

Gets a uniform random float in the range [0.0,1.0)

Returns:

a random float at least equal to 0.0 and less than 1.0

nextBoolean

public boolean nextBoolean()

Gets a random value, true or false.

Returns:

a random true or false value.

nextBytes

public void nextBytes(byte[] bytes)

Given a byte array as a parameter, this will fill the array with random bytes (modifying it in-place).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object