public class Long2BooleanOpenCustomHashMap extends AbstractLong2BooleanMap 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.
Warning: The implementation of this class has significantly
changed in fastutil
6.1.0. Please read the
comments about this issue in the section “Faster Hash Tables” of the overview.
Hash
,
HashCommon
,
Serialized FormAbstractLong2BooleanMap.BasicEntry
Hash.Strategy<K>
Long2BooleanMap.Entry, Long2BooleanMap.FastEntrySet
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
Constructor and Description |
---|
Long2BooleanOpenCustomHashMap(int expected,
float f,
LongHash.Strategy strategy)
Creates a new hash map.
|
Long2BooleanOpenCustomHashMap(int expected,
LongHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Long2BooleanOpenCustomHashMap(long[] k,
boolean[] v,
float f,
LongHash.Strategy strategy)
Creates a new hash map using the elements of two parallel arrays.
|
Long2BooleanOpenCustomHashMap(long[] k,
boolean[] v,
LongHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Long2BooleanOpenCustomHashMap(Long2BooleanMap m,
float f,
LongHash.Strategy strategy)
Creates a new hash map copying a given type-specific one.
|
Long2BooleanOpenCustomHashMap(Long2BooleanMap m,
LongHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Long2BooleanOpenCustomHashMap(LongHash.Strategy strategy)
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Long2BooleanOpenCustomHashMap(Map<? extends Long,? extends Boolean> m,
float f,
LongHash.Strategy strategy)
Creates a new hash map copying a given one.
|
Long2BooleanOpenCustomHashMap(Map<? extends Long,? extends Boolean> m,
LongHash.Strategy strategy)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all associations from this function (optional operation).
|
Long2BooleanOpenCustomHashMap |
clone()
Returns a deep copy of this map.
|
boolean |
containsKey(long k)
Checks whether the given value is contained in
AbstractLong2BooleanMap.keySet() . |
boolean |
containsValue(boolean v)
Checks whether the given value is contained in
AbstractLong2BooleanMap.values() . |
boolean |
get(long k)
Returns the value to which the given key is mapped.
|
Boolean |
get(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.
|
Long2BooleanMap.FastEntrySet |
long2BooleanEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
boolean |
put(long k,
boolean v)
Adds a pair to the map.
|
Boolean |
put(Long ok,
Boolean ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
boolean |
rehash()
Deprecated.
A no-op.
|
boolean |
remove(long k)
Removes the mapping with the given key.
|
Boolean |
remove(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.
|
LongHash.Strategy |
strategy()
Returns the hashing strategy.
|
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-set view of the values of this map.
|
containsValue, entrySet, equals, putAll, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
containsKey, get
public Long2BooleanOpenCustomHashMap(int expected, float f, LongHash.Strategy 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 set.f
- the load factor.strategy
- the strategy.public Long2BooleanOpenCustomHashMap(int expected, LongHash.Strategy strategy)
Hash.DEFAULT_LOAD_FACTOR
as load factor.expected
- the expected number of elements in the hash map.strategy
- the strategy.public Long2BooleanOpenCustomHashMap(LongHash.Strategy strategy)
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.strategy
- the strategy.public Long2BooleanOpenCustomHashMap(Map<? extends Long,? extends Boolean> m, float f, LongHash.Strategy strategy)
m
- a Map
to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Long2BooleanOpenCustomHashMap(Map<? extends Long,? extends Boolean> m, LongHash.Strategy 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 Long2BooleanOpenCustomHashMap(Long2BooleanMap m, float f, LongHash.Strategy strategy)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.strategy
- the strategy.public Long2BooleanOpenCustomHashMap(Long2BooleanMap m, LongHash.Strategy 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 Long2BooleanOpenCustomHashMap(long[] k, boolean[] v, float f, LongHash.Strategy 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.IllegalArgumentException
- if k
and v
have different lengths.public Long2BooleanOpenCustomHashMap(long[] k, boolean[] v, LongHash.Strategy 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.IllegalArgumentException
- if k
and v
have different lengths.public LongHash.Strategy strategy()
public boolean put(long k, boolean v)
Long2BooleanFunction
put
in interface Long2BooleanFunction
put
in class AbstractLong2BooleanFunction
k
- the key.v
- the value.Function.put(Object,Object)
public Boolean put(Long ok, Boolean ov)
AbstractLong2BooleanFunction
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<Long,Boolean>
put
in interface Map<Long,Boolean>
put
in class AbstractLong2BooleanFunction
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public boolean remove(long k)
Long2BooleanFunction
remove
in interface Long2BooleanFunction
remove
in class AbstractLong2BooleanFunction
Function.remove(Object)
public Boolean remove(Object ok)
AbstractLong2BooleanFunction
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 get(long k)
Long2BooleanFunction
get
in interface Long2BooleanFunction
k
- the key.Function.get(Object)
public boolean containsKey(long k)
AbstractLong2BooleanMap
AbstractLong2BooleanMap.keySet()
.containsKey
in interface Long2BooleanFunction
containsKey
in class AbstractLong2BooleanMap
Function.containsKey(Object)
public boolean containsValue(boolean v)
AbstractLong2BooleanMap
AbstractLong2BooleanMap.values()
.containsValue
in interface Long2BooleanMap
containsValue
in class AbstractLong2BooleanMap
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 Long2BooleanMap.FastEntrySet long2BooleanEntrySet()
Long2BooleanMap
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Long2BooleanMap.entrySet()
so that it returns an ObjectSet
of objects of type Map.Entry
(the latter makes it possible to
access keys and values with type-specific methods).
long2BooleanEntrySet
in interface Long2BooleanMap
Long2BooleanMap.entrySet()
public LongSet keySet()
AbstractLong2BooleanMap
The view is backed by the set returned by AbstractLong2BooleanMap.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 Long2BooleanMap
keySet
in interface Map<Long,Boolean>
keySet
in class AbstractLong2BooleanMap
Map.keySet()
public BooleanCollection values()
AbstractLong2BooleanMap
The view is backed by the set returned by AbstractLong2BooleanMap.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 Long2BooleanMap
values
in interface Map<Long,Boolean>
values
in class AbstractLong2BooleanMap
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 Long2BooleanOpenCustomHashMap 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.