Package com.github.clevernucleus.dataattributes.api.util

Class RandDistribution<T>

java.lang.Object

com.github.clevernucleus.dataattributes.api.util.RandDistribution<T>

Type Parameters:

T - Input type.

public final class RandDistribution<T>
extends Object

Specialised object that takes in a type and works out weighted distributions.

Constructor Summary

Constructors

Constructor	Description
RandDistribution(T fallback)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(T object, float weight)	Adds to the internal inventory of the distributor.
T	getDistributedRandom()

Methods inherited from class java.lang.Object

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

Constructor Details

RandDistribution

public RandDistribution(T fallback)

Constructor.

Parameters:

fallback - Default value that is returned in case something fails.

Method Details

add

public void add(T object,
 float weight)

Adds to the internal inventory of the distributor.

Parameters:

object - Input object type.

weight - Input object type's weight.

getDistributedRandom

public T getDistributedRandom()

Returns:

A randomly distributed and weighted result.