it.unimi.dsi.fastutil.objects
Class Reference2BooleanArrayMap<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.Reference2BooleanArrayMap<K>
All Implemented Interfaces:
Function<K,Boolean>, Reference2BooleanFunction<K>, Reference2BooleanMap<K>, Serializable, Cloneable, Map<K,Boolean>

public class Reference2BooleanArrayMap<K>
extends AbstractReference2BooleanMap<K>
implements Serializable, Cloneable

A simple, brute-force implementation of a map based on two parallel backing arrays.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of pairs: just put them into two parallel arrays and scan linearly to find an item.

See Also:
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.objects.Reference2BooleanMap
Reference2BooleanMap.Entry<K>, Reference2BooleanMap.FastEntrySet<K>
 
Field Summary
 
Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction
defRetValue
 
Constructor Summary
Reference2BooleanArrayMap()
          Creates a new empty array map.
Reference2BooleanArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Reference2BooleanArrayMap(Map<? extends K,? extends Boolean> m)
          Creates a new empty array map copying the entries of a given map.
Reference2BooleanArrayMap(Object[] key, boolean[] value)
          Creates a new empty array map with given key and value backing arrays.
Reference2BooleanArrayMap(Object[] key, boolean[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Reference2BooleanArrayMap(Reference2BooleanMap<K> m)
          Creates a new empty array map copying the entries of a given map.
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Reference2BooleanArrayMap<K> clone()
          Returns a deep copy of this map.
 boolean containsKey(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(Object k)
          Returns the value to which the given key is mapped.
 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.
 Reference2BooleanMap.FastEntrySet<K> reference2BooleanEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 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.
 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, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction
defaultReturnValue, defaultReturnValue, get, put, remove
 
Methods inherited from class java.lang.Object
finalize, 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, put, remove
 
Methods inherited from interface java.util.Map
get, put, remove
 

Constructor Detail

Reference2BooleanArrayMap

public Reference2BooleanArrayMap(Object[] key,
                                 boolean[] value)
Creates a new empty array map with given key and value backing arrays. The resulting map will have as many entries as the given arrays.

It is responsibility of the caller that the elements of key are distinct.

Parameters:
key - the key array.
value - the value array (it must have the same length as key).

Reference2BooleanArrayMap

public Reference2BooleanArrayMap()
Creates a new empty array map.


Reference2BooleanArrayMap

public Reference2BooleanArrayMap(int capacity)
Creates a new empty array map of given capacity.

Parameters:
capacity - the initial capacity.

Reference2BooleanArrayMap

public Reference2BooleanArrayMap(Reference2BooleanMap<K> m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Reference2BooleanArrayMap

public Reference2BooleanArrayMap(Map<? extends K,? extends Boolean> m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Reference2BooleanArrayMap

public Reference2BooleanArrayMap(Object[] key,
                                 boolean[] value,
                                 int size)
Creates a new array map with given key and value backing arrays, using the given number of elements.

It is responsibility of the caller that the first size elements of key are distinct.

Parameters:
key - the key array.
value - the value array (it must have the same length as key).
size - the number of valid elements in key and value.
Method Detail

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

getBoolean

public boolean getBoolean(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)

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.

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 AbstractReference2BooleanFunction<K>
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Function<K,Boolean>
Specified by:
containsKey in interface Map<K,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)

isEmpty

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

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)

removeBoolean

public boolean removeBoolean(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)

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 Map<K,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 Map<K,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()

clone

public Reference2BooleanArrayMap<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 Object
Returns:
a deep copy of this map.


Copyright © 2011. All Rights Reserved.