it.unimi.dsi.fastutil.chars
Class Char2ByteAVLTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2ByteFunction
      extended by it.unimi.dsi.fastutil.chars.AbstractChar2ByteMap
          extended by it.unimi.dsi.fastutil.chars.AbstractChar2ByteSortedMap
              extended by it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap
All Implemented Interfaces:
Char2ByteFunction, Char2ByteMap, Char2ByteSortedMap, Function<Character,Byte>, Serializable, Cloneable, Map<Character,Byte>, SortedMap<Character,Byte>

public class Char2ByteAVLTreeMap
extends AbstractChar2ByteSortedMap
implements Serializable, Cloneable

A type-specific AVL tree map with a fast, small-footprint implementation.

The iterators provided by the views of this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteSortedMap
AbstractChar2ByteSortedMap.KeySetIterator, AbstractChar2ByteSortedMap.ValuesCollection, AbstractChar2ByteSortedMap.ValuesIterator
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteMap
AbstractChar2ByteMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ByteSortedMap
Char2ByteSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ByteMap
Char2ByteMap.FastEntrySet
 
Field Summary
protected  CharComparator actualComparator
          This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
protected  int count
          Number of entries in this map.
protected  ObjectSortedSet<Char2ByteMap.Entry> entries
          Cached set of entries.
protected  it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry firstEntry
          The first key in this map.
protected  CharSortedSet keys
          Cached set of keys.
protected  it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry lastEntry
          The last key in this map.
protected  boolean modified
          The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
static long serialVersionUID
           
protected  Comparator<? super Character> storedComparator
          This map's comparator, as provided in the constructor.
protected  it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry tree
          A reference to the root entry.
protected  ByteCollection values
          Cached collection of values.
 
Fields inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteFunction
defRetValue
 
Constructor Summary
Char2ByteAVLTreeMap()
          Creates a new empty tree map.
Char2ByteAVLTreeMap(char[] k, byte[] v)
          Creates a new tree map using the elements of two parallel arrays.
Char2ByteAVLTreeMap(char[] k, byte[] v, Comparator<? super Character> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Char2ByteAVLTreeMap(Char2ByteMap m)
          Creates a new tree map copying a given map.
Char2ByteAVLTreeMap(Char2ByteSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Char2ByteAVLTreeMap(Comparator<? super Character> c)
          Creates a new empty tree map with the given comparator.
Char2ByteAVLTreeMap(Map<? extends Character,? extends Byte> m)
          Creates a new tree map copying a given map.
Char2ByteAVLTreeMap(SortedMap<Character,Byte> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 ObjectSortedSet<Char2ByteMap.Entry> char2ByteEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 Char2ByteAVLTreeMap clone()
          Returns a deep copy of this tree map.
 CharComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(char k)
          Checks whether the given value is contained in AbstractChar2ByteMap.keySet().
 boolean containsValue(byte v)
          Checks whether the given value is contained in AbstractChar2ByteMap.values().
 char firstCharKey()
           
 byte get(char k)
          Returns the value to which the given key is mapped.
 Char2ByteSortedMap headMap(char to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 boolean isEmpty()
           
 CharSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 char lastCharKey()
           
 Byte put(Character ok, Byte ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 byte put(char k, byte v)
          Adds a pair to the map.
 byte remove(char k)
          Removes the mapping with the given key.
 Byte remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Char2ByteSortedMap subMap(char from, char to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Char2ByteSortedMap tailMap(char from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ByteCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ByteFunction
containsKey, defaultReturnValue, defaultReturnValue, get
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ByteFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

tree

protected transient it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry tree
A reference to the root entry.


count

protected int count
Number of entries in this map.


firstEntry

protected transient it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry firstEntry
The first key in this map.


lastEntry

protected transient it.unimi.dsi.fastutil.chars.Char2ByteAVLTreeMap.Entry lastEntry
The last key in this map.


entries

protected transient volatile ObjectSortedSet<Char2ByteMap.Entry> entries
Cached set of entries.


keys

protected transient volatile CharSortedSet keys
Cached set of keys.


values

protected transient volatile ByteCollection values
Cached collection of values.


modified

protected transient boolean modified
The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.


storedComparator

protected Comparator<? super Character> storedComparator
This map's comparator, as provided in the constructor.


actualComparator

protected transient CharComparator actualComparator
This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.


serialVersionUID

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

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap()
Creates a new empty tree map.


Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(Comparator<? super Character> c)
Creates a new empty tree map with the given comparator.

Parameters:
c - a (possibly type-specific) comparator.

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(Map<? extends Character,? extends Byte> m)
Creates a new tree map copying a given map.

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

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(SortedMap<Character,Byte> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a SortedMap to be copied into the new tree map.

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(Char2ByteMap m)
Creates a new tree map copying a given map.

Parameters:
m - a type-specific map to be copied into the new tree map.

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(Char2ByteSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a type-specific sorted map to be copied into the new tree map.

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(char[] k,
                           byte[] v,
                           Comparator<? super Character> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Parameters:
k - the array of keys of the new tree map.
v - the array of corresponding values in the new tree map.
c - a (possibly type-specific) comparator.
Throws:
IllegalArgumentException - if k and v have different lengths.

Char2ByteAVLTreeMap

public Char2ByteAVLTreeMap(char[] k,
                           byte[] v)
Creates a new tree map using the elements of two parallel arrays.

Parameters:
k - the array of keys of the new tree map.
v - the array of corresponding values in the new tree map.
Throws:
IllegalArgumentException - if k and v have different lengths.
Method Detail

put

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

Specified by:
put in interface Char2ByteFunction
Overrides:
put in class AbstractChar2ByteFunction
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 byte remove(char k)
Description copied from interface: Char2ByteFunction
Removes the mapping with the given key.

Specified by:
remove in interface Char2ByteFunction
Overrides:
remove in class AbstractChar2ByteFunction
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

put

public Byte put(Character ok,
                Byte ov)
Description copied from class: AbstractChar2ByteFunction
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<Character,Byte>
Specified by:
put in interface Map<Character,Byte>
Overrides:
put in class AbstractChar2ByteFunction
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)

remove

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

containsValue

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

Specified by:
containsValue in interface Char2ByteMap
Overrides:
containsValue in class AbstractChar2ByteMap
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<Character,Byte>
Specified by:
clear in interface Map<Character,Byte>
Overrides:
clear in class AbstractChar2ByteFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Char2ByteFunction
Overrides:
containsKey in class AbstractChar2ByteMap
See Also:
Function.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<Character,Byte>
Specified by:
size in interface Map<Character,Byte>
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<Character,Byte>
Overrides:
isEmpty in class AbstractChar2ByteMap

get

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

Specified by:
get in interface Char2ByteFunction
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)

firstCharKey

public char firstCharKey()
Specified by:
firstCharKey in interface Char2ByteSortedMap
See Also:
SortedMap.firstKey()

lastCharKey

public char lastCharKey()
Specified by:
lastCharKey in interface Char2ByteSortedMap
See Also:
SortedMap.lastKey()

char2ByteEntrySet

public ObjectSortedSet<Char2ByteMap.Entry> char2ByteEntrySet()
Description copied from interface: Char2ByteSortedMap
Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

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

keySet

public CharSortedSet keySet()
Returns a type-specific sorted set view of the keys contained in this map.

In addition to the semantics of Map.keySet(), you can safely cast the set returned by this call to a type-specific sorted set interface.

Specified by:
keySet in interface Char2ByteMap
Specified by:
keySet in interface Char2ByteSortedMap
Specified by:
keySet in interface Map<Character,Byte>
Specified by:
keySet in interface SortedMap<Character,Byte>
Overrides:
keySet in class AbstractChar2ByteSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ByteCollection values()
Returns a type-specific collection view of the values contained in this map.

In addition to the semantics of Map.values(), you can safely cast the collection returned by this call to a type-specific collection interface.

Specified by:
values in interface Char2ByteMap
Specified by:
values in interface Char2ByteSortedMap
Specified by:
values in interface Map<Character,Byte>
Specified by:
values in interface SortedMap<Character,Byte>
Overrides:
values in class AbstractChar2ByteSortedMap
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public CharComparator comparator()
Description copied from interface: Char2ByteSortedMap
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 Char2ByteSortedMap
Specified by:
comparator in interface SortedMap<Character,Byte>
See Also:
SortedMap.comparator()

headMap

public Char2ByteSortedMap headMap(char to)
Description copied from interface: Char2ByteSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Char2ByteSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Char2ByteSortedMap tailMap(char from)
Description copied from interface: Char2ByteSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Char2ByteSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Char2ByteSortedMap subMap(char from,
                                 char to)
Description copied from interface: Char2ByteSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Char2ByteSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

public Char2ByteAVLTreeMap clone()
Returns a deep copy of this tree map.

This method performs a deep copy of this tree map; the data stored in the set, 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 tree map.


Copyright © 2011. All Rights Reserved.