Package software.kes.kraftwerk.weights

Class MaybeWeights

java.lang.Object

software.kes.kraftwerk.weights.MaybeWeights

public final class MaybeWeights
extends java.lang.Object

A pair of weights that express the frequencies of justs vs. nothings in the context of generating Maybe values.

Either the just weight or the nothing weight can be zero; however, the sum of the weights will always be >= 1.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MaybeWeights.MaybeWeightsBuilderJusts	A partially constructed MaybeWeights, with the just weight already provided.
static class	MaybeWeights.MaybeWeightsBuilderNothings	A partially constructed MaybeWeights, with the nothing weight already provided.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	getJustWeight()
int	getNothingWeight()
BinaryWeights	getWeights()
int	hashCode()
static MaybeWeights.MaybeWeightsBuilderJusts	justs(int weight)	Partially constructs a MaybeWeights with the just weight.
static MaybeWeights	maybeWeights(int nothingWeight, int justWeight)	Creates a MaybeWeights.
static MaybeWeights.MaybeWeightsBuilderNothings	nothings(int weight)	Partially constructs a MaybeWeights with the nothing weight.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

justs

public static MaybeWeights.MaybeWeightsBuilderJusts justs(int weight)

Partially constructs a MaybeWeights with the just weight.

Parameters:

weight - the weight for justs; must be >= 0

Returns:

a MaybeWeights.MaybeWeightsBuilderJusts

nothings

public static MaybeWeights.MaybeWeightsBuilderNothings nothings(int weight)

Partially constructs a MaybeWeights with the nothing weight.

Parameters:

weight - the weight for nothings; must be >= 0

Returns:

a MaybeWeights.MaybeWeightsBuilderNothings

maybeWeights

public static MaybeWeights maybeWeights(int nothingWeight,
                                        int justWeight)

Creates a MaybeWeights. The sum of the weights for both choices must be >= 1.

Parameters:

nothingWeight - the weight for nothings; must be >= 0

justWeight - the weight for justs; must be >= 0

Returns:

a MaybeWeights

getNothingWeight

public int getNothingWeight()

getJustWeight

public int getJustWeight()

getWeights

public BinaryWeights getWeights()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object