com.sk89q.worldedit.util

Class WeightedChoice<T>

java.lang.Object

com.sk89q.worldedit.util.WeightedChoice<T>

Type Parameters:

T - the type of choice

public class WeightedChoice<T>
extends Object

Returns the best choice given a weighting function and a target weight.

A function must be supplied that returns a numeric score for each choice. The function can return null to mean that the choice should not be considered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WeightedChoice.Choice<T> A tuple of choice and score.

Constructor Summary

Constructors

Constructor and Description
WeightedChoice(com.google.common.base.Function<T,? extends Number> function, double target) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	consider(T object) Consider the given object.
com.google.common.base.Optional<WeightedChoice.Choice<T>>	getChoice() Get the best choice.

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedChoice

public WeightedChoice(com.google.common.base.Function<T,? extends Number> function,
                      double target)

Create a new instance.

Parameters:

function - a function that assigns a score for each choice

target - the target score that the best choice should be closest to

Method Detail

consider

public void consider(T object)

Consider the given object.

Parameters:

object - the choice

getChoice

public com.google.common.base.Optional<WeightedChoice.Choice<T>> getChoice()

Get the best choice.

Returns:

the best choice