acm.util
Class RandomGenerator

java.lang.Object
  java.util.Random
      acm.util.RandomGenerator

public class RandomGenerator
extends Random

This class implements a simple random number generator that allows clients to generate pseudorandom integers, doubles, booleans, and colors. To use it, the first step is to declare an instance variable to hold the random generator as follows:

      private RandomGenerator rgen = RandomGenerator.getInstance();
 

By default, the RandomGenerator object is initialized to begin at an unpredictable point in a pseudorandom sequence. During debugging, it is often useful to set the internal seed for the random generator explicitly so that it always returns the same sequence. To do so, you need to invoke the setSeed method.

The RandomGenerator object returned by getInstance is shared across all classes in an application. Using this shared instance of the generator is preferable to allocating new instances of RandomGenerator. If you create several random generators in succession, they will typically generate the same sequence of values.

Constructor Summary

RandomGenerator()

Method Summary

RandomGenerator	getInstance() Returns a RandomGenerator instance that can be shared among several classes.
boolean	nextBoolean(double p) Returns a random boolean value with the specified probability.
Color	nextColor() Returns a random opaque color whose components are chosen uniformly in the 0-255 range.
double	nextDouble(double low, double high) Returns the next random real number in the specified range.
int	nextInt(int low, int high) Returns the next random integer in the specified range.

Inherited Method Summary

boolean	nextBoolean() Returns a random boolean that is true 50 percent of the time.
double	nextDouble() Returns a random double d in the range 0 ≤ d < 1.
int	nextInt(int n) Returns a random int k in the range 0 ≤ k < n.
void	setSeed(long seed) Sets a new starting point for the random generator sequence.

Constructor Detail

public RandomGenerator()

Creates a new random generator. Most clients will not use the constructor directly but will instead call getInstance to obtain a RandomGenerator object that is shared by all classes in the application.

Usage:

RandomGenerator rgen = new RandomGenerator();

Method Detail

public static RandomGenerator getInstance()

Returns a RandomGenerator instance that can be shared among several classes.

Usage:	RandomGenerator rgen = RandomGenerator.getInstance();
Returns:	A shared RandomGenerator object

public boolean nextBoolean(double p)

Returns a random boolean value with the specified probability. You can use this method to simulate an event that occurs with a particular probability. For example, you could simulate the result of tossing a coin like this:

      String coinFlip = rgen.nextBoolean(0.5) ? "HEADS" : "TAILS";
 

Usage:

if (rgen.nextBoolean(p)) . . .

Parameter:

p	A value between 0 (impossible) and 1 (certain) indicating the probability

Returns:

The value true with probability p

public Color nextColor()

Returns a random opaque color whose components are chosen uniformly in the 0-255 range.

Usage:	Color color = rgen.newColor()
Returns:	A random opaque Color

public double nextDouble(double low, double high)

Returns the next random real number in the specified range. The resulting value is always at least low but always strictly less than high. You can use this method to generate continuous random values. For example, you can set the variables x and y to specify a random point inside the unit square as follows:

      double x = rgen.nextDouble(0.0, 1.0);
      double y = rgen.nextDouble(0.0, 1.0);
 

Usage:

double d = rgen.nextDouble(low, high)

Parameters:

low	The low end of the range
high	The high end of the range

Returns:

A random double value d in the range low ≤ d < high

public int nextInt(int low, int high)

Returns the next random integer in the specified range. For example, you can generate the roll of a six-sided die by calling

      rgen.nextInt(1, 6);
 

or a random decimal digit by calling

      rgen.nextInt(0, 9);
 

Usage:

int k = rgen.nextInt(low, high)

Parameters:

low	The low end of the range
high	The high end of the range

Returns:

The next random int between low and high, inclusive