it.unimi.dsi.fastutil.chars
Class Char2CharArrayMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction
      extended by it.unimi.dsi.fastutil.chars.AbstractChar2CharMap
          extended by it.unimi.dsi.fastutil.chars.Char2CharArrayMap
All Implemented Interfaces:
Char2CharFunction, Char2CharMap, Function<Character,Character>, Serializable, Cloneable, Map<Character,Character>

public class Char2CharArrayMap
extends AbstractChar2CharMap
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.chars.AbstractChar2CharMap
AbstractChar2CharMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2CharMap
Char2CharMap.Entry, Char2CharMap.FastEntrySet
 
Constructor Summary
Char2CharArrayMap()
          Creates a new empty array map.
Char2CharArrayMap(char[] key, char[] value)
          Creates a new empty array map with given key and value backing arrays.
Char2CharArrayMap(char[] key, char[] value, int size)
          Creates a new array map with given key and value backing arrays, using the given number of elements.
Char2CharArrayMap(Char2CharMap m)
          Creates a new empty array map copying the entries of a given map.
Char2CharArrayMap(int capacity)
          Creates a new empty array map of given capacity.
Char2CharArrayMap(Map<? extends Character,? extends Character> m)
          Creates a new empty array map copying the entries of a given map.
 
Method Summary
 Char2CharMap.FastEntrySet char2CharEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 Char2CharArrayMap clone()
          Returns a deep copy of this map.
 boolean containsKey(char k)
          Checks whether the given value is contained in AbstractChar2CharMap.keySet().
 boolean containsValue(char v)
          Checks whether the given value is contained in AbstractChar2CharMap.values().
 char get(char k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 CharSet keySet()
          Returns a type-specific-set view of the keys of this map.
 char put(char k, char v)
          Adds a pair to the map.
 char remove(char 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.
 CharCollection values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2CharMap
containsValue, entrySet, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction
containsKey, defaultReturnValue, defaultReturnValue, get, put, remove
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2CharFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get, put, remove
 
Methods inherited from interface java.util.Map
containsKey, get, put, remove
 

Constructor Detail

Char2CharArrayMap

public Char2CharArrayMap(char[] key,
                         char[] 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).

Char2CharArrayMap

public Char2CharArrayMap()
Creates a new empty array map.


Char2CharArrayMap

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

Parameters:
capacity - the initial capacity.

Char2CharArrayMap

public Char2CharArrayMap(Char2CharMap m)
Creates a new empty array map copying the entries of a given map.

Parameters:
m - a map.

Char2CharArrayMap

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

Parameters:
m - a map.

Char2CharArrayMap

public Char2CharArrayMap(char[] key,
                         char[] 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

char2CharEntrySet

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

Specified by:
char2CharEntrySet in interface Char2CharMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Char2CharMap.entrySet()

get

public char get(char k)
Description copied from interface: Char2CharFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Char2CharFunction
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<Character,Character>
Specified by:
size in interface Map<Character,Character>
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<Character,Character>
Specified by:
clear in interface Map<Character,Character>
Overrides:
clear in class AbstractChar2CharFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Char2CharFunction
Overrides:
containsKey in class AbstractChar2CharMap
See Also:
Function.containsKey(Object)

containsValue

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

Specified by:
containsValue in interface Char2CharMap
Overrides:
containsValue in class AbstractChar2CharMap
See Also:
Map.containsValue(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map<Character,Character>
Overrides:
isEmpty in class AbstractChar2CharMap

put

public char put(char k,
                char v)
Description copied from interface: Char2CharFunction
Adds a pair to the map.

Specified by:
put in interface Char2CharFunction
Overrides:
put in class AbstractChar2CharFunction
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)

remove

public char remove(char k)
Description copied from interface: Char2CharFunction
Removes the mapping with the given key.

Specified by:
remove in interface Char2CharFunction
Overrides:
remove in class AbstractChar2CharFunction
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 CharSet keySet()
Description copied from class: AbstractChar2CharMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by AbstractChar2CharMap.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 Char2CharMap
Specified by:
keySet in interface Map<Character,Character>
Overrides:
keySet in class AbstractChar2CharMap
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 CharCollection values()
Description copied from class: AbstractChar2CharMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by AbstractChar2CharMap.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 Char2CharMap
Specified by:
values in interface Map<Character,Character>
Overrides:
values in class AbstractChar2CharMap
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 Char2CharArrayMap 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.