public class Short2ObjectOpenHashMap<V> extends AbstractShort2ObjectMap<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.
Hash
,
HashCommon
,
Serialized FormAbstractShort2ObjectMap.BasicEntry<V>
Hash.Strategy<K>
Short2ObjectMap.Entry<V>, Short2ObjectMap.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 |
---|
Short2ObjectOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Short2ObjectOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Short2ObjectOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Short2ObjectOpenHashMap(Map<? extends Short,? extends V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Short2ObjectOpenHashMap(Map<? extends Short,? extends V> m,
float f)
Creates a new hash map copying a given one.
|
Short2ObjectOpenHashMap(short[] k,
V[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Short2ObjectOpenHashMap(short[] k,
V[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Short2ObjectOpenHashMap(Short2ObjectMap<V> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Short2ObjectOpenHashMap(Short2ObjectMap<V> m,
float f)
Creates a new hash map copying a given type-specific one.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all associations from this function (optional operation).
|
Short2ObjectOpenHashMap<V> |
clone()
Returns a deep copy of this map.
|
boolean |
containsKey(short k)
Checks whether the given value is contained in
AbstractShort2ObjectMap.keySet() . |
boolean |
containsValue(Object v)
Checks whether the given value is contained in
AbstractShort2ObjectMap.values() . |
V |
get(short k)
Returns the value to which the given key is mapped.
|
V |
get(Short ok) |
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.
|
boolean |
isEmpty() |
ShortSet |
keySet()
Returns a type-specific-set view of the keys of this map.
|
V |
put(short k,
V v)
Adds a pair to the map.
|
V |
put(Short ok,
V ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(Map<? extends Short,? extends V> m)
Puts all pairs in the given map.
|
boolean |
rehash()
Deprecated.
A no-op.
|
V |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
V |
remove(short k)
Removes the mapping with the given key.
|
Short2ObjectMap.FastEntrySet<V> |
short2ObjectEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
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-set view of the values of this map.
|
entrySet, equals, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
containsKey, get
public Short2ObjectOpenHashMap(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 Short2ObjectOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Short2ObjectOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Short2ObjectOpenHashMap(Map<? extends Short,? extends V> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Short2ObjectOpenHashMap(Map<? extends Short,? 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 Short2ObjectOpenHashMap(Short2ObjectMap<V> m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Short2ObjectOpenHashMap(Short2ObjectMap<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 Short2ObjectOpenHashMap(short[] 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 Short2ObjectOpenHashMap(short[] 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 Short,? extends V> m)
public V put(short k, V v)
Short2ObjectFunction
put
in interface Short2ObjectFunction<V>
put
in class AbstractShort2ObjectFunction<V>
k
- the key.v
- the value.Function.put(Object,Object)
public V put(Short ok, V ov)
AbstractShort2ObjectFunction
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.
public V remove(short k)
Short2ObjectFunction
remove
in interface Short2ObjectFunction<V>
remove
in class AbstractShort2ObjectFunction<V>
k
- the key.Function.remove(Object)
public V remove(Object ok)
AbstractShort2ObjectFunction
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.
public V get(short k)
Short2ObjectFunction
get
in interface Short2ObjectFunction<V>
k
- the key.Function.get(Object)
public boolean containsKey(short k)
AbstractShort2ObjectMap
AbstractShort2ObjectMap.keySet()
.containsKey
in interface Short2ObjectFunction<V>
containsKey
in class AbstractShort2ObjectMap<V>
Function.containsKey(Object)
public boolean containsValue(Object v)
AbstractShort2ObjectMap
AbstractShort2ObjectMap.values()
.containsValue
in interface Map<Short,V>
containsValue
in class AbstractShort2ObjectMap<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()
@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 Short2ObjectMap.FastEntrySet<V> short2ObjectEntrySet()
Short2ObjectMap
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Short2ObjectMap.entrySet()
so that it returns an ObjectSet
of objects of type Map.Entry
(the latter makes it possible to
access keys and values with type-specific methods).
short2ObjectEntrySet
in interface Short2ObjectMap<V>
Short2ObjectMap.entrySet()
public ShortSet keySet()
AbstractShort2ObjectMap
The view is backed by the set returned by AbstractShort2ObjectMap.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 Short2ObjectMap<V>
keySet
in interface Map<Short,V>
keySet
in class AbstractShort2ObjectMap<V>
Map.keySet()
public ObjectCollection<V> values()
AbstractShort2ObjectMap
The view is backed by the set returned by AbstractShort2ObjectMap.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 Short2ObjectMap<V>
values
in interface Map<Short,V>
values
in class AbstractShort2ObjectMap<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 Short2ObjectOpenHashMap<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.