org.achtern.AchternEngine.core.util.random

Class RandomItemSelector

java.lang.Object

org.achtern.AchternEngine.core.util.random.RandomItemSelector

public class RandomItemSelector
extends Object

This is a helper class for selecting random items from lists, etc.

Constructor Summary

Constructors

Constructor and Description
RandomItemSelector()

Method Summary

Modifier and Type	Method and Description
static <T> T	getRandom(List<T> items) Returns a random item from the given list
static <T> T	getRandom(Map<?,T> items) Returns are random value from the given map
static <T> T	getSpecificRandom(Map<T,Float> items) Wrapper for getSpecificRandom(java.util.Map, int).
static <T> T	getSpecificRandom(Map<T,Float> items, int resolution) This method accepts a map of items and a float value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomItemSelector

public RandomItemSelector()

Method Detail

getRandom

public static <T> T getRandom(List<T> items)

Returns a random item from the given list

Type Parameters:

T - type of the items

Parameters:

items - source

Returns:

random item from the given items

getRandom

public static <T> T getRandom(Map<?,T> items)

Returns are random value from the given map

Type Parameters:

T - type of the items (values)

Parameters:

items - source

Returns:

random item (value) from the given items

getSpecificRandom

public static <T> T getSpecificRandom(Map<T,Float> items)

Wrapper for getSpecificRandom(java.util.Map, int). Uses default resolution of 100, this means the lowest possible percentage for each item is 1% or 0.01

Type Parameters:

T - type of the items

Parameters:

items - items and their probability

Returns:

random item from the given items

See Also:

getSpecificRandom(java.util.Map, int)

getSpecificRandom

public static <T> T getSpecificRandom(Map<T,Float> items,
                                      int resolution)

This method accepts a map of items and a float value. This float value represents a probability. This is very similar to getRandom(java.util.List), but now you can define a probability for each item. This float value should be in the interval of [0,1], where 0 is 0% and 1 is 100% The resolution parameter defines how fine the percentage can be. For example: with a resolution of 100, the lowest percentage can be 1% and with 100 0.1% and so forth. NOTE: This method works by creating a List of the size of the resolution. Therefor large resolutions will create large lists on the heap!

Type Parameters:

T - type of the items

Parameters:

items - items and their probability

resolution - resolution the random getting

Returns:

random item from the given items