public class Long2LongOpenHashMap extends AbstractLong2LongMap 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.
Hash
,
HashCommon
,
Serialized FormAbstractLong2LongMap.BasicEntry
Hash.Strategy<K>
Long2LongMap.Entry, Long2LongMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Long2LongOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Long2LongOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Long2LongOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Long2LongOpenHashMap(long[] k,
long[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Long2LongOpenHashMap(long[] k,
long[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Long2LongOpenHashMap(Long2LongMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Long2LongOpenHashMap(Long2LongMap m,
float f)
Creates a new hash map copying a given type-specific one.
|
Long2LongOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Long2LongOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> m,
float f)
Creates a new hash map copying a given one.
|
Modifier and Type | Method and Description |
---|---|
long |
addTo(long k,
long incr)
Adds an increment to value currently associated with a key.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Long2LongOpenHashMap |
clone()
Returns a deep copy of this map.
|
boolean |
containsKey(long k)
Checks whether the given value is contained in
AbstractLong2LongMap.keySet() . |
boolean |
containsValue(long v)
Checks whether the given value is contained in
AbstractLong2LongMap.values() . |
long |
get(long k)
Returns the value to which the given key is mapped.
|
java.lang.Long |
get(java.lang.Long ok) |
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.
|
boolean |
isEmpty() |
LongSet |
keySet()
Returns a type-specific-set view of the keys of this map.
|
Long2LongMap.FastEntrySet |
long2LongEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
long |
put(long k,
long v)
Adds a pair to the map.
|
java.lang.Long |
put(java.lang.Long ok,
java.lang.Long ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
void |
putAll(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> m)
Puts all pairs in the given map.
|
boolean |
rehash()
Deprecated.
A no-op.
|
long |
remove(long k)
Removes the mapping with the given key.
|
java.lang.Long |
remove(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
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.
|
LongCollection |
values()
Returns a type-specific-set view of the values of this map.
|
containsValue, entrySet, equals, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
public Long2LongOpenHashMap(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 Long2LongOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.public Long2LongOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.public Long2LongOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Long2LongOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Long> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.m
- a Map
to be copied into the new hash map.public Long2LongOpenHashMap(Long2LongMap m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Long2LongOpenHashMap(Long2LongMap 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 Long2LongOpenHashMap(long[] k, long[] 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 Long2LongOpenHashMap(long[] k, long[] 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 java.lang.Long,? extends java.lang.Long> m)
putAll
in interface java.util.Map<java.lang.Long,java.lang.Long>
putAll
in class AbstractLong2LongMap
m
- a map.public long put(long k, long v)
Long2LongFunction
put
in interface Long2LongFunction
put
in class AbstractLong2LongFunction
k
- the key.v
- the value.Function.put(Object,Object)
public java.lang.Long put(java.lang.Long ok, java.lang.Long ov)
AbstractLong2LongFunction
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<java.lang.Long,java.lang.Long>
put
in interface java.util.Map<java.lang.Long,java.lang.Long>
put
in class AbstractLong2LongFunction
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public long addTo(long k, long 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 long remove(long k)
Long2LongFunction
remove
in interface Long2LongFunction
remove
in class AbstractLong2LongFunction
k
- the key.Function.remove(Object)
public java.lang.Long remove(java.lang.Object ok)
AbstractLong2LongFunction
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<java.lang.Long,java.lang.Long>
remove
in interface java.util.Map<java.lang.Long,java.lang.Long>
remove
in class AbstractLong2LongFunction
ok
- the key.null
if no value was present for the given key.Map.remove(Object)
public java.lang.Long get(java.lang.Long ok)
public long get(long k)
Long2LongFunction
get
in interface Long2LongFunction
k
- the key.Function.get(Object)
public boolean containsKey(long k)
AbstractLong2LongMap
AbstractLong2LongMap.keySet()
.containsKey
in interface Long2LongFunction
containsKey
in class AbstractLong2LongMap
Function.containsKey(Object)
public boolean containsValue(long v)
AbstractLong2LongMap
AbstractLong2LongMap.values()
.containsValue
in interface Long2LongMap
containsValue
in class AbstractLong2LongMap
Map.containsValue(Object)
public void clear()
Function
clear
in interface Function<java.lang.Long,java.lang.Long>
clear
in interface java.util.Map<java.lang.Long,java.lang.Long>
clear
in class AbstractLong2LongFunction
Map.clear()
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<java.lang.Long,java.lang.Long>
isEmpty
in class AbstractLong2LongMap
@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 Long2LongMap.FastEntrySet long2LongEntrySet()
Long2LongMap
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Long2LongMap.entrySet()
so that it returns an ObjectSet
of type-specific entries (the latter makes it possible to
access keys and values with type-specific methods).
long2LongEntrySet
in interface Long2LongMap
Long2LongMap.entrySet()
public LongSet keySet()
AbstractLong2LongMap
The view is backed by the set returned by AbstractLong2LongMap.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 Long2LongMap
keySet
in interface java.util.Map<java.lang.Long,java.lang.Long>
keySet
in class AbstractLong2LongMap
Map.keySet()
public LongCollection values()
AbstractLong2LongMap
The view is backed by the set returned by AbstractLong2LongMap.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 Long2LongMap
values
in interface java.util.Map<java.lang.Long,java.lang.Long>
values
in class AbstractLong2LongMap
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 Long2LongOpenHashMap 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<java.lang.Long,java.lang.Long>
hashCode
in class AbstractLong2LongMap