jhelp.util.math.random

Class JHelpRandom<CHOICE>

java.lang.Object

jhelp.util.math.random.JHelpRandom<CHOICE>

Type Parameters:

CHOICE - Choice type

public final class JHelpRandom<CHOICE>
extends java.lang.Object

Able to choice an object randomly.
The chance to have an object can be different than to have an& nbsp;other one.
For example if "A" have 50% chance, "B" 25%, "C" 12%, "D" 6%,"E" 3%, "F" 2%, "G" 1% and "H" 1% :
After each time you do
Choice have 50% chance to be "A",
25% chance to be "B",
12% chance to be "C",
6% chance to be "D",
3% chance to be "E",
2% chance to be "F",
1% chance to be "G" and
1% chance to be "H"

You can also see things like this, you have a set of element compose of 55 "P" and 87 "R" :
After each time you do
Choice have 55 chance of 142 to be "P" and 87 chance of 142 to be "R"

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	JHelpRandom.Limit<ELEMENT> A registered limit.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<JHelpRandom.Limit<CHOICE>>	limits Registered limits
private int	maximum Actual maximum

Constructor Summary

Constructors

Constructor and Description
JHelpRandom() Create a new instance of JHelpRandom

Method Summary

Methods

Modifier and Type	Method and Description
void	addChoice(int number, CHOICE choice) Add a choice
CHOICE	choose() Choose a value randomly
static <E extends java.lang.Enum> E	random(java.lang.Class<E> clas) Choose a value of an enum
static int	random(int limit) Give a random value between 0 (include) and given limit (exclude)
static int	random(int minimum, int maximum) Give random number inside an interval, each limit are includes
static <T> T	random(T[] array) Return an element of an array.
java.lang.String	toString() String representation Parent documentation:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

limits

private final java.util.ArrayList<JHelpRandom.Limit<CHOICE>> limits

Registered limits

maximum

private int maximum

Actual maximum

Constructor Detail

JHelpRandom

public JHelpRandom()

Create a new instance of JHelpRandom

Method Detail

random

public static final <E extends java.lang.Enum> E random(java.lang.Class<E> clas)

Choose a value of an enum

Type Parameters:

E - Enum to get a value

Parameters:

clas - Enum class

Returns:

An enum value or null if failed

random

public static final int random(int limit)

Give a random value between 0 (include) and given limit (exclude)

Parameters:

limit - Limit to respect

Returns:

Random value

random

public static final int random(int minimum,
         int maximum)

Give random number inside an interval, each limit are includes

Parameters:

minimum - Minimum value

maximum - Maximum value

Returns:

Random value

random

public static final <T> T random(T[] array)

Return an element of an array.
null is return is the array is null or empty

Type Parameters:

T - Type of array's element

Parameters:

array - Array to get one element

Returns:

Element get or null if array null or empty

addChoice

public void addChoice(int number,
             CHOICE choice)

Add a choice

Parameters:

number - Frequency of the choice (Can't be < 1)

choice - The choice

choose

public CHOICE choose()

Choose a value randomly

Returns:

Chosen value

toString

public java.lang.String toString()

String representation

Parent documentation:

Overrides:

toString in class java.lang.Object

Returns:

String representation

See Also:

Object.toString()