com.runehive.util.chance.Chance< T > Class Template Reference

Handles a random chance. More...

Inheritance diagram for com.runehive.util.chance.Chance< T >:

Classes
enum	ChanceType

Public Member Functions
final void	add (ChanceType type, T t)
	Adds a new WeightedObject to the #object list.
final void	add (double weight, T t)
	Adds a new WeightedObject to the #object list.
	Chance ()
	Creates a new instance of the class.
	Chance (List< WeightedObject< T > > objects)
	Creates a new instance of the class.
T	next ()
	Generates a WeightedObject.
WeightedObject< T >	next (double boost)
	Generates a WeightedObject.
Item[]	toItemArray ()
String	toString ()

Private Attributes
final List< WeightedObject< T > >	objects
	The list of weighted object.
double	sum
	The sum of the weights.

Detailed Description

Handles a random chance.

Parameters

<T>	- The representation type.

Author

Michael | Chex

Definition at line 14 of file Chance.java.

Constructor & Destructor Documentation

Chance() [1/2]

com.runehive.util.chance.Chance< T >.Chance

(

List< WeightedObject< T > >

objects

)

Creates a new instance of the class.

Definition at line 41 of file Chance.java.

                                                   {
        this.objects = objects;
        sum = objects.stream().mapToDouble(WeightedObject::getWeight).sum();
        objects.sort((first, second) -> (int) Math.signum(second.getWeight() - first.getWeight()));
    }

References com.runehive.util.chance.WeightedObject< T >.getWeight(), objects, and sum.

Here is the call graph for this function:

Chance() [2/2]

com.runehive.util.chance.Chance< T >.Chance

(

)

Creates a new instance of the class.

Definition at line 48 of file Chance.java.

                    {
        this.objects = new LinkedList<>();
        sum = 0;
    }

References sum.

Member Function Documentation

add() [1/2]

final void com.runehive.util.chance.Chance< T >.add	(	ChanceType	type,
		T	t )

Adds a new WeightedObject to the #object list.

Definition at line 61 of file Chance.java.

                                                {
        add(type.getWeight(), t);
    }

References add(), and com.runehive.util.chance.Chance< T >.ChanceType.getWeight().

Here is the call graph for this function:

add() [2/2]

final void com.runehive.util.chance.Chance< T >.add	(	double	weight,
		T	t )

Adds a new WeightedObject to the #object list.

Definition at line 54 of file Chance.java.

                                              {
        objects.add(new WeightedChance<>(weight, t));
        sum += weight;
        objects.sort((first, second) -> (int) Math.signum(second.getWeight() - first.getWeight()));
    }

References objects, and sum.

Referenced by add().

Here is the caller graph for this function:

next() [1/2]

T com.runehive.util.chance.Chance< T >.next

(

)

Generates a WeightedObject.

Definition at line 66 of file Chance.java.

                    {
        double rnd = Math.random() * sum;
        double hit = 0;
 
        for (WeightedObject<T> obj : objects) {
            hit += obj.getWeight();
 
            if (hit >= rnd) {
                return obj.get();
            }
        }
 
        throw new AssertionError("The random number [" + rnd + "] is too large!");
    }

References objects, and sum.

next() [2/2]

WeightedObject< T > com.runehive.util.chance.Chance< T >.next

(

double

boost

)

Generates a WeightedObject.

Definition at line 82 of file Chance.java.

                                                {
        if (boost <= 0 || boost > 1) {
            throw new IllegalArgumentException("Boost is outside of the domain: (0, 1]");
        }
 
        double rnd = Math.random() * sum;
        double hit = 0;
 
        for (WeightedObject<T> obj : objects) {
            hit += obj.getWeight() + boost;
 
            if ((int) (hit * (1 + boost)) >= (int) rnd) {
                return obj;
            }
        }
 
        throw new AssertionError("The random number [" + rnd + "] is too large!");
    }

References objects, and sum.

toItemArray()

Item[] com.runehive.util.chance.Chance< T >.toItemArray

(

)

Definition at line 101 of file Chance.java.

                                {
        int count = 0;
        Item[] array = new Item[objects.size()];
        for (WeightedObject<T> obj : objects) {
            array[count] = (Item) obj.get();
            count++;
        }
        return array;
    }

References objects.

toString()

String com.runehive.util.chance.Chance< T >.toString

(

)

Definition at line 112 of file Chance.java.

                             {
        return objects.toString();
    }

References objects.

Member Data Documentation

objects

final List<WeightedObject<T> > com.runehive.util.chance.Chance< T >.objects

private

The list of weighted object.

Definition at line 35 of file Chance.java.

Referenced by add(), Chance(), next(), next(), toItemArray(), and toString().

sum

double com.runehive.util.chance.Chance< T >.sum

private

The sum of the weights.

Definition at line 38 of file Chance.java.

Referenced by add(), Chance(), Chance(), next(), and next().

---

The documentation for this class was generated from the following file:

• java/com/runehive/util/chance/Chance.java