public class Char2DoubleLinkedOpenHashMap extends AbstractChar2DoubleSortedMap implements Serializable, Cloneable, Hash
Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.
Note that clear() does not modify the hash table size. Rather, a
family of trimming methods lets you control the size of
the table; this is particularly useful if you reuse instances of this class.
Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the map does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.
This class implements the interface of a sorted map, so to allow easy access
of the iteration order: for instance, you can get the first key in iteration
order with firstKey() without having to create an iterator; however,
this class partially violates the SortedMap contract
because all submap methods throw an exception and comparator()
returns always null.
Additional methods, such as getAndMoveToFirst(), make it easy to use
instances of this class as a cache (e.g., with LRU policy).
The iterators provided by the views of this class using are type-specific
list iterators, and can be started at any
element which is a key of the map, or a
NoSuchElementException exception will be thrown. If, however, the
provided element is not the first or last key in the map, the first access to
the list index will require linear time, as in the worst case the entire key
set must be scanned in iteration order to retrieve the positional index of
the starting key. If you use just the methods of a type-specific
BidirectionalIterator, however, all operations
will be performed in constant time.
Hash,
HashCommon,
Serialized FormAbstractChar2DoubleMap.BasicEntryHash.Strategy<K>Char2DoubleSortedMap.FastSortedEntrySetChar2DoubleMap.Entry, Char2DoubleMap.FastEntrySetDEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
Char2DoubleLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries and
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Char2DoubleLinkedOpenHashMap(char[] k,
double[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load
factor using the elements of two parallel arrays. |
Char2DoubleLinkedOpenHashMap(char[] k,
double[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Char2DoubleLinkedOpenHashMap(Char2DoubleMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given type-specific one. |
Char2DoubleLinkedOpenHashMap(Char2DoubleMap m,
float f)
Creates a new hash map copying a given type-specific one.
|
Char2DoubleLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load
factor. |
Char2DoubleLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Char2DoubleLinkedOpenHashMap(Map<? extends Character,? extends Double> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given one. |
Char2DoubleLinkedOpenHashMap(Map<? extends Character,? extends Double> m,
float f)
Creates a new hash map copying a given one.
|
| Modifier and Type | Method and Description |
|---|---|
double |
addTo(char k,
double incr)
Adds an increment to value currently associated with a key.
|
Char2DoubleSortedMap.FastSortedEntrySet |
char2DoubleEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this
map.
|
void |
clear()
Removes all of the mappings from this map (optional operation).
|
Char2DoubleLinkedOpenHashMap |
clone()
Returns a deep copy of this map.
|
CharComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it
uses its keys' natural ordering.
|
double |
compute(char k,
BiFunction<? super Character,? super Double,? extends Double> remappingFunction)
Attempts to compute a mapping for the specified key and its current
mapped value (or
null if there is no current mapping). |
double |
computeIfAbsent(char k,
IntToDoubleFunction mappingFunction)
If the specified key is not already associated with a value, attempts to
compute its value using the given mapping function and enters it into
this map.
|
double |
computeIfAbsentNullable(char k,
IntFunction<? extends Double> mappingFunction)
If the specified key is not already associated with a value, attempts to
compute its value using the given mapping function and enters it into
this map unless it is
null. |
double |
computeIfPresent(char k,
BiFunction<? super Character,? super Double,? extends Double> remappingFunction)
If the value for the specified key is present, attempts to compute a new
mapping given the key and its current mapped value.
|
boolean |
containsKey(char k)
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(double v)
Returns
true if this map maps one or more keys to the specified
value. |
char |
firstCharKey()
Returns the first key of this map in iteration order.
|
double |
get(char k)
Returns the value to which the given key is mapped.
|
double |
getAndMoveToFirst(char k)
Returns the value to which the given key is mapped; if the key is
present, it is moved to the first position of the iteration order.
|
double |
getAndMoveToLast(char k)
Returns the value to which the given key is mapped; if the key is
present, it is moved to the last position of the iteration order.
|
double |
getOrDefault(char k,
double defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this map contains no mapping for the key. |
int |
hashCode()
Returns a hash code for this map.
|
Char2DoubleSortedMap |
headMap(char to)
Returns a view of the portion of this sorted map whose keys are strictly
less than
toKey. |
boolean |
isEmpty()
Returns true if this map contains no key-value mappings.
|
CharSortedSet |
keySet()
Returns a type-specific-set view of the keys of this map.
|
char |
lastCharKey()
Returns the last key of this map in iteration order.
|
double |
merge(char k,
double v,
BiFunction<? super Double,? super Double,? extends Double> remappingFunction)
If the specified key is not already associated with a value, associates
it with the given
value. |
double |
put(char k,
double v)
Adds a pair to the map (optional operation).
|
void |
putAll(Map<? extends Character,? extends Double> m)
Copies all of the mappings from the specified map to this map
(optional operation).
|
double |
putAndMoveToFirst(char k,
double v)
Adds a pair to the map; if the key is already present, it is moved to the
first position of the iteration order.
|
double |
putAndMoveToLast(char k,
double v)
Adds a pair to the map; if the key is already present, it is moved to the
last position of the iteration order.
|
double |
putIfAbsent(char k,
double v)
If the specified key is not already associated with a value, associates
it with the given value and returns the default return value, else returns the current value.
|
double |
remove(char k)
Removes the mapping with the given key (optional operation).
|
boolean |
remove(char k,
double v)
Removes the entry for the specified key only if it is currently mapped to
the specified value.
|
double |
removeFirstDouble()
Removes the mapping associated with the first key in iteration order.
|
double |
removeLastDouble()
Removes the mapping associated with the last key in iteration order.
|
double |
replace(char k,
double v)
Replaces the entry for the specified key only if it is currently mapped
to some value.
|
boolean |
replace(char k,
double oldValue,
double v)
Replaces the entry for the specified key only if currently mapped to the
specified value.
|
int |
size()
Returns the number of key/value mappings in this map.
|
Char2DoubleSortedMap |
subMap(char from,
char to)
Returns a view of the portion of this sorted map whose keys range from
fromKey, inclusive, to toKey, exclusive. |
Char2DoubleSortedMap |
tailMap(char from)
Returns a view of the portion of this sorted map whose keys are greater
than or equal to
fromKey. |
boolean |
trim()
Rehashes the map, making the table as small as possible.
|
boolean |
trim(int n)
Rehashes this map if the table is too large.
|
DoubleCollection |
values()
Returns a type-specific-set view of the values of this map.
|
equals, toStringdefaultReturnValue, defaultReturnValueentrySet, firstKey, headMap, lastKey, subMap, tailMapcompute, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replaceapplyAsDoubleequals, forEach, replaceAllpublic Char2DoubleLinkedOpenHashMap(int expected,
float f)
The actual table size will be the least power of two greater than
expected/f.
expected - the expected number of elements in the hash map.f - the load factor.public Char2DoubleLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR as load
factor.expected - the expected number of elements in the hash map.public Char2DoubleLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE entries and
Hash.DEFAULT_LOAD_FACTOR as load factor.public Char2DoubleLinkedOpenHashMap(Map<? extends Character,? extends Double> m, float f)
m - a Map to be copied into the new hash map.f - the load factor.public Char2DoubleLinkedOpenHashMap(Map<? extends Character,? extends Double> m)
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given one.m - a Map to be copied into the new hash map.public Char2DoubleLinkedOpenHashMap(Char2DoubleMap m, float f)
m - a type-specific map to be copied into the new hash map.f - the load factor.public Char2DoubleLinkedOpenHashMap(Char2DoubleMap m)
Hash.DEFAULT_LOAD_FACTOR as load
factor copying a given type-specific one.m - a type-specific map to be copied into the new hash map.public Char2DoubleLinkedOpenHashMap(char[] k,
double[] v,
float f)
k - the array of keys of the new hash map.v - the array of corresponding values in the new hash map.f - the load factor.IllegalArgumentException - if k and v have different lengths.public Char2DoubleLinkedOpenHashMap(char[] k,
double[] v)
Hash.DEFAULT_LOAD_FACTOR as load
factor using the elements of two parallel arrays.k - the array of keys of the new hash map.v - the array of corresponding values in the new hash map.IllegalArgumentException - if k and v have different lengths.public void putAll(Map<? extends Character,? extends Double> m)
AbstractChar2DoubleMapput(k, v) on this map once
for each mapping from key k to value v in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.public double put(char k,
double v)
Char2DoubleFunctionput in interface Char2DoubleFunctionk - the key.v - the value.Function.put(Object,Object)public double addTo(char k,
double incr)
Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.
k - the key.incr - the increment.public double remove(char k)
Char2DoubleFunctionremove in interface Char2DoubleFunctionk - the key.Function.remove(Object)public double removeFirstDouble()
NoSuchElementException - is this map is empty.public double removeLastDouble()
NoSuchElementException - is this map is empty.public double getAndMoveToFirst(char k)
k - the key.public double getAndMoveToLast(char k)
k - the key.public double putAndMoveToFirst(char k,
double v)
k - the key.v - the value.public double putAndMoveToLast(char k,
double v)
k - the key.v - the value.public double get(char k)
Char2DoubleFunctionget in interface Char2DoubleFunctionk - the key.Function.get(Object)public boolean containsKey(char k)
Char2DoubleMapcontainsKey in interface Char2DoubleFunctioncontainsKey in interface Char2DoubleMapcontainsKey in class AbstractChar2DoubleMapk - the key.key.Map.containsKey(Object)public boolean containsValue(double v)
Char2DoubleMaptrue if this map maps one or more keys to the specified
value.containsValue in interface Char2DoubleMapcontainsValue in class AbstractChar2DoubleMapMap.containsValue(Object)public double getOrDefault(char k,
double defaultValue)
defaultValue if this map contains no mapping for the key.getOrDefault in interface Char2DoubleMapk - the key.defaultValue - the default mapping of the key.defaultValue if this map contains no mapping for the key.Map.getOrDefault(Object, Object)public double putIfAbsent(char k,
double v)
putIfAbsent in interface Char2DoubleMapk - key with which the specified value is to be associated.v - value to be associated with the specified key.Map.putIfAbsent(Object, Object)public boolean remove(char k,
double v)
remove in interface Char2DoubleMapk - key with which the specified value is associated.v - value expected to be associated with the specified key.true if the value was removed.Map.remove(Object, Object)public boolean replace(char k,
double oldValue,
double v)
replace in interface Char2DoubleMapk - key with which the specified value is associated.oldValue - value expected to be associated with the specified key.v - value to be associated with the specified key.true if the value was replaced.Map.replace(Object, Object, Object)public double replace(char k,
double v)
replace in interface Char2DoubleMapk - key with which the specified value is associated.v - value to be associated with the specified key.Map.replace(Object, Object)public double computeIfAbsent(char k,
IntToDoubleFunction mappingFunction)
Note that contrarily to the default
computeIfAbsent(), it is not possible to not add a value for a given
key, since the mappingFunction cannot return null. If
such a behavior is needed, please use the corresponding nullable
version.
computeIfAbsent in interface Char2DoubleMapk - key with which the specified value is to be associated.mappingFunction - the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)public double computeIfAbsentNullable(char k,
IntFunction<? extends Double> mappingFunction)
null.
Note that this version of
computeIfAbsent() should be used only if you plan to return null
in the mapping function.
computeIfAbsentNullable in interface Char2DoubleMapk - key with which the specified value is to be associated.mappingFunction - the function to compute a value.null.Map.computeIfAbsent(Object, java.util.function.Function)public double computeIfPresent(char k,
BiFunction<? super Character,? super Double,? extends Double> remappingFunction)
computeIfPresent in interface Char2DoubleMapk - key with which the specified value is to be associated.remappingFunction - the function to compute a value.Map.computeIfPresent(Object,
java.util.function.BiFunction)public double compute(char k,
BiFunction<? super Character,? super Double,? extends Double> remappingFunction)
null if there is no current mapping).
If the function returns null, the mapping is removed (or remains
absent if initially absent). If the function itself throws an (unchecked)
exception, the exception is rethrown, and the current mapping is left
unchanged.
compute in interface Char2DoubleMapk - key with which the specified value is to be associated.remappingFunction - the function to compute a value.Map.compute(Object, java.util.function.BiFunction)public double merge(char k,
double v,
BiFunction<? super Double,? super Double,? extends Double> remappingFunction)
value. Otherwise, replaces the associated value
with the results of the given remapping function, or removes if the
result is null.merge in interface Char2DoubleMapk - key with which the resulting value is to be associated.v - the value to be merged with the existing value associated with
the key or, if no existing value is associated with the key,
to be associated with the key.remappingFunction - the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)public void clear()
Char2DoubleMapclear in interface Char2DoubleMapclear in interface Map<Character,Double>Map.clear()public int size()
Char2DoubleMapInteger.MAX_VALUE elements, returns
Integer.MAX_VALUE.public boolean isEmpty()
java.util.Mappublic char firstCharKey()
firstCharKey in interface Char2DoubleSortedMapSortedMap.firstKey()public char lastCharKey()
lastCharKey in interface Char2DoubleSortedMapSortedMap.lastKey()public Char2DoubleSortedMap tailMap(char from)
fromKey.
Note that this specification strengthens the one given in
SortedMap.tailMap(Object).
This implementation just throws an UnsupportedOperationException.
tailMap in interface Char2DoubleSortedMapSortedMap.tailMap(Object)public Char2DoubleSortedMap headMap(char to)
toKey.
Note that this specification strengthens the one given in
SortedMap.headMap(Object).
This implementation just throws an UnsupportedOperationException.
headMap in interface Char2DoubleSortedMapSortedMap.headMap(Object)public Char2DoubleSortedMap subMap(char from, char to)
fromKey, inclusive, to toKey, exclusive.
Note that this specification strengthens the one given in
SortedMap.subMap(Object,Object).
This implementation just throws an UnsupportedOperationException.
subMap in interface Char2DoubleSortedMapSortedMap.subMap(Object,Object)public CharComparator comparator()
Note that this specification strengthens the one given in
SortedMap.comparator().
This implementation just returns null.
comparator in interface Char2DoubleSortedMapcomparator in interface SortedMap<Character,Double>null if this map uses the natural ordering
of its keysSortedMap.comparator()public Char2DoubleSortedMap.FastSortedEntrySet char2DoubleEntrySet()
Char2DoubleSortedMapNote that this specification strengthens the one given in the corresponding type-specific unsorted map.
char2DoubleEntrySet in interface Char2DoubleMapchar2DoubleEntrySet in interface Char2DoubleSortedMapChar2DoubleSortedMap.entrySet()public CharSortedSet keySet()
AbstractChar2DoubleSortedMap
The view is backed by the set returned by Map.entrySet(). Note
that no attempt is made at caching the result of this method, as
this would require adding some attributes that lightweight
implementations would not need. Subclasses may easily override this
policy by calling this method and caching the result, but implementors
are encouraged to write more efficient ad-hoc implementations.
The view is backed by the sorted set returned by
Map.entrySet(). Note that no attempt is made at
caching the result of this method, as this would require adding some
attributes that lightweight implementations would not need. Subclasses
may easily override this policy by calling this method and caching the
result, but implementors are encouraged to write more efficient ad-hoc
implementations.
keySet in interface Char2DoubleMapkeySet in interface Char2DoubleSortedMapkeySet in interface Map<Character,Double>keySet in interface SortedMap<Character,Double>keySet in class AbstractChar2DoubleSortedMapMap.keySet()public DoubleCollection values()
AbstractChar2DoubleSortedMap
The view is backed by the set returned by Map.entrySet(). Note
that no attempt is made at caching the result of this method, as
this would require adding some attributes that lightweight
implementations would not need. Subclasses may easily override this
policy by calling this method and caching the result, but implementors
are encouraged to write more efficient ad-hoc implementations.
The view is backed by the sorted set returned by
Map.entrySet(). Note that no attempt is made at
caching the result of this method, as this would require adding some
attributes that lightweight implementations would not need. Subclasses
may easily override this policy by calling this method and caching the
result, but implementors are encouraged to write more efficient ad-hoc
implementations.
values in interface Char2DoubleMapvalues in interface Char2DoubleSortedMapvalues in interface Map<Character,Double>values in interface SortedMap<Character,Double>values in class AbstractChar2DoubleSortedMapMap.values()public boolean trim()
This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.
If the table size is already the minimum possible, this method does nothing.
trim(int)public boolean trim(int n)
Let N be the smallest table size that can hold
max(n, entries, still satisfying the load
factor. If the current table size is smaller than or equal to
N, this method does nothing. Otherwise, it rehashes this map
in a table of size N.
size())
This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.
n - the threshold for the trimming.trim()public Char2DoubleLinkedOpenHashMap clone()
This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.
public int hashCode()
equals() is not overriden, it is important that the value
returned by this method is the same value as the one returned by the
overriden method.hashCode in interface Map<Character,Double>hashCode in class AbstractChar2DoubleMapObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)