public class Object2LongLinkedOpenHashMap<K> extends AbstractObject2LongSortedMap<K> 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 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 FormAbstractObject2LongMap.BasicEntry<K>Hash.Strategy<K>Object2LongSortedMap.FastSortedEntrySet<K>Object2LongMap.Entry<K>, Object2LongMap.FastEntrySet<K>DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
Object2LongLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2LongLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2LongLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Object2LongLinkedOpenHashMap(K[] k,
long[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Object2LongLinkedOpenHashMap(K[] k,
long[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Object2LongLinkedOpenHashMap(Map<? extends K,? extends Long> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Object2LongLinkedOpenHashMap(Map<? extends K,? extends Long> m,
float f)
Creates a new hash map copying a given one.
|
Object2LongLinkedOpenHashMap(Object2LongMap<K> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Object2LongLinkedOpenHashMap(Object2LongMap<K> m,
float f)
Creates a new hash map copying a given type-specific one.
|
| Modifier and Type | Method and Description |
|---|---|
long |
addTo(K k,
long incr)
Adds an increment to value currently associated with a key.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Object2LongLinkedOpenHashMap<K> |
clone()
Returns a deep copy of this map.
|
Comparator<? super K> |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(Object k)
Checks whether the given value is contained in
AbstractObject2LongMap.keySet(). |
boolean |
containsValue(long v)
Checks whether the given value is contained in
AbstractObject2LongMap.values(). |
K |
firstKey()
Returns the first key of this map in iteration order.
|
long |
getAndMoveToFirst(K 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.
|
long |
getAndMoveToLast(K 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.
|
long |
getLong(Object k)
Returns the value to which the given key is mapped.
|
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.
|
Object2LongSortedMap<K> |
headMap(K to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey. |
boolean |
isEmpty() |
ObjectSortedSet<K> |
keySet()
Returns a type-specific-sorted-set view of the keys of this map.
|
K |
lastKey()
Returns the last key of this map in iteration order.
|
Object2LongSortedMap.FastSortedEntrySet<K> |
object2LongEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
long |
put(K k,
long v)
Adds a pair to the map.
|
Long |
put(K ok,
Long ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(Map<? extends K,? extends Long> m)
Puts all pairs in the given map.
|
long |
putAndMoveToFirst(K k,
long v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
long |
putAndMoveToLast(K k,
long 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.
|
Long |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
long |
removeFirstLong()
Removes the mapping associated with the first key in iteration order.
|
long |
removeLastLong()
Removes the mapping associated with the last key in iteration order.
|
long |
removeLong(Object k)
Removes the mapping with the given key.
|
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
Object2LongSortedMap<K> |
subMap(K from,
K to)
Returns a view of the portion of this sorted map whose keys range from
fromKey, inclusive, to toKey, exclusive. |
Object2LongSortedMap<K> |
tailMap(K 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.
|
LongCollection |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySetcontainsValue, equals, toStringdefaultReturnValue, defaultReturnValue, getdefaultReturnValue, defaultReturnValuecompute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, get, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic Object2LongLinkedOpenHashMap(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 Object2LongLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR as load factor.expected - the expected number of elements in the hash map.public Object2LongLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.public Object2LongLinkedOpenHashMap(Map<? extends K,? extends Long> m, float f)
m - a Map to be copied into the new hash map.f - the load factor.public Object2LongLinkedOpenHashMap(Map<? extends K,? extends Long> m)
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.m - a Map to be copied into the new hash map.public Object2LongLinkedOpenHashMap(Object2LongMap<K> m, float f)
m - a type-specific map to be copied into the new hash map.f - the load factor.public Object2LongLinkedOpenHashMap(Object2LongMap<K> 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 Object2LongLinkedOpenHashMap(K[] k, long[] 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 Object2LongLinkedOpenHashMap(K[] k, long[] 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 K,? extends Long> m)
public long put(K k, long v)
Object2LongFunctionput in interface Object2LongFunction<K>put in class AbstractObject2LongFunction<K>k - the key.v - the value.Function.put(Object,Object)public Long put(K ok, Long ov)
AbstractObject2LongFunctionnull 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 long addTo(K k, long 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 long removeLong(Object k)
Object2LongFunctionremoveLong in interface Object2LongFunction<K>removeLong in class AbstractObject2LongFunction<K>k - the key.Function.remove(Object)public Long remove(Object ok)
AbstractObject2LongFunctionnull 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 long removeFirstLong()
NoSuchElementException - is this map is empty.public long removeLastLong()
NoSuchElementException - is this map is empty.public long getAndMoveToFirst(K k)
k - the key.public long getAndMoveToLast(K k)
k - the key.public long putAndMoveToFirst(K k, long v)
k - the key.v - the value.public long putAndMoveToLast(K k, long v)
k - the key.v - the value.public long getLong(Object k)
Object2LongFunctiongetLong in interface Object2LongFunction<K>k - the key.Function.get(Object)public boolean containsKey(Object k)
AbstractObject2LongMapAbstractObject2LongMap.keySet().containsKey in interface Function<K,Long>containsKey in interface Map<K,Long>containsKey in class AbstractObject2LongMap<K>k - the key.key.Map.containsKey(Object)public boolean containsValue(long v)
AbstractObject2LongMapAbstractObject2LongMap.values().containsValue in interface Object2LongMap<K>containsValue in class AbstractObject2LongMap<K>Map.containsValue(Object)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 K firstKey()
public K lastKey()
public Comparator<? super K> comparator()
Object2LongSortedMapNote that this specification strengthens the one given in SortedMap.comparator().
comparator in interface Object2LongSortedMap<K>comparator in interface SortedMap<K,Long>SortedMap.comparator()public Object2LongSortedMap<K> tailMap(K from)
Object2LongSortedMapfromKey.
Note that this specification strengthens the one given in SortedMap.tailMap(Object).
tailMap in interface Object2LongSortedMap<K>tailMap in interface SortedMap<K,Long>SortedMap.tailMap(Object)public Object2LongSortedMap<K> headMap(K to)
Object2LongSortedMaptoKey.
Note that this specification strengthens the one given in SortedMap.headMap(Object).
headMap in interface Object2LongSortedMap<K>headMap in interface SortedMap<K,Long>SortedMap.headMap(Object)public Object2LongSortedMap<K> subMap(K from, K to)
Object2LongSortedMapfromKey, inclusive, to toKey, exclusive.
Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).
subMap in interface Object2LongSortedMap<K>subMap in interface SortedMap<K,Long>SortedMap.subMap(Object,Object)public Object2LongSortedMap.FastSortedEntrySet<K> object2LongEntrySet()
Object2LongSortedMapobject2LongEntrySet in interface Object2LongMap<K>object2LongEntrySet in interface Object2LongSortedMap<K>Object2LongSortedMap.entrySet()public ObjectSortedSet<K> keySet()
AbstractObject2LongSortedMapThe view is backed by the sorted set returned by AbstractObject2LongSortedMap.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 Object2LongMap<K>keySet in interface Object2LongSortedMap<K>keySet in interface Map<K,Long>keySet in interface SortedMap<K,Long>keySet in class AbstractObject2LongSortedMap<K>Map.keySet()public LongCollection values()
AbstractObject2LongSortedMapThe view is backed by the sorted set returned by AbstractObject2LongSortedMap.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 Object2LongMap<K>values in interface Object2LongSortedMap<K>values in interface Map<K,Long>values in interface SortedMap<K,Long>values in class AbstractObject2LongSortedMap<K>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 Object2LongLinkedOpenHashMap<K> 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.