public class Int2ObjectLinkedOpenHashMap<V> extends AbstractInt2ObjectSortedMap<V> implements java.io.Serializable, java.lang.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 AbstractInt2ObjectSortedMap.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 FormAbstractInt2ObjectMap.BasicEntry<V>
Hash.Strategy<K>
Int2ObjectSortedMap.FastSortedEntrySet<V>
Int2ObjectMap.Entry<V>, Int2ObjectMap.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 |
---|
Int2ObjectLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ObjectLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ObjectLinkedOpenHashMap(int[] k,
V[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Int2ObjectLinkedOpenHashMap(int[] k,
V[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> m,
float f)
Creates a new hash map copying a given type-specific one.
|
Int2ObjectLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m,
float f)
Creates a new hash map copying a given one.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all associations from this function (optional operation).
|
Int2ObjectLinkedOpenHashMap<V> |
clone()
Returns a deep copy of this map.
|
IntComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(int k)
Checks whether the given value is contained in
AbstractInt2ObjectMap.keySet() . |
boolean |
containsValue(java.lang.Object v)
Checks whether the given value is contained in
AbstractInt2ObjectMap.values() . |
int |
firstIntKey()
Returns the first key of this map in iteration order.
|
V |
get(int k)
Returns the value to which the given key is mapped.
|
V |
get(java.lang.Integer ok) |
V |
getAndMoveToFirst(int 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(int 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.
|
Int2ObjectSortedMap<V> |
headMap(int to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey . |
Int2ObjectSortedMap.FastSortedEntrySet<V> |
int2ObjectEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
boolean |
isEmpty() |
IntSortedSet |
keySet()
Returns a type-specific-sorted-set view of the keys of this map.
|
int |
lastIntKey()
Returns the last key of this map in iteration order.
|
V |
put(java.lang.Integer ok,
V ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
V |
put(int k,
V v)
Adds a pair to the map.
|
void |
putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
Puts all pairs in the given map.
|
V |
putAndMoveToFirst(int 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(int 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(int k)
Removes the mapping with the given key.
|
V |
remove(java.lang.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.
|
Int2ObjectSortedMap<V> |
subMap(int from,
int to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Int2ObjectSortedMap<V> |
tailMap(int 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.
|
ObjectCollection<V> |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet, firstKey, headMap, lastKey, subMap, tailMap
equals, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
public Int2ObjectLinkedOpenHashMap(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 Int2ObjectLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Int2ObjectLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends V> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Int2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? 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 Int2ObjectLinkedOpenHashMap(Int2ObjectMap<V> m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Int2ObjectLinkedOpenHashMap(Int2ObjectMap<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 Int2ObjectLinkedOpenHashMap(int[] 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.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public Int2ObjectLinkedOpenHashMap(int[] 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.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public void putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
putAll
in interface java.util.Map<java.lang.Integer,V>
putAll
in class AbstractInt2ObjectMap<V>
m
- a map.public V put(int k, V v)
Int2ObjectFunction
put
in interface Int2ObjectFunction<V>
put
in class AbstractInt2ObjectFunction<V>
k
- the key.v
- the value.Function.put(Object,Object)
public V put(java.lang.Integer ok, V ov)
AbstractInt2ObjectFunction
null
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<java.lang.Integer,V>
put
in interface java.util.Map<java.lang.Integer,V>
put
in class AbstractInt2ObjectFunction<V>
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public V remove(int k)
Int2ObjectFunction
remove
in interface Int2ObjectFunction<V>
remove
in class AbstractInt2ObjectFunction<V>
k
- the key.Function.remove(Object)
public V remove(java.lang.Object ok)
AbstractInt2ObjectFunction
null
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.
remove
in interface Function<java.lang.Integer,V>
remove
in interface java.util.Map<java.lang.Integer,V>
remove
in class AbstractInt2ObjectFunction<V>
ok
- the key.null
if no value was present for the given key.Map.remove(Object)
public V removeFirst()
java.util.NoSuchElementException
- is this map is empty.public V removeLast()
java.util.NoSuchElementException
- is this map is empty.public V getAndMoveToFirst(int k)
k
- the key.public V getAndMoveToLast(int k)
k
- the key.public V putAndMoveToFirst(int k, V v)
k
- the key.v
- the value.public V putAndMoveToLast(int k, V v)
k
- the key.v
- the value.public V get(java.lang.Integer ok)
public V get(int k)
Int2ObjectFunction
get
in interface Int2ObjectFunction<V>
k
- the key.Function.get(Object)
public boolean containsKey(int k)
AbstractInt2ObjectMap
AbstractInt2ObjectMap.keySet()
.containsKey
in interface Int2ObjectFunction<V>
containsKey
in class AbstractInt2ObjectMap<V>
Function.containsKey(Object)
public boolean containsValue(java.lang.Object v)
AbstractInt2ObjectMap
AbstractInt2ObjectMap.values()
.containsValue
in interface java.util.Map<java.lang.Integer,V>
containsValue
in class AbstractInt2ObjectMap<V>
public void clear()
Function
public int size()
Function
Most 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()
isEmpty
in interface java.util.Map<java.lang.Integer,V>
isEmpty
in class AbstractInt2ObjectMap<V>
@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 int firstIntKey()
firstIntKey
in interface Int2ObjectSortedMap<V>
SortedMap.firstKey()
public int lastIntKey()
lastIntKey
in interface Int2ObjectSortedMap<V>
SortedMap.lastKey()
public IntComparator comparator()
Int2ObjectSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Int2ObjectSortedMap<V>
comparator
in interface java.util.SortedMap<java.lang.Integer,V>
SortedMap.comparator()
public Int2ObjectSortedMap<V> tailMap(int from)
Int2ObjectSortedMap
fromKey
.tailMap
in interface Int2ObjectSortedMap<V>
SortedMap.tailMap(Object)
public Int2ObjectSortedMap<V> headMap(int to)
Int2ObjectSortedMap
toKey
.headMap
in interface Int2ObjectSortedMap<V>
SortedMap.headMap(Object)
public Int2ObjectSortedMap<V> subMap(int from, int to)
Int2ObjectSortedMap
fromKey
, inclusive, to toKey
, exclusive.subMap
in interface Int2ObjectSortedMap<V>
SortedMap.subMap(Object,Object)
public Int2ObjectSortedMap.FastSortedEntrySet<V> int2ObjectEntrySet()
Int2ObjectSortedMap
int2ObjectEntrySet
in interface Int2ObjectMap<V>
int2ObjectEntrySet
in interface Int2ObjectSortedMap<V>
Int2ObjectSortedMap.entrySet()
public IntSortedSet keySet()
AbstractInt2ObjectSortedMap
The view is backed by the sorted set returned by AbstractInt2ObjectSortedMap.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 Int2ObjectMap<V>
keySet
in interface Int2ObjectSortedMap<V>
keySet
in interface java.util.Map<java.lang.Integer,V>
keySet
in interface java.util.SortedMap<java.lang.Integer,V>
keySet
in class AbstractInt2ObjectSortedMap<V>
Map.keySet()
public ObjectCollection<V> values()
AbstractInt2ObjectSortedMap
The view is backed by the sorted set returned by AbstractInt2ObjectSortedMap.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 Int2ObjectMap<V>
values
in interface Int2ObjectSortedMap<V>
values
in interface java.util.Map<java.lang.Integer,V>
values
in interface java.util.SortedMap<java.lang.Integer,V>
values
in class AbstractInt2ObjectSortedMap<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 Int2ObjectLinkedOpenHashMap<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.
clone
in class java.lang.Object
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 java.util.Map<java.lang.Integer,V>
hashCode
in class AbstractInt2ObjectMap<V>