Function<K,java.lang.Short>
, Hash
, Object2ShortFunction<K>
, Object2ShortMap<K>
, Object2ShortSortedMap<K>
, java.io.Serializable
, java.lang.Cloneable
, java.util.function.Function<K,java.lang.Short>
, java.util.function.ToIntFunction<K>
, java.util.Map<K,java.lang.Short>
, java.util.SortedMap<K,java.lang.Short>
public class Object2ShortLinkedOpenCustomHashMap<K> extends AbstractObject2ShortSortedMap<K> 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, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, 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 map 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 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 map, 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 FormAbstractObject2ShortMap.BasicEntry<K>, AbstractObject2ShortMap.BasicEntrySet<K>
Hash.Strategy<K>
Object2ShortMap.Entry<K>, Object2ShortMap.FastEntrySet<K>
Object2ShortSortedMap.FastSortedEntrySet<K>
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor | Description |
---|---|
Object2ShortLinkedOpenCustomHashMap(int expected,
float f,
Hash.Strategy<K> strategy) |
Creates a new hash map.
|
Object2ShortLinkedOpenCustomHashMap(int expected,
Hash.Strategy<K> strategy) |
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2ShortLinkedOpenCustomHashMap(Hash.Strategy<K> strategy) |
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries and
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<K> m,
float f,
Hash.Strategy<K> strategy) |
Creates a new hash map copying a given type-specific one.
|
Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<K> m,
Hash.Strategy<K> strategy) |
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given type-specific one. |
Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends K,? extends java.lang.Short> m,
float f,
Hash.Strategy<K> strategy) |
Creates a new hash map copying a given one.
|
Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends K,? extends java.lang.Short> m,
Hash.Strategy<K> strategy) |
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor
copying a given one. |
Object2ShortLinkedOpenCustomHashMap(K[] k,
short[] v,
float f,
Hash.Strategy<K> strategy) |
Creates a new hash map using the elements of two parallel arrays.
|
Object2ShortLinkedOpenCustomHashMap(K[] k,
short[] v,
Hash.Strategy<K> strategy) |
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor
using the elements of two parallel arrays. |
Modifier and Type | Method | Description |
---|---|---|
short |
addTo(K k,
short incr) |
Adds an increment to value currently associated with a key.
|
void |
clear() |
Removes all of the mappings from this map (optional operation).
|
Object2ShortLinkedOpenCustomHashMap<K> |
clone() |
Returns a deep copy of this map.
|
java.util.Comparator<? super K> |
comparator() |
Returns the comparator associated with this sorted set, or null if it uses
its keys' natural ordering.
|
short |
computeShort(K k,
java.util.function.BiFunction<? super K,? super java.lang.Short,? extends java.lang.Short> remappingFunction) |
Attempts to compute a mapping for the specified key and its current mapped
value (or
null if there is no current mapping). |
short |
computeShortIfAbsent(K k,
java.util.function.ToIntFunction<? super K> mappingFunction) |
If the specified key is not already associated with a value, attempts to
compute its value using the given mapping function and enters it into this
map.
|
short |
computeShortIfPresent(K k,
java.util.function.BiFunction<? super K,? super java.lang.Short,? extends java.lang.Short> remappingFunction) |
If the value for the specified key is present, attempts to compute a new
mapping given the key and its current mapped value.
|
boolean |
containsKey(java.lang.Object k) |
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(short v) |
Returns
true if this map maps one or more keys to the specified
value. |
K |
firstKey() |
Returns the first key of this map in iteration order.
|
short |
getAndMoveToFirst(K 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(K 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.
|
short |
getOrDefault(java.lang.Object k,
short defaultValue) |
Returns the value to which the specified key is mapped, or the
defaultValue if this map contains no mapping for the key. |
short |
getShort(java.lang.Object k) |
Returns the value to which the given key is mapped.
|
int |
hashCode() |
Returns a hash code for this map.
|
Object2ShortSortedMap<K> |
headMap(K to) |
Returns a view of the portion of this sorted map whose keys are strictly less
than
toKey . |
boolean |
isEmpty() |
|
ObjectSortedSet<K> |
keySet() |
Returns a type-specific-set view of the keys of this map.
|
K |
lastKey() |
Returns the last key of this map in iteration order.
|
short |
mergeShort(K k,
short v,
java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Short,? extends java.lang.Short> remappingFunction) |
If the specified key is not already associated with a value, associates it
with the given
value . |
Object2ShortSortedMap.FastSortedEntrySet<K> |
object2ShortEntrySet() |
Returns a type-specific sorted-set view of the mappings contained in this
map.
|
short |
put(K k,
short v) |
Adds a pair to the map (optional operation).
|
void |
putAll(java.util.Map<? extends K,? extends java.lang.Short> m) |
|
short |
putAndMoveToFirst(K 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(K 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.
|
short |
putIfAbsent(K k,
short v) |
If the specified key is not already associated with a value, associates it
with the given value and returns the default return value, else returns the current value.
|
boolean |
remove(java.lang.Object k,
short v) |
Removes the entry for the specified key only if it is currently mapped to the
specified value.
|
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.
|
short |
removeShort(java.lang.Object k) |
Removes the mapping with the given key (optional operation).
|
short |
replace(K k,
short v) |
Replaces the entry for the specified key only if it is currently mapped to
some value.
|
boolean |
replace(K k,
short oldValue,
short v) |
Replaces the entry for the specified key only if currently mapped to the
specified value.
|
int |
size() |
Returns the number of key/value mappings in this map.
|
Hash.Strategy<K> |
strategy() |
Returns the hashing strategy.
|
Object2ShortSortedMap<K> |
subMap(K from,
K to) |
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Object2ShortSortedMap<K> |
tailMap(K 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-set view of the values of this map.
|
defaultReturnValue, defaultReturnValue
equals, toString
compute, computeIfAbsent, computeIfPresent, equals, forEach, replaceAll
applyAsInt
computeShortIfAbsentPartial, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace
entrySet
public Object2ShortLinkedOpenCustomHashMap(int expected, float f, Hash.Strategy<K> 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 map.f
- the load factor.strategy
- the strategy.public Object2ShortLinkedOpenCustomHashMap(int expected, Hash.Strategy<K> strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.strategy
- the strategy.public Object2ShortLinkedOpenCustomHashMap(Hash.Strategy<K> strategy)
Hash.DEFAULT_INITIAL_SIZE
entries and
Hash.DEFAULT_LOAD_FACTOR
as load factor.strategy
- the strategy.public Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends K,? extends java.lang.Short> m, float f, Hash.Strategy<K> strategy)
m
- a Map
to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Object2ShortLinkedOpenCustomHashMap(java.util.Map<? extends K,? extends java.lang.Short> m, Hash.Strategy<K> 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 Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<K> m, float f, Hash.Strategy<K> strategy)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Object2ShortLinkedOpenCustomHashMap(Object2ShortMap<K> m, Hash.Strategy<K> 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 Object2ShortLinkedOpenCustomHashMap(K[] k, short[] v, float f, Hash.Strategy<K> 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 Object2ShortLinkedOpenCustomHashMap(K[] k, short[] v, Hash.Strategy<K> 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 Hash.Strategy<K> strategy()
public void putAll(java.util.Map<? extends K,? extends java.lang.Short> m)
AbstractObject2ShortMap
putAll
in interface java.util.Map<K,java.lang.Short>
putAll
in class AbstractObject2ShortMap<K>
public short put(K k, short v)
Object2ShortFunction
put
in interface Object2ShortFunction<K>
k
- the key.v
- the value.Function.put(Object,Object)
public short addTo(K 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 removeShort(java.lang.Object k)
Object2ShortFunction
removeShort
in interface Object2ShortFunction<K>
k
- the key.Function.remove(Object)
public short removeFirstShort()
java.util.NoSuchElementException
- is this map is empty.public short removeLastShort()
java.util.NoSuchElementException
- is this map is empty.public short getAndMoveToFirst(K k)
k
- the key.public short getAndMoveToLast(K k)
k
- the key.public short putAndMoveToFirst(K k, short v)
k
- the key.v
- the value.public short putAndMoveToLast(K k, short v)
k
- the key.v
- the value.public short getShort(java.lang.Object k)
Object2ShortFunction
getShort
in interface Object2ShortFunction<K>
k
- the key.Function.get(Object)
public boolean containsKey(java.lang.Object k)
Object2ShortMap
containsKey
in interface Function<K,java.lang.Short>
containsKey
in interface java.util.Map<K,java.lang.Short>
containsKey
in interface Object2ShortMap<K>
containsKey
in class AbstractObject2ShortMap<K>
k
- the key.key
.Map.containsKey(Object)
public boolean containsValue(short v)
Object2ShortMap
true
if this map maps one or more keys to the specified
value.containsValue
in interface Object2ShortMap<K>
containsValue
in class AbstractObject2ShortMap<K>
Map.containsValue(Object)
public short getOrDefault(java.lang.Object k, short defaultValue)
defaultValue
if this map contains no mapping for the key.getOrDefault
in interface Object2ShortMap<K>
k
- the key.defaultValue
- the default mapping of the key.defaultValue
if this map contains no mapping for the key.Map.getOrDefault(Object, Object)
public short putIfAbsent(K k, short v)
putIfAbsent
in interface Object2ShortMap<K>
k
- key with which the specified value is to be associated.v
- value to be associated with the specified key.Map.putIfAbsent(Object, Object)
public boolean remove(java.lang.Object k, short v)
remove
in interface Object2ShortMap<K>
k
- key with which the specified value is associated.v
- value expected to be associated with the specified key.true
if the value was removed.Map.remove(Object, Object)
public boolean replace(K k, short oldValue, short v)
replace
in interface Object2ShortMap<K>
k
- key with which the specified value is associated.oldValue
- value expected to be associated with the specified key.v
- value to be associated with the specified key.true
if the value was replaced.Map.replace(Object, Object, Object)
public short replace(K k, short v)
replace
in interface Object2ShortMap<K>
k
- key with which the specified value is associated.v
- value to be associated with the specified key.Map.replace(Object, Object)
public short computeShortIfAbsent(K k, java.util.function.ToIntFunction<? super K> mappingFunction)
Note that contrarily to the default
computeIfAbsent(), it is not possible to not add a value for a given key,
since the mappingFunction
cannot return null
. If such a
behavior is needed, please use the corresponding nullable version.
computeShortIfAbsent
in interface Object2ShortMap<K>
k
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)
public short computeShortIfPresent(K k, java.util.function.BiFunction<? super K,? super java.lang.Short,? extends java.lang.Short> remappingFunction)
computeShortIfPresent
in interface Object2ShortMap<K>
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.computeIfPresent(Object, java.util.function.BiFunction)
public short computeShort(K k, java.util.function.BiFunction<? super K,? super java.lang.Short,? extends java.lang.Short> remappingFunction)
null
if there is no current mapping).
If the function returns null
, the mapping is removed (or remains
absent if initially absent). If the function itself throws an (unchecked)
exception, the exception is rethrown, and the current mapping is left
unchanged.
computeShort
in interface Object2ShortMap<K>
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.compute(Object, java.util.function.BiFunction)
public short mergeShort(K k, short v, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Short,? extends java.lang.Short> remappingFunction)
value
. Otherwise, replaces the associated value with
the results of the given remapping function, or removes if the result is
null
.mergeShort
in interface Object2ShortMap<K>
k
- key with which the resulting value is to be associated.v
- the value to be merged with the existing value associated with the
key or, if no existing value is associated with the key, to be
associated with the key.remappingFunction
- the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)
public void clear()
Object2ShortMap
public int size()
Object2ShortMap
Integer.MAX_VALUE
elements, returns
Integer.MAX_VALUE
.public boolean isEmpty()
isEmpty
in interface java.util.Map<K,java.lang.Short>
isEmpty
in class AbstractObject2ShortMap<K>
public K firstKey()
firstKey
in interface java.util.SortedMap<K,java.lang.Short>
public K lastKey()
lastKey
in interface java.util.SortedMap<K,java.lang.Short>
public Object2ShortSortedMap<K> tailMap(K from)
fromKey
.
Note that this specification strengthens the one given in
SortedMap.tailMap(Object)
.
This implementation just throws an UnsupportedOperationException
.
tailMap
in interface Object2ShortSortedMap<K>
tailMap
in interface java.util.SortedMap<K,java.lang.Short>
SortedMap.tailMap(Object)
public Object2ShortSortedMap<K> headMap(K to)
toKey
.
Note that this specification strengthens the one given in
SortedMap.headMap(Object)
.
This implementation just throws an UnsupportedOperationException
.
headMap
in interface Object2ShortSortedMap<K>
headMap
in interface java.util.SortedMap<K,java.lang.Short>
SortedMap.headMap(Object)
public Object2ShortSortedMap<K> subMap(K from, K to)
fromKey
, inclusive, to toKey
, exclusive.
Note that this specification strengthens the one given in
SortedMap.subMap(Object,Object)
.
This implementation just throws an UnsupportedOperationException
.
subMap
in interface Object2ShortSortedMap<K>
subMap
in interface java.util.SortedMap<K,java.lang.Short>
SortedMap.subMap(Object,Object)
public java.util.Comparator<? super K> comparator()
Note that this specification strengthens the one given in
SortedMap.comparator()
.
This implementation just returns null
.
comparator
in interface Object2ShortSortedMap<K>
comparator
in interface java.util.SortedMap<K,java.lang.Short>
SortedMap.comparator()
public Object2ShortSortedMap.FastSortedEntrySet<K> object2ShortEntrySet()
Object2ShortSortedMap
Note that this specification strengthens the one given in the corresponding type-specific unsorted map.
object2ShortEntrySet
in interface Object2ShortMap<K>
object2ShortEntrySet
in interface Object2ShortSortedMap<K>
Object2ShortSortedMap.entrySet()
public ObjectSortedSet<K> keySet()
AbstractObject2ShortSortedMap
The view is backed by the set returned by Map.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.
The view is backed by the sorted set returned by
Map.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 java.util.Map<K,java.lang.Short>
keySet
in interface Object2ShortMap<K>
keySet
in interface Object2ShortSortedMap<K>
keySet
in interface java.util.SortedMap<K,java.lang.Short>
keySet
in class AbstractObject2ShortSortedMap<K>
Map.keySet()
public ShortCollection values()
AbstractObject2ShortSortedMap
The view is backed by the set returned by Map.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.
The view is backed by the sorted set returned by
Map.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 java.util.Map<K,java.lang.Short>
values
in interface Object2ShortMap<K>
values
in interface Object2ShortSortedMap<K>
values
in interface java.util.SortedMap<K,java.lang.Short>
values
in class AbstractObject2ShortSortedMap<K>
Map.values()
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 Object2ShortLinkedOpenCustomHashMap<K> 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.hashCode
in interface java.util.Map<K,java.lang.Short>
hashCode
in class AbstractObject2ShortMap<K>