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

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction<K>
      extended by it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap<K>
          extended by it.unimi.dsi.fastutil.objects.AbstractObject2BooleanSortedMap<K>
              extended by it.unimi.dsi.fastutil.objects.Object2BooleanLinkedOpenHashMap<K>
All Implemented Interfaces:
Function<K,Boolean>, Hash, Object2BooleanFunction<K>, Object2BooleanMap<K>, Object2BooleanSortedMap<K>, Serializable, Cloneable, Map<K,Boolean>, SortedMap<K,Boolean>

public class Object2BooleanLinkedOpenHashMap<K>
extends AbstractObject2BooleanSortedMap<K>
implements Serializable, Cloneable, Hash

A type-specific linked hash map with with a fast, small-footprint implementation.

Instances of this class use a hash table to represent a map. The table is enlarged as needed 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.

The enlargement speed is controlled by the growth factor, a positive number. If the growth factor is p, then the table is enlarged each time roughly by a factor 2p/16. By default, p is Hash.DEFAULT_GROWTH_FACTOR, which means that the table is doubled at each enlargement, but one can easily set more or less aggressive policies by calling growthFactor(int) (note that the growth factor is not serialized: deserialized tables gets the default growth factor).

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.

The iterators provided by the views of this class using are type-specific list iterators. However, creation of an iterator using a starting point is going to be very expensive, as the chosen starting point must be linearly searched for, unless it is lastKey(), in which case the iterator is created in constant time.

Note that deletions in a linked table require scanning the list until the element to be removed is found. The only exceptions are the first element, the last element, and deletions performed using an iterator.

See Also:
Hash, HashCommon, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap
AbstractObject2BooleanMap.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.Object2BooleanSortedMap
Object2BooleanSortedMap.FastSortedEntrySet<K>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanMap
Object2BooleanMap.Entry<K>, Object2BooleanMap.FastEntrySet<K>
 
Field Summary
static long serialVersionUID
           
 
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
Object2BooleanLinkedOpenHashMap()
          Creates a new hash map with Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.
Object2BooleanLinkedOpenHashMap(int n)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
Object2BooleanLinkedOpenHashMap(int n, float f)
          Creates a new hash map.
Object2BooleanLinkedOpenHashMap(K[] k, boolean[] v)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.
Object2BooleanLinkedOpenHashMap(K[] k, boolean[] v, float f)
          Creates a new hash map using the elements of two parallel arrays.
Object2BooleanLinkedOpenHashMap(Map<? extends K,? extends Boolean> m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
Object2BooleanLinkedOpenHashMap(Map<? extends K,? extends Boolean> m, float f)
          Creates a new hash map copying a given one.
Object2BooleanLinkedOpenHashMap(Object2BooleanMap<K> m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
Object2BooleanLinkedOpenHashMap(Object2BooleanMap<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).
 Object clone()
          Returns a deep copy of this map.
 Comparator<? super K> comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(Object k)
          Checks whether the given value is contained in AbstractObject2BooleanMap.keySet().
 boolean containsValue(boolean v)
          Checks whether the given value is contained in AbstractObject2BooleanMap.values().
 K firstKey()
          Returns the first key of this map in iteration order.
 boolean getBoolean(Object k)
          Returns the value to which the given key is mapped.
 int growthFactor()
          Gets the growth factor.
 void growthFactor(int growthFactor)
          Sets the growth factor.
 int hashCode()
          Returns a hash code for this map.
 Object2BooleanSortedMap<K> headMap(K to)
          Delegates to the corresponding type-specific method.
 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.
 Object2BooleanSortedMap.FastSortedEntrySet<K> object2BooleanEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 boolean put(K k, boolean v)
          Adds a pair to the map.
 Boolean put(K ok, Boolean ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean rehash()
          Rehashes this map without changing the table size.
 Boolean remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean removeBoolean(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.
 Object2BooleanSortedMap<K> subMap(K from, K to)
          Delegates to the corresponding type-specific method.
 Object2BooleanSortedMap<K> tailMap(K from)
          Delegates to the corresponding type-specific method.
 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 collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanSortedMap
entrySet
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap
containsValue, equals, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction
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.Object2BooleanFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get
 
Methods inherited from interface java.util.Map
containsValue, equals, get, putAll
 
Methods inherited from interface java.util.Map
containsValue, equals, get, putAll
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(int n,
                                       float f)
Creates a new hash map. The actual table size is the least available prime greater than n/f.

Parameters:
n - the expected number of elements in the hash map.
f - the load factor.
See Also:
Hash.PRIMES

Object2BooleanLinkedOpenHashMap

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

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

Object2BooleanLinkedOpenHashMap

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


Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(Map<? extends K,? extends 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.

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(Map<? extends K,? extends 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.

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(Object2BooleanMap<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.

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(Object2BooleanMap<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.

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(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:
IllegalArgumentException - if k and v have different lengths.

Object2BooleanLinkedOpenHashMap

public Object2BooleanLinkedOpenHashMap(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:
IllegalArgumentException - if k and v have different lengths.
Method Detail

growthFactor

public void growthFactor(int growthFactor)
Sets the growth factor. Subsequent enlargements will increase the table size roughly by a multiplicative factor of 2p/16.

Parameters:
growthFactor - the new growth factor; it must be positive.

growthFactor

public int growthFactor()
Gets the growth factor.

Returns:
the growth factor of this set.
See Also:
growthFactor(int)

put

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

Specified by:
put in interface Object2BooleanFunction<K>
Overrides:
put in class AbstractObject2BooleanFunction<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 Boolean put(K ok,
                   Boolean ov)
Description copied from class: AbstractObject2BooleanFunction
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,Boolean>
Specified by:
put in interface Map<K,Boolean>
Overrides:
put in class AbstractObject2BooleanFunction<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)

containsValue

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

Specified by:
containsValue in interface Object2BooleanMap<K>
Overrides:
containsValue in class AbstractObject2BooleanMap<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,Boolean>
Specified by:
clear in interface Map<K,Boolean>
Overrides:
clear in class AbstractObject2BooleanFunction<K>
See Also:
Map.clear()

firstKey

public K firstKey()
Returns the first key of this map in iteration order.

Specified by:
firstKey in interface SortedMap<K,Boolean>
Returns:
the first key in iteration order.

lastKey

public K lastKey()
Returns the last key of this map in iteration order.

Specified by:
lastKey in interface SortedMap<K,Boolean>
Returns:
the last key in iteration order.

comparator

public Comparator<? super K> comparator()
Description copied from interface: Object2BooleanSortedMap
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

Specified by:
comparator in interface Object2BooleanSortedMap<K>
Specified by:
comparator in interface SortedMap<K,Boolean>
See Also:
SortedMap.comparator()

tailMap

public Object2BooleanSortedMap<K> tailMap(K from)
Description copied from class: AbstractObject2BooleanSortedMap
Delegates to the corresponding type-specific method.

Specified by:
tailMap in interface Object2BooleanSortedMap<K>
Specified by:
tailMap in interface SortedMap<K,Boolean>
Overrides:
tailMap in class AbstractObject2BooleanSortedMap<K>
See Also:
SortedMap.tailMap(Object)

headMap

public Object2BooleanSortedMap<K> headMap(K to)
Description copied from class: AbstractObject2BooleanSortedMap
Delegates to the corresponding type-specific method.

Specified by:
headMap in interface Object2BooleanSortedMap<K>
Specified by:
headMap in interface SortedMap<K,Boolean>
Overrides:
headMap in class AbstractObject2BooleanSortedMap<K>
See Also:
SortedMap.headMap(Object)

subMap

public Object2BooleanSortedMap<K> subMap(K from,
                                         K to)
Description copied from class: AbstractObject2BooleanSortedMap
Delegates to the corresponding type-specific method.

Specified by:
subMap in interface Object2BooleanSortedMap<K>
Specified by:
subMap in interface SortedMap<K,Boolean>
Overrides:
subMap in class AbstractObject2BooleanSortedMap<K>
See Also:
SortedMap.subMap(Object,Object)

containsKey

public boolean containsKey(Object k)
Description copied from class: AbstractObject2BooleanMap
Checks whether the given value is contained in AbstractObject2BooleanMap.keySet().

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

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,Boolean>
Specified by:
size in interface Map<K,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 Map<K,Boolean>
Overrides:
isEmpty in class AbstractObject2BooleanMap<K>

getBoolean

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

Specified by:
getBoolean in interface Object2BooleanFunction<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)

removeBoolean

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

Specified by:
removeBoolean in interface Object2BooleanFunction<K>
Overrides:
removeBoolean in class AbstractObject2BooleanFunction<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 Boolean remove(Object ok)
Description copied from class: AbstractObject2BooleanFunction
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,Boolean>
Specified by:
remove in interface Map<K,Boolean>
Overrides:
remove in class AbstractObject2BooleanFunction<K>
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

object2BooleanEntrySet

public Object2BooleanSortedMap.FastSortedEntrySet<K> object2BooleanEntrySet()
Description copied from interface: Object2BooleanMap
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 Object2BooleanMap.entrySet() so that it returns an ObjectSet of objects of type Object2BooleanMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

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

keySet

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

The view is backed by the sorted set returned by AbstractObject2BooleanSortedMap.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 Object2BooleanMap<K>
Specified by:
keySet in interface Object2BooleanSortedMap<K>
Specified by:
keySet in interface Map<K,Boolean>
Overrides:
keySet in class AbstractObject2BooleanSortedMap<K>
Returns:
a sorted 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: AbstractObject2BooleanSortedMap
Returns a type-specific collection view of the values contained in this map.

The view is backed by the sorted set returned by AbstractObject2BooleanSortedMap.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 Object2BooleanMap<K>
Specified by:
values in interface Object2BooleanSortedMap<K>
Specified by:
values in interface Map<K,Boolean>
Overrides:
values in class AbstractObject2BooleanSortedMap<K>
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

rehash

public boolean rehash()
Rehashes this map without changing the table size.

This method should be called when the map underwent numerous deletions and insertions. In this case, free entries become rare, and unsuccessful searches require probing all entries. For reasonable load factors this method is linear in the number of entries. You will need as much additional free memory as that occupied by the table.

If you need to reduce the table siza to fit exactly this map, you must use trim().

Returns:
true if there was enough memory to rehash the map, false otherwise.
See Also:
trim()

trim

public boolean trim()
Rehashes the map, making the table as small as possible.

This method rehashes to the smallest size satisfying the load factor. It can be used when the map will not be changed anymore, so to optimize access speed (by collecting deleted entries) and size.

If the table size is already the minimum possible, this method does nothing. If you want to guarantee rehashing, use rehash().

Returns:
true if there was enough memory to trim the map.
See Also:
trim(int), rehash()

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

clone

public Object 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 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 Map<K,Boolean>
Overrides:
hashCode in class AbstractObject2BooleanMap<K>
Returns:
a hash code for this map.