Package megamek.common.util.weightedMaps

Class WeightedDoubleMap<T>

java.lang.Object

java.util.AbstractMap<Double,T>

java.util.TreeMap<Double,T>

megamek.common.util.weightedMaps.AbstractWeightedMap<Double,T>

megamek.common.util.weightedMaps.WeightedDoubleMap<T>

Type Parameters:

T - The values in the table

All Implemented Interfaces:

Serializable, Cloneable, Map<Double,T>, NavigableMap<Double,T>, SequencedMap<Double,T>, SortedMap<Double,T>

public class WeightedDoubleMap<T>
extends AbstractWeightedMap<Double,T>

Constructs a table of values each with a double weight that makes them more or less likely to be selected at random

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
WeightedDoubleMap()

Method Summary

Modifier and Type	Method	Description
T	add(Double weight, T value)
static <T> WeightedDoubleMap<T>	of(T t1, double w1)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5, T t6, double w6)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5, T t6, double w6, T t7, double w7)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5, T t6, double w6, T t7, double w7, T t8, double w8)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5, T t6, double w6, T t7, double w7, T t8, double w8, T t9, double w9)
static <T> WeightedDoubleMap<T>	of(T t1, double w1, T t2, double w2, T t3, double w3, T t4, double w4, T t5, double w5, T t6, double w6, T t7, double w7, T t8, double w8, T t9, double w9, T t10, double w10)
T	randomItem()
Optional<T>	randomOptionalItem(T[] except)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class megamek.common.util.weightedMaps.AbstractWeightedMap

randomItem, randomOptionalItem

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, merge, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, putFirst, putIfAbsent, putLast, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, getOrDefault, hashCode, isEmpty, remove

Methods inherited from interface java.util.NavigableMap

reversed

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Constructor Details

WeightedDoubleMap

public WeightedDoubleMap()

Method Details

add

@Nullable
public T add(Double weight,
 T value)

Specified by:

add in class AbstractWeightedMap<Double,T>

Parameters:

weight - the weight to put the item at

value - the value of the item

Returns:

the return value of TreeMap#Put, or null if the value is not added to the map

randomItem

@Nullable
public T randomItem()

Specified by:

randomItem in class AbstractWeightedMap<Double,T>

Returns:

a random item from the weighted map, or null if it is empty

randomOptionalItem

@Deprecated(since="0.51.0",
            forRemoval=true)
public Optional<T> randomOptionalItem(T[] except)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

an optional random item from the weighted map, or Optional empty if it is empty

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5,
 T t6,
 double w6)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5,
 T t6,
 double w6,
 T t7,
 double w7)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5,
 T t6,
 double w6,
 T t7,
 double w7,
 T t8,
 double w8)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5,
 T t6,
 double w6,
 T t7,
 double w7,
 T t8,
 double w8,
 T t9,
 double w9)

of

public static <T> WeightedDoubleMap<T> of(T t1,
 double w1,
 T t2,
 double w2,
 T t3,
 double w3,
 T t4,
 double w4,
 T t5,
 double w5,
 T t6,
 double w6,
 T t7,
 double w7,
 T t8,
 double w8,
 T t9,
 double w9,
 T t10,
 double w10)