public class Int2ByteLinkedOpenHashMap extends AbstractInt2ByteSortedMap 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 AbstractInt2ByteSortedMap.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 FormAbstractInt2ByteMap.BasicEntry
Hash.Strategy<K>
Int2ByteSortedMap.FastSortedEntrySet
Int2ByteMap.Entry, Int2ByteMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Int2ByteLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ByteLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Int2ByteLinkedOpenHashMap(int[] k,
byte[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Int2ByteLinkedOpenHashMap(int[] k,
byte[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Int2ByteLinkedOpenHashMap(Int2ByteMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Int2ByteLinkedOpenHashMap(Int2ByteMap m,
float f)
Creates a new hash map copying a given type-specific one.
|
Int2ByteLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Int2ByteLinkedOpenHashMap(Map<? extends Integer,? extends Byte> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Int2ByteLinkedOpenHashMap(Map<? extends Integer,? extends Byte> m,
float f)
Creates a new hash map copying a given one.
|
Modifier and Type | Method and Description |
---|---|
byte |
addTo(int k,
byte incr)
Adds an increment to value currently associated with a key.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Int2ByteLinkedOpenHashMap |
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
AbstractInt2ByteMap.keySet() . |
boolean |
containsValue(byte v)
Checks whether the given value is contained in
AbstractInt2ByteMap.values() . |
int |
firstIntKey()
Returns the first key of this map in iteration order.
|
byte |
get(int k)
Returns the value to which the given key is mapped.
|
Byte |
get(Integer ok) |
byte |
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.
|
byte |
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.
|
Int2ByteSortedMap |
headMap(int to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey . |
Int2ByteSortedMap.FastSortedEntrySet |
int2ByteEntrySet()
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.
|
byte |
put(int k,
byte v)
Adds a pair to the map.
|
Byte |
put(Integer ok,
Byte ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(Map<? extends Integer,? extends Byte> m)
Puts all pairs in the given map.
|
byte |
putAndMoveToFirst(int k,
byte v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
byte |
putAndMoveToLast(int k,
byte 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.
|
byte |
remove(int k)
Removes the mapping with the given key.
|
Byte |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
byte |
removeFirstByte()
Removes the mapping associated with the first key in iteration order.
|
byte |
removeLastByte()
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.
|
Int2ByteSortedMap |
subMap(int from,
int to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Int2ByteSortedMap |
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.
|
ByteCollection |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet, firstKey, headMap, lastKey, subMap, tailMap
containsValue, equals, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
containsKey, containsValue, equals, get
public Int2ByteLinkedOpenHashMap(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 Int2ByteLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Int2ByteLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Int2ByteLinkedOpenHashMap(Map<? extends Integer,? extends Byte> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Int2ByteLinkedOpenHashMap(Map<? extends Integer,? extends Byte> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.public Int2ByteLinkedOpenHashMap(Int2ByteMap m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Int2ByteLinkedOpenHashMap(Int2ByteMap 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 Int2ByteLinkedOpenHashMap(int[] k, byte[] 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 Int2ByteLinkedOpenHashMap(int[] k, byte[] 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 Integer,? extends Byte> m)
public byte put(int k, byte v)
Int2ByteFunction
put
in interface Int2ByteFunction
put
in class AbstractInt2ByteFunction
k
- the key.v
- the value.Function.put(Object,Object)
public Byte put(Integer ok, Byte ov)
AbstractInt2ByteFunction
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 byte addTo(int 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(int k)
Int2ByteFunction
remove
in interface Int2ByteFunction
remove
in class AbstractInt2ByteFunction
k
- the key.Function.remove(Object)
public Byte remove(Object ok)
AbstractInt2ByteFunction
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 byte removeFirstByte()
NoSuchElementException
- is this map is empty.public byte removeLastByte()
NoSuchElementException
- is this map is empty.public byte getAndMoveToFirst(int k)
k
- the key.public byte getAndMoveToLast(int k)
k
- the key.public byte putAndMoveToFirst(int k, byte v)
k
- the key.v
- the value.public byte putAndMoveToLast(int k, byte v)
k
- the key.v
- the value.public byte get(int k)
Int2ByteFunction
get
in interface Int2ByteFunction
k
- the key.Function.get(Object)
public boolean containsKey(int k)
AbstractInt2ByteMap
AbstractInt2ByteMap.keySet()
.containsKey
in interface Int2ByteFunction
containsKey
in class AbstractInt2ByteMap
Function.containsKey(Object)
public boolean containsValue(byte v)
AbstractInt2ByteMap
AbstractInt2ByteMap.values()
.containsValue
in interface Int2ByteMap
containsValue
in class AbstractInt2ByteMap
Map.containsValue(Object)
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 int firstIntKey()
firstIntKey
in interface Int2ByteSortedMap
SortedMap.firstKey()
public int lastIntKey()
lastIntKey
in interface Int2ByteSortedMap
SortedMap.lastKey()
public IntComparator comparator()
Int2ByteSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Int2ByteSortedMap
comparator
in interface SortedMap<Integer,Byte>
SortedMap.comparator()
public Int2ByteSortedMap tailMap(int from)
Int2ByteSortedMap
fromKey
.tailMap
in interface Int2ByteSortedMap
SortedMap.tailMap(Object)
public Int2ByteSortedMap headMap(int to)
Int2ByteSortedMap
toKey
.headMap
in interface Int2ByteSortedMap
SortedMap.headMap(Object)
public Int2ByteSortedMap subMap(int from, int to)
Int2ByteSortedMap
fromKey
, inclusive, to toKey
, exclusive.subMap
in interface Int2ByteSortedMap
SortedMap.subMap(Object,Object)
public Int2ByteSortedMap.FastSortedEntrySet int2ByteEntrySet()
Int2ByteSortedMap
int2ByteEntrySet
in interface Int2ByteMap
int2ByteEntrySet
in interface Int2ByteSortedMap
Int2ByteSortedMap.entrySet()
public IntSortedSet keySet()
AbstractInt2ByteSortedMap
The view is backed by the sorted set returned by AbstractInt2ByteSortedMap.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 Int2ByteMap
keySet
in interface Int2ByteSortedMap
keySet
in interface Map<Integer,Byte>
keySet
in interface SortedMap<Integer,Byte>
keySet
in class AbstractInt2ByteSortedMap
Map.keySet()
public ByteCollection values()
AbstractInt2ByteSortedMap
The view is backed by the sorted set returned by AbstractInt2ByteSortedMap.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 Int2ByteMap
values
in interface Int2ByteSortedMap
values
in interface Map<Integer,Byte>
values
in interface SortedMap<Integer,Byte>
values
in class AbstractInt2ByteSortedMap
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 Int2ByteLinkedOpenHashMap 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.