public class Byte2ShortLinkedOpenHashMap extends AbstractByte2ShortSortedMap implements Serializable, Cloneable, Hash
Instances of this class use a hash table to represent a map. The table is
enlarged as needed by doubling its size when new entries are created, but it is never made
smaller (even on a clear()
). 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 AbstractByte2ShortSortedMap.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 FormAbstractByte2ShortMap.BasicEntry
Hash.Strategy<K>
Byte2ShortSortedMap.FastSortedEntrySet
Byte2ShortMap.Entry, Byte2ShortMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Byte2ShortLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Byte2ShortLinkedOpenHashMap(byte[] k,
short[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Byte2ShortLinkedOpenHashMap(byte[] k,
short[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Byte2ShortLinkedOpenHashMap(Byte2ShortMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Byte2ShortLinkedOpenHashMap(Byte2ShortMap m,
float f)
Creates a new hash map copying a given type-specific one.
|
Byte2ShortLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Byte2ShortLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Byte2ShortLinkedOpenHashMap(Map<? extends Byte,? extends Short> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Byte2ShortLinkedOpenHashMap(Map<? extends Byte,? extends Short> m,
float f)
Creates a new hash map copying a given one.
|
Modifier and Type | Method and Description |
---|---|
short |
add(byte k,
short incr)
Deprecated.
use
addTo() instead; having the same name of a Set method turned out to be a recipe for disaster. |
short |
addTo(byte k,
short incr)
Adds an increment to value currently associated with a key.
|
Byte2ShortSortedMap.FastSortedEntrySet |
byte2ShortEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Byte2ShortLinkedOpenHashMap |
clone()
Returns a deep copy of this map.
|
ByteComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(byte k)
Checks whether the given value is contained in
AbstractByte2ShortMap.keySet() . |
boolean |
containsValue(short v)
Checks whether the given value is contained in
AbstractByte2ShortMap.values() . |
byte |
firstByteKey()
Returns the first key of this map in iteration order.
|
short |
get(byte k)
Returns the value to which the given key is mapped.
|
Short |
get(Byte ok) |
short |
getAndMoveToFirst(byte 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.
|
short |
getAndMoveToLast(byte 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.
|
Byte2ShortSortedMap |
headMap(byte to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey . |
boolean |
isEmpty() |
ByteSortedSet |
keySet()
Returns a type-specific-sorted-set view of the keys of this map.
|
byte |
lastByteKey()
Returns the last key of this map in iteration order.
|
short |
put(byte k,
short v)
Adds a pair to the map.
|
Short |
put(Byte ok,
Short ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
short |
putAndMoveToFirst(byte k,
short v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
short |
putAndMoveToLast(byte k,
short 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.
|
short |
remove(byte k)
Removes the mapping with the given key.
|
Short |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
short |
removeFirstShort()
Removes the mapping associated with the first key in iteration order.
|
short |
removeLastShort()
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.
|
Byte2ShortSortedMap |
subMap(byte from,
byte to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Byte2ShortSortedMap |
tailMap(byte 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.
|
ShortCollection |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet, firstKey, headMap, lastKey, subMap, tailMap
containsValue, equals, putAll, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
containsKey, containsValue, equals, get, putAll
public Byte2ShortLinkedOpenHashMap(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 Byte2ShortLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Byte2ShortLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Byte2ShortLinkedOpenHashMap(Map<? extends Byte,? extends Short> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Byte2ShortLinkedOpenHashMap(Map<? extends Byte,? extends Short> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.public Byte2ShortLinkedOpenHashMap(Byte2ShortMap m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Byte2ShortLinkedOpenHashMap(Byte2ShortMap 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 Byte2ShortLinkedOpenHashMap(byte[] k, short[] 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 Byte2ShortLinkedOpenHashMap(byte[] k, short[] 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 short put(byte k, short v)
Byte2ShortFunction
put
in interface Byte2ShortFunction
put
in class AbstractByte2ShortFunction
k
- the key.v
- the value.Function.put(Object,Object)
public Short put(Byte ok, Short ov)
AbstractByte2ShortFunction
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.
@Deprecated public short add(byte k, short incr)
addTo()
instead; having the same name of a Set
method turned out to be a recipe for disaster.k
- the key.incr
- the increment.public short addTo(byte k, short 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 short remove(byte k)
Byte2ShortFunction
remove
in interface Byte2ShortFunction
remove
in class AbstractByte2ShortFunction
Function.remove(Object)
public Short remove(Object ok)
AbstractByte2ShortFunction
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 short removeFirstShort()
NoSuchElementException
- is this map is empty.public short removeLastShort()
NoSuchElementException
- is this map is empty.public short getAndMoveToFirst(byte k)
k
- the key.public short getAndMoveToLast(byte k)
k
- the key.public short putAndMoveToFirst(byte k, short v)
k
- the key.v
- the value.public short putAndMoveToLast(byte k, short v)
k
- the key.v
- the value.public short get(byte k)
Byte2ShortFunction
get
in interface Byte2ShortFunction
k
- the key.Function.get(Object)
public boolean containsKey(byte k)
AbstractByte2ShortMap
AbstractByte2ShortMap.keySet()
.containsKey
in interface Byte2ShortFunction
containsKey
in class AbstractByte2ShortMap
Function.containsKey(Object)
public boolean containsValue(short v)
AbstractByte2ShortMap
AbstractByte2ShortMap.values()
.containsValue
in interface Byte2ShortMap
containsValue
in class AbstractByte2ShortMap
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 byte firstByteKey()
firstByteKey
in interface Byte2ShortSortedMap
SortedMap.firstKey()
public byte lastByteKey()
lastByteKey
in interface Byte2ShortSortedMap
SortedMap.lastKey()
public ByteComparator comparator()
Byte2ShortSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Byte2ShortSortedMap
comparator
in interface SortedMap<Byte,Short>
SortedMap.comparator()
public Byte2ShortSortedMap tailMap(byte from)
Byte2ShortSortedMap
fromKey
.tailMap
in interface Byte2ShortSortedMap
SortedMap.tailMap(Object)
public Byte2ShortSortedMap headMap(byte to)
Byte2ShortSortedMap
toKey
.headMap
in interface Byte2ShortSortedMap
SortedMap.headMap(Object)
public Byte2ShortSortedMap subMap(byte from, byte to)
Byte2ShortSortedMap
fromKey
, inclusive, to toKey
, exclusive.subMap
in interface Byte2ShortSortedMap
SortedMap.subMap(Object,Object)
public Byte2ShortSortedMap.FastSortedEntrySet byte2ShortEntrySet()
Byte2ShortSortedMap
byte2ShortEntrySet
in interface Byte2ShortMap
byte2ShortEntrySet
in interface Byte2ShortSortedMap
Byte2ShortSortedMap.entrySet()
public ByteSortedSet keySet()
AbstractByte2ShortSortedMap
The view is backed by the sorted set returned by AbstractByte2ShortSortedMap.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 Byte2ShortMap
keySet
in interface Byte2ShortSortedMap
keySet
in interface Map<Byte,Short>
keySet
in interface SortedMap<Byte,Short>
keySet
in class AbstractByte2ShortSortedMap
Map.keySet()
public ShortCollection values()
AbstractByte2ShortSortedMap
The view is backed by the sorted set returned by AbstractByte2ShortSortedMap.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 Byte2ShortMap
values
in interface Byte2ShortSortedMap
values
in interface Map<Byte,Short>
values
in interface SortedMap<Byte,Short>
values
in class AbstractByte2ShortSortedMap
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 Byte2ShortLinkedOpenHashMap 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.