public class Short2BooleanLinkedOpenHashMap extends AbstractShort2BooleanSortedMap 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 AbstractShort2BooleanSortedMap.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 FormAbstractShort2BooleanMap.BasicEntry
Hash.Strategy<K>
Short2BooleanSortedMap.FastSortedEntrySet
Short2BooleanMap.Entry, Short2BooleanMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Short2BooleanLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Short2BooleanLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Short2BooleanLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Short2BooleanLinkedOpenHashMap(Map<? extends Short,? extends Boolean> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Short2BooleanLinkedOpenHashMap(Map<? extends Short,? extends Boolean> m,
float f)
Creates a new hash map copying a given one.
|
Short2BooleanLinkedOpenHashMap(short[] k,
boolean[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Short2BooleanLinkedOpenHashMap(short[] k,
boolean[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Short2BooleanLinkedOpenHashMap(Short2BooleanMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Short2BooleanLinkedOpenHashMap(Short2BooleanMap 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).
|
Short2BooleanLinkedOpenHashMap |
clone()
Returns a deep copy of this map.
|
ShortComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(short k)
Checks whether the given value is contained in
AbstractShort2BooleanMap.keySet() . |
boolean |
containsValue(boolean v)
Checks whether the given value is contained in
AbstractShort2BooleanMap.values() . |
short |
firstShortKey()
Returns the first key of this map in iteration order.
|
boolean |
get(short k)
Returns the value to which the given key is mapped.
|
Boolean |
get(Short ok) |
boolean |
getAndMoveToFirst(short 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.
|
boolean |
getAndMoveToLast(short 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.
|
Short2BooleanSortedMap |
headMap(short to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey . |
boolean |
isEmpty() |
ShortSortedSet |
keySet()
Returns a type-specific-sorted-set view of the keys of this map.
|
short |
lastShortKey()
Returns the last key of this map in iteration order.
|
boolean |
put(short k,
boolean v)
Adds a pair to the map.
|
Boolean |
put(Short ok,
Boolean ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(Map<? extends Short,? extends Boolean> m)
Puts all pairs in the given map.
|
boolean |
putAndMoveToFirst(short k,
boolean v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
boolean |
putAndMoveToLast(short k,
boolean 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.
|
Boolean |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
boolean |
remove(short k)
Removes the mapping with the given key.
|
boolean |
removeFirstBoolean()
Removes the mapping associated with the first key in iteration order.
|
boolean |
removeLastBoolean()
Removes the mapping associated with the last key in iteration order.
|
Short2BooleanSortedMap.FastSortedEntrySet |
short2BooleanEntrySet()
Returns a type-specific sorted-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.
|
Short2BooleanSortedMap |
subMap(short from,
short to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Short2BooleanSortedMap |
tailMap(short 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.
|
BooleanCollection |
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 Short2BooleanLinkedOpenHashMap(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 Short2BooleanLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Short2BooleanLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Short2BooleanLinkedOpenHashMap(Map<? extends Short,? extends Boolean> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Short2BooleanLinkedOpenHashMap(Map<? extends Short,? extends Boolean> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.public Short2BooleanLinkedOpenHashMap(Short2BooleanMap m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Short2BooleanLinkedOpenHashMap(Short2BooleanMap 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 Short2BooleanLinkedOpenHashMap(short[] k, boolean[] 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 Short2BooleanLinkedOpenHashMap(short[] k, boolean[] 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 Boolean> m)
public boolean put(short k, boolean v)
Short2BooleanFunction
put
in interface Short2BooleanFunction
put
in class AbstractShort2BooleanFunction
k
- the key.v
- the value.Function.put(Object,Object)
public Boolean put(Short ok, Boolean ov)
AbstractShort2BooleanFunction
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<Short,Boolean>
put
in interface Map<Short,Boolean>
put
in class AbstractShort2BooleanFunction
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public boolean remove(short k)
Short2BooleanFunction
remove
in interface Short2BooleanFunction
remove
in class AbstractShort2BooleanFunction
k
- the key.Function.remove(Object)
public Boolean remove(Object ok)
AbstractShort2BooleanFunction
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 boolean removeFirstBoolean()
NoSuchElementException
- is this map is empty.public boolean removeLastBoolean()
NoSuchElementException
- is this map is empty.public boolean getAndMoveToFirst(short k)
k
- the key.public boolean getAndMoveToLast(short k)
k
- the key.public boolean putAndMoveToFirst(short k, boolean v)
k
- the key.v
- the value.public boolean putAndMoveToLast(short k, boolean v)
k
- the key.v
- the value.public boolean get(short k)
Short2BooleanFunction
get
in interface Short2BooleanFunction
k
- the key.Function.get(Object)
public boolean containsKey(short k)
AbstractShort2BooleanMap
AbstractShort2BooleanMap.keySet()
.containsKey
in interface Short2BooleanFunction
containsKey
in class AbstractShort2BooleanMap
Function.containsKey(Object)
public boolean containsValue(boolean v)
AbstractShort2BooleanMap
AbstractShort2BooleanMap.values()
.containsValue
in interface Short2BooleanMap
containsValue
in class AbstractShort2BooleanMap
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 short firstShortKey()
firstShortKey
in interface Short2BooleanSortedMap
SortedMap.firstKey()
public short lastShortKey()
lastShortKey
in interface Short2BooleanSortedMap
SortedMap.lastKey()
public ShortComparator comparator()
Short2BooleanSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Short2BooleanSortedMap
comparator
in interface SortedMap<Short,Boolean>
SortedMap.comparator()
public Short2BooleanSortedMap tailMap(short from)
Short2BooleanSortedMap
fromKey
.tailMap
in interface Short2BooleanSortedMap
SortedMap.tailMap(Object)
public Short2BooleanSortedMap headMap(short to)
Short2BooleanSortedMap
toKey
.headMap
in interface Short2BooleanSortedMap
SortedMap.headMap(Object)
public Short2BooleanSortedMap subMap(short from, short to)
Short2BooleanSortedMap
fromKey
, inclusive, to toKey
, exclusive.subMap
in interface Short2BooleanSortedMap
SortedMap.subMap(Object,Object)
public Short2BooleanSortedMap.FastSortedEntrySet short2BooleanEntrySet()
Short2BooleanSortedMap
short2BooleanEntrySet
in interface Short2BooleanMap
short2BooleanEntrySet
in interface Short2BooleanSortedMap
Short2BooleanSortedMap.entrySet()
public ShortSortedSet keySet()
AbstractShort2BooleanSortedMap
The view is backed by the sorted set returned by AbstractShort2BooleanSortedMap.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 Short2BooleanMap
keySet
in interface Short2BooleanSortedMap
keySet
in interface Map<Short,Boolean>
keySet
in interface SortedMap<Short,Boolean>
keySet
in class AbstractShort2BooleanSortedMap
Map.keySet()
public BooleanCollection values()
AbstractShort2BooleanSortedMap
The view is backed by the sorted set returned by AbstractShort2BooleanSortedMap.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 Short2BooleanMap
values
in interface Short2BooleanSortedMap
values
in interface Map<Short,Boolean>
values
in interface SortedMap<Short,Boolean>
values
in class AbstractShort2BooleanSortedMap
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 Short2BooleanLinkedOpenHashMap 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.