it.unimi.dsi.fastutil.objects
Class Reference2BooleanOpenHashMap<K>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction<K>
      extended by it.unimi.dsi.fastutil.objects.AbstractReference2BooleanMap<K>
          extended by it.unimi.dsi.fastutil.objects.Reference2BooleanOpenHashMap<K>
All Implemented Interfaces:
Function<K,java.lang.Boolean>, Hash, Reference2BooleanFunction<K>, Reference2BooleanMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.Map<K,java.lang.Boolean>

public class Reference2BooleanOpenHashMap<K>
extends AbstractReference2BooleanMap<K>
implements java.io.Serializable, java.lang.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 it.unimi.dsi.fastutil.objects.AbstractReference2BooleanMap
AbstractReference2BooleanMap.BasicEntry<K>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
Hash.Strategy<K>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2BooleanMap
Reference2BooleanMap.Entry<K>, Reference2BooleanMap.FastEntrySet<K>
 
Field Summary
 
Fields inherited from interface it.unimi.dsi.fastutil.Hash
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
 
Constructor Summary
Reference2BooleanOpenHashMap()
          Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.
Reference2BooleanOpenHashMap(int expected)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
Reference2BooleanOpenHashMap(int expected, float f)
          Creates a new hash map.
Reference2BooleanOpenHashMap(K[] k, boolean[] v)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.
Reference2BooleanOpenHashMap(K[] k, boolean[] v, float f)
          Creates a new hash map using the elements of two parallel arrays.
Reference2BooleanOpenHashMap(java.util.Map<? extends K,? extends java.lang.Boolean> m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
Reference2BooleanOpenHashMap(java.util.Map<? extends K,? extends java.lang.Boolean> m, float f)
          Creates a new hash map copying a given one.
Reference2BooleanOpenHashMap(Reference2BooleanMap<K> m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
Reference2BooleanOpenHashMap(Reference2BooleanMap<K> m, float f)
          Creates a new hash map copying a given type-specific one.
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Reference2BooleanOpenHashMap<K> clone()
          Returns a deep copy of this map.
 boolean containsKey(java.lang.Object k)
          Checks whether the given value is contained in AbstractReference2BooleanMap.keySet().
 boolean containsValue(boolean v)
          Checks whether the given value is contained in AbstractReference2BooleanMap.values().
 boolean getBoolean(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.
 boolean isEmpty()
           
 ReferenceSet<K> keySet()
          Returns a type-specific-set view of the keys of this map.
 boolean put(K k, boolean v)
          Adds a pair to the map.
 java.lang.Boolean put(K ok, java.lang.Boolean ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Reference2BooleanMap.FastEntrySet<K> reference2BooleanEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 boolean rehash()
          Deprecated. A no-op.
 java.lang.Boolean remove(java.lang.Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean removeBoolean(java.lang.Object k)
          Removes the mapping with the given 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.
 BooleanCollection values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanMap
containsValue, entrySet, equals, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction
defaultReturnValue, defaultReturnValue, get
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2BooleanFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get
 
Methods inherited from interface java.util.Map
get
 

Constructor Detail

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(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.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(int expected)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.

Parameters:
expected - the expected number of elements in the hash map.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap()
Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.


Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(java.util.Map<? extends K,? extends java.lang.Boolean> m,
                                    float f)
Creates a new hash map copying a given one.

Parameters:
m - a Map to be copied into the new hash map.
f - the load factor.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(java.util.Map<? extends K,? extends java.lang.Boolean> m)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.

Parameters:
m - a Map to be copied into the new hash map.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(Reference2BooleanMap<K> 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.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(Reference2BooleanMap<K> m)
Creates a new hash map with Hash.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.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(K[] k,
                                    boolean[] 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:
java.lang.IllegalArgumentException - if k and v have different lengths.

Reference2BooleanOpenHashMap

public Reference2BooleanOpenHashMap(K[] k,
                                    boolean[] v)
Creates a new hash map with Hash.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:
java.lang.IllegalArgumentException - if k and v have different lengths.
Method Detail

put

public boolean put(K k,
                   boolean v)
Description copied from interface: Reference2BooleanFunction
Adds a pair to the map.

Specified by:
put in interface Reference2BooleanFunction<K>
Overrides:
put in class AbstractReference2BooleanFunction<K>
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 java.lang.Boolean put(K ok,
                             java.lang.Boolean ov)
Description copied from class: AbstractReference2BooleanFunction
Delegates to the corresponding type-specific method, taking care of returning 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.

Specified by:
put in interface Function<K,java.lang.Boolean>
Specified by:
put in interface java.util.Map<K,java.lang.Boolean>
Overrides:
put in class AbstractReference2BooleanFunction<K>
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)

removeBoolean

public boolean removeBoolean(java.lang.Object k)
Description copied from interface: Reference2BooleanFunction
Removes the mapping with the given key.

Specified by:
removeBoolean in interface Reference2BooleanFunction<K>
Overrides:
removeBoolean in class AbstractReference2BooleanFunction<K>
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 java.lang.Boolean remove(java.lang.Object ok)
Description copied from class: AbstractReference2BooleanFunction
Delegates to the corresponding type-specific method, taking care of returning 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.

Specified by:
remove in interface Function<K,java.lang.Boolean>
Specified by:
remove in interface java.util.Map<K,java.lang.Boolean>
Overrides:
remove in class AbstractReference2BooleanFunction<K>
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

getBoolean

public boolean getBoolean(java.lang.Object k)
Description copied from interface: Reference2BooleanFunction
Returns the value to which the given key is mapped.

Specified by:
getBoolean in interface Reference2BooleanFunction<K>
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(java.lang.Object k)
Description copied from class: AbstractReference2BooleanMap
Checks whether the given value is contained in AbstractReference2BooleanMap.keySet().

Specified by:
containsKey in interface Function<K,java.lang.Boolean>
Specified by:
containsKey in interface java.util.Map<K,java.lang.Boolean>
Overrides:
containsKey in class AbstractReference2BooleanMap<K>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(boolean v)
Description copied from class: AbstractReference2BooleanMap
Checks whether the given value is contained in AbstractReference2BooleanMap.values().

Specified by:
containsValue in interface Reference2BooleanMap<K>
Overrides:
containsValue in class AbstractReference2BooleanMap<K>
See Also:
Map.containsValue(Object)

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<K,java.lang.Boolean>
Specified by:
clear in interface java.util.Map<K,java.lang.Boolean>
Overrides:
clear in class AbstractReference2BooleanFunction<K>
See Also:
Map.clear()

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.

Specified by:
size in interface Function<K,java.lang.Boolean>
Specified by:
size in interface java.util.Map<K,java.lang.Boolean>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<K,java.lang.Boolean>
Overrides:
isEmpty in class AbstractReference2BooleanMap<K>

growthFactor

@Deprecated
public void growthFactor(int growthFactor)
Deprecated. Since fastutil 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. Since fastutil 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)

reference2BooleanEntrySet

public Reference2BooleanMap.FastEntrySet<K> reference2BooleanEntrySet()
Description copied from interface: Reference2BooleanMap
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 Reference2BooleanMap.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).

Specified by:
reference2BooleanEntrySet in interface Reference2BooleanMap<K>
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Reference2BooleanMap.entrySet()

keySet

public ReferenceSet<K> keySet()
Description copied from class: AbstractReference2BooleanMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractReference2BooleanMap.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 interface Reference2BooleanMap<K>
Specified by:
keySet in interface java.util.Map<K,java.lang.Boolean>
Overrides:
keySet in class AbstractReference2BooleanMap<K>
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 BooleanCollection values()
Description copied from class: AbstractReference2BooleanMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractReference2BooleanMap.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 interface Reference2BooleanMap<K>
Specified by:
values in interface java.util.Map<K,java.lang.Boolean>
Overrides:
values in class AbstractReference2BooleanMap<K>
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,size()) 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.

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()

clone

public Reference2BooleanOpenHashMap<K> 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.

Overrides:
clone in class java.lang.Object
Returns:
a deep copy of this map.

hashCode

public int hashCode()
Returns a hash code for this map. This method overrides the generic method provided by the superclass. Since 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.

Specified by:
hashCode in interface java.util.Map<K,java.lang.Boolean>
Overrides:
hashCode in class AbstractReference2BooleanMap<K>
Returns:
a hash code for this map.