public class Object2DoubleLinkedOpenHashMap<K> extends AbstractObject2DoubleSortedMap<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, 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 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 FormAbstractObject2DoubleMap.BasicEntry<K>
Hash.Strategy<K>
Object2DoubleSortedMap.FastSortedEntrySet<K>
Object2DoubleMap.Entry<K>, Object2DoubleMap.FastEntrySet<K>
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Object2DoubleLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2DoubleLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2DoubleLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Object2DoubleLinkedOpenHashMap(K[] k,
double[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Object2DoubleLinkedOpenHashMap(K[] k,
double[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Object2DoubleLinkedOpenHashMap(java.util.Map<? extends K,? extends java.lang.Double> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Object2DoubleLinkedOpenHashMap(java.util.Map<? extends K,? extends java.lang.Double> m,
float f)
Creates a new hash map copying a given one.
|
Object2DoubleLinkedOpenHashMap(Object2DoubleMap<K> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Object2DoubleLinkedOpenHashMap(Object2DoubleMap<K> m,
float f)
Creates a new hash map copying a given type-specific one.
|
Modifier and Type | Method and Description |
---|---|
double |
addTo(K k,
double incr)
Adds an increment to value currently associated with a key.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Object2DoubleLinkedOpenHashMap<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.
|
boolean |
containsKey(java.lang.Object k)
Checks whether the given value is contained in
AbstractObject2DoubleMap.keySet() . |
boolean |
containsValue(double v)
Checks whether the given value is contained in
AbstractObject2DoubleMap.values() . |
K |
firstKey()
Returns the first key of this map in iteration order.
|
double |
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.
|
double |
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.
|
double |
getDouble(java.lang.Object k)
Returns the value to which the given key is mapped.
|
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.
|
Object2DoubleSortedMap<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-sorted-set view of the keys of this map.
|
K |
lastKey()
Returns the last key of this map in iteration order.
|
Object2DoubleSortedMap.FastSortedEntrySet<K> |
object2DoubleEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
double |
put(K k,
double v)
Adds a pair to the map.
|
java.lang.Double |
put(K ok,
java.lang.Double ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(java.util.Map<? extends K,? extends java.lang.Double> m)
Puts all pairs in the given map.
|
double |
putAndMoveToFirst(K k,
double v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
double |
putAndMoveToLast(K k,
double 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.
|
java.lang.Double |
remove(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
double |
removeDouble(java.lang.Object k)
Removes the mapping with the given key.
|
double |
removeFirstDouble()
Removes the mapping associated with the first key in iteration order.
|
double |
removeLastDouble()
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.
|
Object2DoubleSortedMap<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. |
Object2DoubleSortedMap<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.
|
DoubleCollection |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet
containsValue, equals, toString
defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
public Object2DoubleLinkedOpenHashMap(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 Object2DoubleLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Object2DoubleLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Object2DoubleLinkedOpenHashMap(java.util.Map<? extends K,? extends java.lang.Double> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Object2DoubleLinkedOpenHashMap(java.util.Map<? extends K,? extends java.lang.Double> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.public Object2DoubleLinkedOpenHashMap(Object2DoubleMap<K> m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Object2DoubleLinkedOpenHashMap(Object2DoubleMap<K> 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 Object2DoubleLinkedOpenHashMap(K[] k, double[] 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.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public Object2DoubleLinkedOpenHashMap(K[] k, double[] 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.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public void putAll(java.util.Map<? extends K,? extends java.lang.Double> m)
putAll
in interface java.util.Map<K,java.lang.Double>
putAll
in class AbstractObject2DoubleMap<K>
m
- a map.public double put(K k, double v)
Object2DoubleFunction
put
in interface Object2DoubleFunction<K>
put
in class AbstractObject2DoubleFunction<K>
k
- the key.v
- the value.Function.put(Object,Object)
public java.lang.Double put(K ok, java.lang.Double ov)
AbstractObject2DoubleFunction
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<K,java.lang.Double>
put
in interface java.util.Map<K,java.lang.Double>
put
in class AbstractObject2DoubleFunction<K>
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public double addTo(K k, double 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 double removeDouble(java.lang.Object k)
Object2DoubleFunction
removeDouble
in interface Object2DoubleFunction<K>
removeDouble
in class AbstractObject2DoubleFunction<K>
k
- the key.Function.remove(Object)
public java.lang.Double remove(java.lang.Object ok)
AbstractObject2DoubleFunction
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<K,java.lang.Double>
remove
in interface java.util.Map<K,java.lang.Double>
remove
in class AbstractObject2DoubleFunction<K>
ok
- the key.null
if no value was present for the given key.Map.remove(Object)
public double removeFirstDouble()
java.util.NoSuchElementException
- is this map is empty.public double removeLastDouble()
java.util.NoSuchElementException
- is this map is empty.public double getAndMoveToFirst(K k)
k
- the key.public double getAndMoveToLast(K k)
k
- the key.public double putAndMoveToFirst(K k, double v)
k
- the key.v
- the value.public double putAndMoveToLast(K k, double v)
k
- the key.v
- the value.public double getDouble(java.lang.Object k)
Object2DoubleFunction
getDouble
in interface Object2DoubleFunction<K>
k
- the key.Function.get(Object)
public boolean containsKey(java.lang.Object k)
AbstractObject2DoubleMap
AbstractObject2DoubleMap.keySet()
.containsKey
in interface Function<K,java.lang.Double>
containsKey
in interface java.util.Map<K,java.lang.Double>
containsKey
in class AbstractObject2DoubleMap<K>
k
- the key.key
.Map.containsKey(Object)
public boolean containsValue(double v)
AbstractObject2DoubleMap
AbstractObject2DoubleMap.values()
.containsValue
in interface Object2DoubleMap<K>
containsValue
in class AbstractObject2DoubleMap<K>
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()
isEmpty
in interface java.util.Map<K,java.lang.Double>
isEmpty
in class AbstractObject2DoubleMap<K>
@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 K firstKey()
firstKey
in interface java.util.SortedMap<K,java.lang.Double>
public K lastKey()
lastKey
in interface java.util.SortedMap<K,java.lang.Double>
public java.util.Comparator<? super K> comparator()
Object2DoubleSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Object2DoubleSortedMap<K>
comparator
in interface java.util.SortedMap<K,java.lang.Double>
SortedMap.comparator()
public Object2DoubleSortedMap<K> tailMap(K from)
Object2DoubleSortedMap
fromKey
.
Note that this specification strengthens the one given in SortedMap.tailMap(Object)
.
tailMap
in interface Object2DoubleSortedMap<K>
tailMap
in interface java.util.SortedMap<K,java.lang.Double>
SortedMap.tailMap(Object)
public Object2DoubleSortedMap<K> headMap(K to)
Object2DoubleSortedMap
toKey
.
Note that this specification strengthens the one given in SortedMap.headMap(Object)
.
headMap
in interface Object2DoubleSortedMap<K>
headMap
in interface java.util.SortedMap<K,java.lang.Double>
SortedMap.headMap(Object)
public Object2DoubleSortedMap<K> subMap(K from, K to)
Object2DoubleSortedMap
fromKey
, inclusive, to toKey
, exclusive.
Note that this specification strengthens the one given in SortedMap.subMap(Object,Object)
.
subMap
in interface Object2DoubleSortedMap<K>
subMap
in interface java.util.SortedMap<K,java.lang.Double>
SortedMap.subMap(Object,Object)
public Object2DoubleSortedMap.FastSortedEntrySet<K> object2DoubleEntrySet()
Object2DoubleSortedMap
object2DoubleEntrySet
in interface Object2DoubleMap<K>
object2DoubleEntrySet
in interface Object2DoubleSortedMap<K>
Object2DoubleSortedMap.entrySet()
public ObjectSortedSet<K> keySet()
AbstractObject2DoubleSortedMap
The view is backed by the sorted set returned by AbstractObject2DoubleSortedMap.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 Object2DoubleMap<K>
keySet
in interface Object2DoubleSortedMap<K>
keySet
in interface java.util.Map<K,java.lang.Double>
keySet
in interface java.util.SortedMap<K,java.lang.Double>
keySet
in class AbstractObject2DoubleSortedMap<K>
Map.keySet()
public DoubleCollection values()
AbstractObject2DoubleSortedMap
The view is backed by the sorted set returned by AbstractObject2DoubleSortedMap.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 Object2DoubleMap<K>
values
in interface Object2DoubleSortedMap<K>
values
in interface java.util.Map<K,java.lang.Double>
values
in interface java.util.SortedMap<K,java.lang.Double>
values
in class AbstractObject2DoubleSortedMap<K>
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 Object2DoubleLinkedOpenHashMap<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.
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<K,java.lang.Double>
hashCode
in class AbstractObject2DoubleMap<K>