public class Short2ByteOpenCustomHashMap extends AbstractShort2ByteMap 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.
Hash
,
HashCommon
,
Serialized FormAbstractShort2ByteMap.BasicEntry
Hash.Strategy<K>
Short2ByteMap.Entry, Short2ByteMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Short2ByteOpenCustomHashMap(int expected,
float f,
ShortHash.Strategy strategy)
Creates a new hash map.
|
Short2ByteOpenCustomHashMap(int expected,
ShortHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Short2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m,
float f,
ShortHash.Strategy strategy)
Creates a new hash map copying a given one.
|
Short2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m,
ShortHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Short2ByteOpenCustomHashMap(short[] k,
byte[] v,
float f,
ShortHash.Strategy strategy)
Creates a new hash map using the elements of two parallel arrays.
|
Short2ByteOpenCustomHashMap(short[] k,
byte[] v,
ShortHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Short2ByteOpenCustomHashMap(Short2ByteMap m,
float f,
ShortHash.Strategy strategy)
Creates a new hash map copying a given type-specific one.
|
Short2ByteOpenCustomHashMap(Short2ByteMap m,
ShortHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Short2ByteOpenCustomHashMap(ShortHash.Strategy strategy)
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Modifier and Type | Method and Description |
---|---|
byte |
addTo(short k,
byte incr)
Adds an increment to value currently associated with a key.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Short2ByteOpenCustomHashMap |
clone()
Returns a deep copy of this map.
|
boolean |
containsKey(short k)
Checks whether the given value is contained in
AbstractShort2ByteMap.keySet() . |
boolean |
containsValue(byte v)
Checks whether the given value is contained in
AbstractShort2ByteMap.values() . |
byte |
get(short k)
Returns the value to which the given key is mapped.
|
java.lang.Byte |
get(java.lang.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.
|
byte |
put(short k,
byte v)
Adds a pair to the map.
|
java.lang.Byte |
put(java.lang.Short ok,
java.lang.Byte ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m)
Puts all pairs in the given map.
|
boolean |
rehash()
Deprecated.
A no-op.
|
java.lang.Byte |
remove(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
byte |
remove(short k)
Removes the mapping with the given key.
|
Short2ByteMap.FastEntrySet |
short2ByteEntrySet()
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.
|
ShortHash.Strategy |
strategy()
Returns the hashing strategy.
|
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.
|
ByteCollection |
values()
Returns a type-specific-set view of the values of this map.
|
containsValue, entrySet, equals, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
public Short2ByteOpenCustomHashMap(int expected, float f, ShortHash.Strategy strategy)
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.strategy
- the strategy.public Short2ByteOpenCustomHashMap(int expected, ShortHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.strategy
- the strategy.public Short2ByteOpenCustomHashMap(ShortHash.Strategy strategy)
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.strategy
- the strategy.public Short2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m, float f, ShortHash.Strategy strategy)
m
- a Map
to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Short2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m, ShortHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.strategy
- the strategy.public Short2ByteOpenCustomHashMap(Short2ByteMap m, float f, ShortHash.Strategy strategy)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Short2ByteOpenCustomHashMap(Short2ByteMap m, ShortHash.Strategy strategy)
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.strategy
- the strategy.public Short2ByteOpenCustomHashMap(short[] k, byte[] v, float f, ShortHash.Strategy strategy)
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.strategy
- the strategy.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public Short2ByteOpenCustomHashMap(short[] k, byte[] v, ShortHash.Strategy strategy)
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.strategy
- the strategy.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public ShortHash.Strategy strategy()
public void putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> m)
putAll
in interface java.util.Map<java.lang.Short,java.lang.Byte>
putAll
in class AbstractShort2ByteMap
m
- a map.public byte put(short k, byte v)
Short2ByteFunction
put
in interface Short2ByteFunction
put
in class AbstractShort2ByteFunction
k
- the key.v
- the value.Function.put(Object,Object)
public java.lang.Byte put(java.lang.Short ok, java.lang.Byte ov)
AbstractShort2ByteFunction
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.Short,java.lang.Byte>
put
in interface java.util.Map<java.lang.Short,java.lang.Byte>
put
in class AbstractShort2ByteFunction
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public byte addTo(short k, byte 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 byte remove(short k)
Short2ByteFunction
remove
in interface Short2ByteFunction
remove
in class AbstractShort2ByteFunction
k
- the key.Function.remove(Object)
public java.lang.Byte remove(java.lang.Object ok)
AbstractShort2ByteFunction
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.Short,java.lang.Byte>
remove
in interface java.util.Map<java.lang.Short,java.lang.Byte>
remove
in class AbstractShort2ByteFunction
ok
- the key.null
if no value was present for the given key.Map.remove(Object)
public java.lang.Byte get(java.lang.Short ok)
public byte get(short k)
Short2ByteFunction
get
in interface Short2ByteFunction
k
- the key.Function.get(Object)
public boolean containsKey(short k)
AbstractShort2ByteMap
AbstractShort2ByteMap.keySet()
.containsKey
in interface Short2ByteFunction
containsKey
in class AbstractShort2ByteMap
Function.containsKey(Object)
public boolean containsValue(byte v)
AbstractShort2ByteMap
AbstractShort2ByteMap.values()
.containsValue
in interface Short2ByteMap
containsValue
in class AbstractShort2ByteMap
Map.containsValue(Object)
public void clear()
Function
clear
in interface Function<java.lang.Short,java.lang.Byte>
clear
in interface java.util.Map<java.lang.Short,java.lang.Byte>
clear
in class AbstractShort2ByteFunction
Map.clear()
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.Short,java.lang.Byte>
isEmpty
in class AbstractShort2ByteMap
@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 Short2ByteMap.FastEntrySet short2ByteEntrySet()
Short2ByteMap
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Short2ByteMap.entrySet()
so that it returns an ObjectSet
of type-specific entries (the latter makes it possible to
access keys and values with type-specific methods).
short2ByteEntrySet
in interface Short2ByteMap
Short2ByteMap.entrySet()
public ShortSet keySet()
AbstractShort2ByteMap
The view is backed by the set returned by AbstractShort2ByteMap.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 Short2ByteMap
keySet
in interface java.util.Map<java.lang.Short,java.lang.Byte>
keySet
in class AbstractShort2ByteMap
Map.keySet()
public ByteCollection values()
AbstractShort2ByteMap
The view is backed by the set returned by AbstractShort2ByteMap.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 Short2ByteMap
values
in interface java.util.Map<java.lang.Short,java.lang.Byte>
values
in class AbstractShort2ByteMap
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 Short2ByteOpenCustomHashMap 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.Short,java.lang.Byte>
hashCode
in class AbstractShort2ByteMap