me.lucko.helper.random

Interface VariableAmount

All Known Implementing Classes:

VariableAmount.BaseAndAddition, VariableAmount.BaseAndVariance, VariableAmount.Fixed, VariableAmount.OptionalAmount

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface VariableAmount

Represents a value which may vary randomly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VariableAmount.BaseAndAddition Represents a base amount with a random addition, the final amount will be the base amount plus a random amount between zero (inclusive) and the addition (exclusive).
static class	VariableAmount.BaseAndVariance Represents a base amount with a variance, the final amount will be the base amount plus or minus a random amount between zero (inclusive) and the variance (exclusive).
static class	VariableAmount.Fixed Represents a fixed amount, calls to VariableAmount.Fixed.getAmount(java.util.Random) will always return the same fixed value.
static class	VariableAmount.OptionalAmount Represents a variable amount which has a base and a chance of varying.

Method Summary

Modifier and Type	Method and Description
static VariableAmount	baseWithOptionalAddition(double base, double addition, double chance) Creates a new variable about which has a base and a chance to apply a random additional amount.
static VariableAmount	baseWithOptionalAddition(double base, VariableAmount addition, double chance) Creates a new variable about which has a base and a chance to apply a random additional amount.
static VariableAmount	baseWithOptionalVariance(double base, double variance, double chance) Creates a new variable about which has a base and a chance to apply a random variance.
static VariableAmount	baseWithOptionalVariance(double base, VariableAmount variance, double chance) Creates a new variable about which has a base and a chance to apply a random variance.
static VariableAmount	baseWithRandomAddition(double base, double addition) Creates a new variable amount which has a base and an additional amount.
static VariableAmount	baseWithRandomAddition(double base, VariableAmount addition) Creates a new variable amount which has a base and an additional amount.
static VariableAmount	baseWithVariance(double base, double variance) Creates a new variable about which has a base and variance.
static VariableAmount	baseWithVariance(double base, VariableAmount variance) Creates a new variable about which has a base and variance.
static VariableAmount	fixed(double value) Creates a new 'fixed' variable amount, calls to getAmount(java.util.Random) will always return the fixed value.
default double	getAmount() Gets an instance of the variable amount using the thread's ThreadLocalRandom instance.
double	getAmount(Random random) Gets an instance of the variable amount depending on the given random object.
default int	getFlooredAmount() Gets the amount as if from getAmount() but floored to the nearest integer equivalent.
default int	getFlooredAmount(Random random) Gets the amount as if from getAmount(Random) but floored to the nearest integer equivalent.
static VariableAmount	range(double min, double max) Creates a new variable amount which return values between the given min (inclusive) and max (exclusive).

Method Detail

fixed

@Nonnull
static VariableAmount fixed(double value)

Creates a new 'fixed' variable amount, calls to getAmount(java.util.Random) will always return the fixed value.

Parameters:

value - The fixed value

Returns:

A variable amount representation

range

@Nonnull
static VariableAmount range(double min,
                                     double max)

Creates a new variable amount which return values between the given min (inclusive) and max (exclusive).

Parameters:

min - The minimum of the range (inclusive)

max - The maximum of the range (exclusive)

Returns:

A variable amount representation

baseWithVariance

@Nonnull
static VariableAmount baseWithVariance(double base,
                                                double variance)

Creates a new variable about which has a base and variance. The final amount will be the base amount plus or minus a random amount between zero (inclusive) and the variance (exclusive).

Parameters:

base - The base value

variance - The variance

Returns:

A variable amount representation

baseWithVariance

@Nonnull
static VariableAmount baseWithVariance(double base,
                                                @Nonnull
                                                VariableAmount variance)

Creates a new variable about which has a base and variance. The final amount will be the base amount plus or minus a random amount between zero (inclusive) and the variance (exclusive).

Parameters:

base - The base value

variance - The variance

Returns:

A variable amount representation

baseWithRandomAddition

@Nonnull
static VariableAmount baseWithRandomAddition(double base,
                                                      double addition)

Creates a new variable amount which has a base and an additional amount. The final amount will be the base amount plus a random amount between zero (inclusive) and the additional amount (exclusive).

Parameters:

base - The base value

addition - The additional amount

Returns:

A variable amount representation

baseWithRandomAddition

@Nonnull
static VariableAmount baseWithRandomAddition(double base,
                                                      @Nonnull
                                                      VariableAmount addition)

Creates a new variable amount which has a base and an additional amount. The final amount will be the base amount plus a random amount between zero (inclusive) and the additional amount (exclusive).

Parameters:

base - The base value

addition - The additional amount

Returns:

A variable amount representation

baseWithOptionalVariance

@Nonnull
static VariableAmount baseWithOptionalVariance(double base,
                                                        double variance,
                                                        double chance)

Creates a new variable about which has a base and a chance to apply a random variance. The chance should be between zero and one with a chance of one signifying that the variance will always be applied. If the chance succeeds then the final amount will be the base amount plus or minus a random amount between zero (inclusive) and the variance (exclusive). If the chance fails then the final amount will just be the base value.

Parameters:

base - The base value

variance - The variance

chance - The chance to apply the variance

Returns:

A variable amount representation

baseWithOptionalVariance

@Nonnull
static VariableAmount baseWithOptionalVariance(double base,
                                                        @Nonnull
                                                        VariableAmount variance,
                                                        double chance)

Creates a new variable about which has a base and a chance to apply a random variance. The chance should be between zero and one with a chance of one signifying that the variance will always be applied. If the chance succeeds then the final amount will be the base amount plus or minus a random amount between zero (inclusive) and the variance (exclusive). If the chance fails then the final amount will just be the base value.

Parameters:

base - The base value

variance - The variance

chance - The chance to apply the variance

Returns:

A variable amount representation

baseWithOptionalAddition

@Nonnull
static VariableAmount baseWithOptionalAddition(double base,
                                                        double addition,
                                                        double chance)

Creates a new variable about which has a base and a chance to apply a random additional amount. The chance should be between zero and one with a chance of one signifying that the additional amount will always be applied. If the chance succeeds then the final amount will be the base amount plus a random amount between zero (inclusive) and the additional amount (exclusive). If the chance fails then the final amount will just be the base value.

Parameters:

base - The base value

addition - The additional amount

chance - The chance to apply the additional amount

Returns:

A variable amount representation

baseWithOptionalAddition

@Nonnull
static VariableAmount baseWithOptionalAddition(double base,
                                                        @Nonnull
                                                        VariableAmount addition,
                                                        double chance)

Creates a new variable about which has a base and a chance to apply a random additional amount. The chance should be between zero and one with a chance of one signifying that the additional amount will always be applied. If the chance succeeds then the final amount will be the base amount plus a random amount between zero (inclusive) and the additional amount (exclusive). If the chance fails then the final amount will just be the base value.

Parameters:

base - The base value

addition - The additional amount

chance - The chance to apply the additional amount

Returns:

A variable amount representation

getAmount

double getAmount(@Nonnull
                 Random random)

Gets an instance of the variable amount depending on the given random object.

Parameters:

random - The random object

Returns:

The amount

getAmount

default double getAmount()

Gets an instance of the variable amount using the thread's ThreadLocalRandom instance.

Returns:

The amount

getFlooredAmount

default int getFlooredAmount(@Nonnull
                             Random random)

Gets the amount as if from getAmount(Random) but floored to the nearest integer equivalent.

Parameters:

random - The random object

Returns:

The floored amount

getFlooredAmount

default int getFlooredAmount()

Gets the amount as if from getAmount() but floored to the nearest integer equivalent.

Returns:

The floored amount