util

Interface IRandomizer

All Known Implementing Classes:

Randomizer

public interface IRandomizer

Abstraction of a randomizer utility

Author:

Stephen Wong

Method Summary

Modifier and Type	Method and Description
java.awt.Rectangle	randomBounds(java.awt.Rectangle rect, java.awt.Dimension maxDim) Generates a randomly located and sized rectangle
java.lang.Object	randomChoice(java.lang.Object x, java.lang.Object y, double probX) Returns a random choice of one of two objects, x and y, where probX is the probability that x will be picked (0<=x<=1).
<T> T	randomChoiceList(T... choices) Return one of the vararg input parameters with equal probability.
java.awt.Color	randomColor() Generates a random color
java.awt.Dimension	randomDim(java.awt.Dimension maxDim) Returns a random square Dimension, whose width is maxDim.width/2<=width<=maxDim.width
double	randomDouble(double min, double max) Returns a random double greater than or equal to min and less than or equal to max.
int	randomInt(int min, int max) Returns a random integer greater than or equal to min and less than or equal to max.
java.awt.Point	randomLoc(java.awt.Dimension dim) Generates a random location point subject to the constraint that 0<=X<=maxX and 0<=Y<=maxY.
java.awt.Point	randomLoc(java.awt.Rectangle rect) Generates a random location point subject to the constraint that 0<=X<=maxX and 0<=Y<=maxY.
java.awt.Point	randomVel(java.awt.Rectangle rect) Returns a random velocity (as a Point) subject to the constraint that the absolute value of the velocity (speed) is less than maxV.

Method Detail

randomLoc

java.awt.Point randomLoc(java.awt.Rectangle rect)

Generates a random location point subject to the constraint that 0<=X<=maxX and 0<=Y<=maxY.

Parameters:

rect - the bounds for the location

Returns:

a random Point subject to the bounds

randomLoc

java.awt.Point randomLoc(java.awt.Dimension dim)

Generates a random location point subject to the constraint that 0<=X<=maxX and 0<=Y<=maxY.

Parameters:

dim - the bounds for the location

Returns:

a random Point subject to the bounds

randomInt

int randomInt(int min,
              int max)

Returns a random integer greater than or equal to min and less than or equal to max.

Parameters:

min - the min value

max - the max vale

Returns:

a random int subject to the bounds

randomDouble

double randomDouble(double min,
                    double max)

Returns a random double greater than or equal to min and less than or equal to max.

Parameters:

min - the min value

max - the max vale

Returns:

a random double subject to the bounds

randomVel

java.awt.Point randomVel(java.awt.Rectangle rect)

Returns a random velocity (as a Point) subject to the constraint that the absolute value of the velocity (speed) is less than maxV.

Parameters:

rect - the bounds for the velocity

Returns:

a random Point subject to the bounds

randomDim

java.awt.Dimension randomDim(java.awt.Dimension maxDim)

Returns a random square Dimension, whose width is maxDim.width/2<=width<=maxDim.width

Parameters:

maxDim - The bounds for the dimension

Returns:

a random Dimension subject to the bounds

randomBounds

java.awt.Rectangle randomBounds(java.awt.Rectangle rect,
                                java.awt.Dimension maxDim)

Generates a randomly located and sized rectangle

Parameters:

rect - The bounds for the location of the rectangle

maxDim - The bounds for the size of the rectangle

Returns:

a random Rectangle subject to the bounds.

randomColor

java.awt.Color randomColor()

Generates a random color

Returns:

a random Color

randomChoice

java.lang.Object randomChoice(java.lang.Object x,
                              java.lang.Object y,
                              double probX)

Returns a random choice of one of two objects, x and y, where probX is the probability that x will be picked (0<=x<=1).

Parameters:

x - The first object to choose from

y - The second object to choose from

probX - The probability of choosing the first object

Returns:

Either the first or second object as per the probability of choosing them.

randomChoiceList

<T> T randomChoiceList(T... choices)

Return one of the vararg input parameters with equal probability. The input parameters must all be of the same type and the return type will match that type.

Type Parameters:

T - The type of the input parameters and thus the return type

Parameters:

choices - vararg list of choices

Returns:

One of the input parameters