public class Char2ReferenceLinkedOpenHashMap<V> extends AbstractChar2ReferenceSortedMap<V> 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, 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 set 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 AbstractChar2ReferenceSortedMap.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 set, 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 FormAbstractChar2ReferenceMap.BasicEntry<V>Hash.Strategy<K>Char2ReferenceSortedMap.FastSortedEntrySet<V>Char2ReferenceMap.Entry<V>, Char2ReferenceMap.FastEntrySet<V>DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
Char2ReferenceLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Char2ReferenceLinkedOpenHashMap(char[] k,
V[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Char2ReferenceLinkedOpenHashMap(char[] k,
V[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Char2ReferenceLinkedOpenHashMap(Char2ReferenceMap<V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Char2ReferenceLinkedOpenHashMap(Char2ReferenceMap<V> m,
float f)
Creates a new hash map copying a given type-specific one.
|
Char2ReferenceLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Char2ReferenceLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Char2ReferenceLinkedOpenHashMap(Map<? extends Character,? extends V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Char2ReferenceLinkedOpenHashMap(Map<? extends Character,? extends V> m,
float f)
Creates a new hash map copying a given one.
|
| Modifier and Type | Method and Description |
|---|---|
Char2ReferenceSortedMap.FastSortedEntrySet<V> |
char2ReferenceEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Char2ReferenceLinkedOpenHashMap<V> |
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.
|
boolean |
containsKey(char k)
Checks whether the given value is contained in
AbstractChar2ReferenceMap.keySet(). |
boolean |
containsValue(Object v)
Checks whether the given value is contained in
AbstractChar2ReferenceMap.values(). |
char |
firstCharKey()
Returns the first key of this map in iteration order.
|
V |
get(char k)
Returns the value to which the given key is mapped.
|
V |
get(Character ok) |
V |
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.
|
V |
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.
|
int |
growthFactor()
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled when they are too full. |
void |
growthFactor(int growthFactor)
Deprecated.
Since
fastutil 6.1.0, hash tables are doubled when they are too full. |
int |
hashCode()
Returns a hash code for this map.
|
Char2ReferenceSortedMap<V> |
headMap(char to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey. |
boolean |
isEmpty() |
CharSortedSet |
keySet()
Returns a type-specific-sorted-set view of the keys of this map.
|
char |
lastCharKey()
Returns the last key of this map in iteration order.
|
V |
put(Character ok,
V ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
V |
put(char k,
V v)
Adds a pair to the map.
|
void |
putAll(Map<? extends Character,? extends V> m)
Puts all pairs in the given map.
|
V |
putAndMoveToFirst(char k,
V v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
V |
putAndMoveToLast(char k,
V v)
Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.
|
boolean |
rehash()
Deprecated.
A no-op.
|
V |
remove(char k)
Removes the mapping with the given key.
|
V |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
V |
removeFirst()
Removes the mapping associated with the first key in iteration order.
|
V |
removeLast()
Removes the mapping associated with the last key in iteration order.
|
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
Char2ReferenceSortedMap<V> |
subMap(char from,
char to)
Returns a view of the portion of this sorted map whose keys range from
fromKey, inclusive, to toKey, exclusive. |
Char2ReferenceSortedMap<V> |
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.
|
ReferenceCollection<V> |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet, firstKey, headMap, lastKey, subMap, tailMapequals, toStringcontainsKey, defaultReturnValue, defaultReturnValue, getdefaultReturnValue, defaultReturnValuecontainsKey, getcompute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, get, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic Char2ReferenceLinkedOpenHashMap(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 set.f - the load factor.public Char2ReferenceLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR as load factor.expected - the expected number of elements in the hash map.public Char2ReferenceLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.public Char2ReferenceLinkedOpenHashMap(Map<? extends Character,? extends V> m, float f)
m - a Map to be copied into the new hash map.f - the load factor.public Char2ReferenceLinkedOpenHashMap(Map<? extends Character,? extends V> m)
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.m - a Map to be copied into the new hash map.public Char2ReferenceLinkedOpenHashMap(Char2ReferenceMap<V> m, float f)
m - a type-specific map to be copied into the new hash map.f - the load factor.public Char2ReferenceLinkedOpenHashMap(Char2ReferenceMap<V> 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 Char2ReferenceLinkedOpenHashMap(char[] k,
V[] 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 Char2ReferenceLinkedOpenHashMap(char[] k,
V[] 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 V> m)
public V put(char k, V v)
Char2ReferenceFunctionput in interface Char2ReferenceFunction<V>put in class AbstractChar2ReferenceFunction<V>k - the key.v - the value.Function.put(Object,Object)public V put(Character ok, V ov)
AbstractChar2ReferenceFunctionnull on a missing key.
This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a
more efficient method.
put in interface Function<Character,V>put in interface Map<Character,V>put in class AbstractChar2ReferenceFunction<V>ok - the key.ov - the value.null if no value was present for the given key.Map.put(Object,Object)public V remove(char k)
Char2ReferenceFunctionremove in interface Char2ReferenceFunction<V>remove in class AbstractChar2ReferenceFunction<V>k - the key.Function.remove(Object)public V remove(Object ok)
AbstractChar2ReferenceFunctionnull on a missing key.
This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a
more efficient method.
public V removeFirst()
NoSuchElementException - is this map is empty.public V removeLast()
NoSuchElementException - is this map is empty.public V getAndMoveToFirst(char k)
k - the key.public V getAndMoveToLast(char k)
k - the key.public V putAndMoveToFirst(char k, V v)
k - the key.v - the value.public V putAndMoveToLast(char k, V v)
k - the key.v - the value.public V get(char k)
Char2ReferenceFunctionget in interface Char2ReferenceFunction<V>k - the key.Function.get(Object)public boolean containsKey(char k)
AbstractChar2ReferenceMapAbstractChar2ReferenceMap.keySet().containsKey in interface Char2ReferenceFunction<V>containsKey in class AbstractChar2ReferenceMap<V>Function.containsKey(Object)public boolean containsValue(Object v)
AbstractChar2ReferenceMapAbstractChar2ReferenceMap.values().containsValue in interface Map<Character,V>containsValue in class AbstractChar2ReferenceMap<V>public void clear()
Functionpublic int size()
FunctionMost function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.
public boolean isEmpty()
@Deprecated public void growthFactor(int growthFactor)
fastutil 6.1.0, hash tables are doubled when they are too full.growthFactor - unused.@Deprecated public int growthFactor()
fastutil 6.1.0, hash tables are doubled when they are too full.growthFactor(int)public char firstCharKey()
firstCharKey in interface Char2ReferenceSortedMap<V>SortedMap.firstKey()public char lastCharKey()
lastCharKey in interface Char2ReferenceSortedMap<V>SortedMap.lastKey()public CharComparator comparator()
Char2ReferenceSortedMapNote that this specification strengthens the one given in SortedMap.comparator().
comparator in interface Char2ReferenceSortedMap<V>comparator in interface SortedMap<Character,V>SortedMap.comparator()public Char2ReferenceSortedMap<V> tailMap(char from)
Char2ReferenceSortedMapfromKey.tailMap in interface Char2ReferenceSortedMap<V>SortedMap.tailMap(Object)public Char2ReferenceSortedMap<V> headMap(char to)
Char2ReferenceSortedMaptoKey.headMap in interface Char2ReferenceSortedMap<V>SortedMap.headMap(Object)public Char2ReferenceSortedMap<V> subMap(char from, char to)
Char2ReferenceSortedMapfromKey, inclusive, to toKey, exclusive.subMap in interface Char2ReferenceSortedMap<V>SortedMap.subMap(Object,Object)public Char2ReferenceSortedMap.FastSortedEntrySet<V> char2ReferenceEntrySet()
Char2ReferenceSortedMapchar2ReferenceEntrySet in interface Char2ReferenceMap<V>char2ReferenceEntrySet in interface Char2ReferenceSortedMap<V>Char2ReferenceSortedMap.entrySet()public CharSortedSet keySet()
AbstractChar2ReferenceSortedMapThe view is backed by the sorted set returned by AbstractChar2ReferenceSortedMap.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 Char2ReferenceMap<V>keySet in interface Char2ReferenceSortedMap<V>keySet in interface Map<Character,V>keySet in interface SortedMap<Character,V>keySet in class AbstractChar2ReferenceSortedMap<V>Map.keySet()public ReferenceCollection<V> values()
AbstractChar2ReferenceSortedMapThe view is backed by the sorted set returned by AbstractChar2ReferenceSortedMap.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 Char2ReferenceMap<V>values in interface Char2ReferenceSortedMap<V>values in interface Map<Character,V>values in interface SortedMap<Character,V>values in class AbstractChar2ReferenceSortedMap<V>Map.values()@Deprecated public boolean rehash()
If you need to reduce the table size to fit exactly this set, use trim().
trim()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 Char2ReferenceLinkedOpenHashMap<V> 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.