Class Char2ObjectOpenHashMap<V>
- java.lang.Object
-
- org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction<V>
-
- org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectMap<V>
-
- org.codelibs.jhighlight.fastutil.chars.Char2ObjectOpenHashMap<V>
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Character,V>
,Char2ObjectFunction<V>
,Char2ObjectMap<V>
,Function<Character,V>
,Hash
public class Char2ObjectOpenHashMap<V> extends AbstractChar2ObjectMap<V> implements Serializable, Cloneable, Hash
A type-specific hash map with a fast, small-footprint implementation.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.- See Also:
Hash
,HashCommon
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectMap
AbstractChar2ObjectMap.BasicEntry<V>
-
Nested classes/interfaces inherited from interface org.codelibs.jhighlight.fastutil.chars.Char2ObjectMap
Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>
-
Nested classes/interfaces inherited from interface org.codelibs.jhighlight.fastutil.Hash
Hash.Strategy<K>
-
-
Field Summary
Fields Modifier and Type Field Description protected Char2ObjectMap.FastEntrySet<V>
entries
Cached set of entries.protected float
f
The acceptable load factor.protected char[]
key
The array of keys.protected CharSet
keys
Cached set of keys.protected int
mask
The mask for wrapping a position counter.protected int
maxFill
Threshold after which we rehash.protected int
n
The current table size.protected int
size
Number of entries in the set.protected boolean[]
used
The array telling whether a position is used.protected V[]
value
The array of values.protected ObjectCollection<V>
values
Cached collection of values.-
Fields inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction
defRetValue
-
Fields inherited from interface org.codelibs.jhighlight.fastutil.Hash
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
-
-
Constructor Summary
Constructors Constructor Description Char2ObjectOpenHashMap()
Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor.Char2ObjectOpenHashMap(char[] k, V[] v)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.Char2ObjectOpenHashMap(char[] k, V[] v, float f)
Creates a new hash map using the elements of two parallel arrays.Char2ObjectOpenHashMap(int expected)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.Char2ObjectOpenHashMap(int expected, float f)
Creates a new hash map.Char2ObjectOpenHashMap(Map<? extends Character,? extends V> m)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.Char2ObjectOpenHashMap(Map<? extends Character,? extends V> m, float f)
Creates a new hash map copying a given one.Char2ObjectOpenHashMap(Char2ObjectMap<V> m)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.Char2ObjectOpenHashMap(Char2ObjectMap<V> m, float f)
Creates a new hash map copying a given type-specific one.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Char2ObjectMap.FastEntrySet<V>
char2ObjectEntrySet()
Returns a type-specific set view of the mappings contained in this map.void
clear()
Removes all associations from this function (optional operation).Char2ObjectOpenHashMap<V>
clone()
Returns a deep copy of this map.boolean
containsKey(char k)
Checks whether the given value is contained inAbstractChar2ObjectMap.keySet()
.boolean
containsValue(Object v)
Checks whether the given value is contained inAbstractChar2ObjectMap.values()
.V
get(char k)
Returns the value to which the given key is mapped.V
get(Character ok)
int
growthFactor()
Deprecated.Sincefastutil
6.1.0, hash tables are doubled when they are too full.void
growthFactor(int growthFactor)
Deprecated.Sincefastutil
6.1.0, hash tables are doubled when they are too full.int
hashCode()
Returns a hash code for this map.boolean
isEmpty()
CharSet
keySet()
Returns a type-specific-set view of the keys of this map.V
put(char k, V v)
Adds a pair to the map.V
put(Character ok, V ov)
Delegates to the corresponding type-specific method, taking care of returningnull
on a missing key.boolean
rehash()
Deprecated.A no-op.protected void
rehash(int newN)
Rehashes the map.V
remove(char k)
Removes the mapping with the given key.V
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returningnull
on a missing key.protected int
shiftKeys(int pos)
Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.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.ObjectCollection<V>
values()
Returns a type-specific-set view of the values of this map.-
Methods inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectMap
entrySet, equals, putAll, toString
-
Methods inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction
containsKey, defaultReturnValue, defaultReturnValue, get
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.codelibs.jhighlight.fastutil.chars.Char2ObjectFunction
defaultReturnValue, defaultReturnValue
-
Methods inherited from interface org.codelibs.jhighlight.fastutil.Function
containsKey, get
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, forEach, get, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Field Detail
-
key
protected transient char[] key
The array of keys.
-
value
protected transient V[] value
The array of values.
-
used
protected transient boolean[] used
The array telling whether a position is used.
-
f
protected final float f
The acceptable load factor.
-
n
protected transient int n
The current table size.
-
maxFill
protected transient int maxFill
Threshold after which we rehash. It must be the table size timesf
.
-
mask
protected transient int mask
The mask for wrapping a position counter.
-
size
protected int size
Number of entries in the set.
-
entries
protected transient volatile Char2ObjectMap.FastEntrySet<V> entries
Cached set of entries.
-
keys
protected transient volatile CharSet keys
Cached set of keys.
-
values
protected transient volatile ObjectCollection<V> values
Cached collection of values.
-
-
Constructor Detail
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(int expected, float f)
Creates a new hash map.The actual table size will be the least power of two greater than
expected
/f
.- Parameters:
expected
- the expected number of elements in the hash set.f
- the load factor.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(int expected)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
expected
- the expected number of elements in the hash map.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap()
Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(Map<? extends Character,? extends V> m, float f)
Creates a new hash map copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.f
- the load factor.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(Map<? extends Character,? extends V> m)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(Char2ObjectMap<V> m, float f)
Creates a new hash map copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.f
- the load factor.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(Char2ObjectMap<V> m)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(char[] k, V[] v, float f)
Creates a new hash map using the elements of two parallel arrays.- Parameters:
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.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
Char2ObjectOpenHashMap
public Char2ObjectOpenHashMap(char[] k, V[] v)
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.- Parameters:
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
-
Method Detail
-
put
public V put(char k, V v)
Description copied from interface:Char2ObjectFunction
Adds a pair to the map.- Specified by:
put
in interfaceChar2ObjectFunction<V>
- Overrides:
put
in classAbstractChar2ObjectFunction<V>
- Parameters:
k
- the key.v
- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.put(Object,Object)
-
put
public V put(Character ok, V ov)
Description copied from class:AbstractChar2ObjectFunction
Delegates to the corresponding type-specific method, taking care of returningnull
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.- Specified by:
put
in interfaceFunction<Character,V>
- Specified by:
put
in interfaceMap<Character,V>
- Overrides:
put
in classAbstractChar2ObjectFunction<V>
- Parameters:
ok
- the key.ov
- the value.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
-
shiftKeys
protected final int shiftKeys(int pos)
Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry.- Parameters:
pos
- a starting position.- Returns:
- the position cleared by the shifting process.
-
remove
public V remove(char k)
Description copied from interface:Char2ObjectFunction
Removes the mapping with the given key.- Specified by:
remove
in interfaceChar2ObjectFunction<V>
- Overrides:
remove
in classAbstractChar2ObjectFunction<V>
- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.remove(Object)
-
remove
public V remove(Object ok)
Description copied from class:AbstractChar2ObjectFunction
Delegates to the corresponding type-specific method, taking care of returningnull
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.
-
get
public V get(char k)
Description copied from interface:Char2ObjectFunction
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceChar2ObjectFunction<V>
- Parameters:
k
- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
- See Also:
Function.get(Object)
-
containsKey
public boolean containsKey(char k)
Description copied from class:AbstractChar2ObjectMap
Checks whether the given value is contained inAbstractChar2ObjectMap.keySet()
.- Specified by:
containsKey
in interfaceChar2ObjectFunction<V>
- Overrides:
containsKey
in classAbstractChar2ObjectMap<V>
- See Also:
Function.containsKey(Object)
-
containsValue
public boolean containsValue(Object v)
Description copied from class:AbstractChar2ObjectMap
Checks whether the given value is contained inAbstractChar2ObjectMap.values()
.- Specified by:
containsValue
in interfaceMap<Character,V>
- Overrides:
containsValue
in classAbstractChar2ObjectMap<V>
-
clear
public void clear()
Description copied from interface:Function
Removes all associations from this function (optional operation).
-
size
public int size()
Description copied from interface:Function
Returns the intended number of keys in this function, or -1 if no such number exists.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.
-
isEmpty
public boolean isEmpty()
-
growthFactor
@Deprecated public void growthFactor(int growthFactor)
Deprecated.Sincefastutil
6.1.0, hash tables are doubled when they are too full.A no-op for backward compatibility.- Parameters:
growthFactor
- unused.
-
growthFactor
@Deprecated public int growthFactor()
Deprecated.Sincefastutil
6.1.0, hash tables are doubled when they are too full.Gets the growth factor (2).- Returns:
- the growth factor of this set, which is fixed (2).
- See Also:
growthFactor(int)
-
char2ObjectEntrySet
public Char2ObjectMap.FastEntrySet<V> char2ObjectEntrySet()
Description copied from interface:Char2ObjectMap
Returns a type-specific set view of the mappings contained in this map.This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen
Char2ObjectMap.entrySet()
so that it returns anObjectSet
of objects of typeMap.Entry
(the latter makes it possible to access keys and values with type-specific methods).- Specified by:
char2ObjectEntrySet
in interfaceChar2ObjectMap<V>
- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
Char2ObjectMap.entrySet()
-
keySet
public CharSet keySet()
Description copied from class:AbstractChar2ObjectMap
Returns a type-specific-set view of the keys of this map.The view is backed by the set returned by
AbstractChar2ObjectMap.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.- Specified by:
keySet
in interfaceChar2ObjectMap<V>
- Specified by:
keySet
in interfaceMap<Character,V>
- Overrides:
keySet
in classAbstractChar2ObjectMap<V>
- Returns:
- a set view of the keys of this map; it may be safely cast to a type-specific interface.
- See Also:
Map.keySet()
-
values
public ObjectCollection<V> values()
Description copied from class:AbstractChar2ObjectMap
Returns a type-specific-set view of the values of this map.The view is backed by the set returned by
AbstractChar2ObjectMap.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.- Specified by:
values
in interfaceChar2ObjectMap<V>
- Specified by:
values
in interfaceMap<Character,V>
- Overrides:
values
in classAbstractChar2ObjectMap<V>
- Returns:
- a set view of the values of this map; it may be safely cast to a type-specific interface.
- See Also:
Map.values()
-
rehash
@Deprecated public boolean rehash()
Deprecated.A no-op.A no-op for backward compatibility. The kind of tables implemented by this class never need rehashing.If you need to reduce the table size to fit exactly this set, use
trim()
.- Returns:
- true.
- See Also:
trim()
-
trim
public boolean trim()
Rehashes the map, making the table as small as possible.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.
- Returns:
- true if there was enough memory to trim the map.
- See Also:
trim(int)
-
trim
public boolean trim(int n)
Rehashes this map if the table is too large.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.
- Parameters:
n
- the threshold for the trimming.- Returns:
- true if there was enough memory to trim the map.
- See Also:
trim()
-
rehash
protected void rehash(int newN)
Rehashes the map.This method implements the basic rehashing strategy, and may be overriden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.
- Parameters:
newN
- the new size
-
clone
public Char2ObjectOpenHashMap<V> clone()
Returns a deep copy of this map.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.
-
hashCode
public int hashCode()
Returns a hash code for this map. This method overrides the generic method provided by the superclass. Sinceequals()
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.
-
-