it.unimi.dsi.fastutil.ints
Class Int2ObjectRBTreeMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction<V>
      extended by it.unimi.dsi.fastutil.ints.AbstractInt2ObjectMap<V>
          extended by it.unimi.dsi.fastutil.ints.AbstractInt2ObjectSortedMap<V>
              extended by it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap<V>
All Implemented Interfaces:
Function<Integer,V>, Int2ObjectFunction<V>, Int2ObjectMap<V>, Int2ObjectSortedMap<V>, Serializable, Cloneable, Map<Integer,V>, SortedMap<Integer,V>

public class Int2ObjectRBTreeMap<V>
extends AbstractInt2ObjectSortedMap<V>
implements Serializable, Cloneable

A type-specific red-black 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.ints.AbstractInt2ObjectSortedMap
AbstractInt2ObjectSortedMap.KeySetIterator<V>, AbstractInt2ObjectSortedMap.ValuesCollection, AbstractInt2ObjectSortedMap.ValuesIterator<V>
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectMap
AbstractInt2ObjectMap.BasicEntry<V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ObjectSortedMap
Int2ObjectSortedMap.FastSortedEntrySet<V>
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ObjectMap
Int2ObjectMap.FastEntrySet<V>
 
Field Summary
protected  IntComparator 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<Int2ObjectMap.Entry<V>> entries
          Cached set of entries.
protected  it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> firstEntry
          The first key in this map.
protected  IntSortedSet keys
          Cached set of keys.
protected  it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> 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 Integer> storedComparator
          This map's comparator, as provided in the constructor.
protected  it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> tree
          A reference to the root entry.
protected  ObjectCollection<V> values
          Cached collection of values.
 
Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction
defRetValue
 
Constructor Summary
Int2ObjectRBTreeMap()
          Creates a new empty tree map.
Int2ObjectRBTreeMap(Comparator<? super Integer> c)
          Creates a new empty tree map with the given comparator.
Int2ObjectRBTreeMap(int[] k, V[] v)
          Creates a new tree map using the elements of two parallel arrays.
Int2ObjectRBTreeMap(int[] k, V[] v, Comparator<? super Integer> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Int2ObjectRBTreeMap(Int2ObjectMap<? extends V> m)
          Creates a new tree map copying a given map.
Int2ObjectRBTreeMap(Int2ObjectSortedMap<V> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Int2ObjectRBTreeMap(Map<? extends Integer,? extends V> m)
          Creates a new tree map copying a given map.
Int2ObjectRBTreeMap(SortedMap<Integer,V> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Int2ObjectRBTreeMap<V> clone()
          Returns a deep copy of this tree map.
 IntComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(int k)
          Checks whether the given value is contained in AbstractInt2ObjectMap.keySet().
 boolean containsValue(Object v)
          Checks whether the given value is contained in AbstractInt2ObjectMap.values().
 int firstIntKey()
           
 V get(int k)
          Returns the value to which the given key is mapped.
 Int2ObjectSortedMap<V> headMap(int to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 ObjectSortedSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 boolean isEmpty()
           
 IntSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 int lastIntKey()
           
 V put(Integer ok, V ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 V put(int k, V v)
          Adds a pair to the map.
 V remove(int k)
          Removes the mapping with the given key.
 V 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.
 Int2ObjectSortedMap<V> subMap(int from, int to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Int2ObjectSortedMap<V> tailMap(int from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ObjectCollection<V> values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectMap
equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction
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.ints.Int2ObjectFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, equals, get, hashCode, putAll
 

Field Detail

tree

protected transient it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> tree
A reference to the root entry.


count

protected int count
Number of entries in this map.


firstEntry

protected transient it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> firstEntry
The first key in this map.


lastEntry

protected transient it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap.Entry<V> lastEntry
The last key in this map.


entries

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


keys

protected transient volatile IntSortedSet keys
Cached set of keys.


values

protected transient volatile ObjectCollection<V> 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 Integer> storedComparator
This map's comparator, as provided in the constructor.


actualComparator

protected transient IntComparator 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

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap()
Creates a new empty tree map.


Int2ObjectRBTreeMap

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

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

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(Map<? extends Integer,? extends V> m)
Creates a new tree map copying a given map.

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

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(SortedMap<Integer,V> 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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(Int2ObjectMap<? extends V> m)
Creates a new tree map copying a given map.

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

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(Int2ObjectSortedMap<V> 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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(int[] k,
                           V[] v,
                           Comparator<? super Integer> 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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(int[] k,
                           V[] 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 V put(int k,
             V v)
Description copied from interface: Int2ObjectFunction
Adds a pair to the map.

Specified by:
put in interface Int2ObjectFunction<V>
Overrides:
put in class AbstractInt2ObjectFunction<V>
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 V remove(int k)
Description copied from interface: Int2ObjectFunction
Removes the mapping with the given key.

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

containsValue

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

Specified by:
containsValue in interface Map<Integer,V>
Overrides:
containsValue in class AbstractInt2ObjectMap<V>

clear

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

Specified by:
clear in interface Function<Integer,V>
Specified by:
clear in interface Map<Integer,V>
Overrides:
clear in class AbstractInt2ObjectFunction<V>
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Int2ObjectFunction<V>
Overrides:
containsKey in class AbstractInt2ObjectMap<V>
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<Integer,V>
Specified by:
size in interface Map<Integer,V>
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<Integer,V>
Overrides:
isEmpty in class AbstractInt2ObjectMap<V>

get

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

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

firstIntKey

public int firstIntKey()
Specified by:
firstIntKey in interface Int2ObjectSortedMap<V>
See Also:
SortedMap.firstKey()

lastIntKey

public int lastIntKey()
Specified by:
lastIntKey in interface Int2ObjectSortedMap<V>
See Also:
SortedMap.lastKey()

int2ObjectEntrySet

public ObjectSortedSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()
Description copied from interface: Int2ObjectSortedMap
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:
int2ObjectEntrySet in interface Int2ObjectMap<V>
Specified by:
int2ObjectEntrySet in interface Int2ObjectSortedMap<V>
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Int2ObjectSortedMap.entrySet()

keySet

public IntSortedSet 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 Int2ObjectMap<V>
Specified by:
keySet in interface Int2ObjectSortedMap<V>
Specified by:
keySet in interface Map<Integer,V>
Specified by:
keySet in interface SortedMap<Integer,V>
Overrides:
keySet in class AbstractInt2ObjectSortedMap<V>
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ObjectCollection<V> 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 Int2ObjectMap<V>
Specified by:
values in interface Int2ObjectSortedMap<V>
Specified by:
values in interface Map<Integer,V>
Specified by:
values in interface SortedMap<Integer,V>
Overrides:
values in class AbstractInt2ObjectSortedMap<V>
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public IntComparator comparator()
Description copied from interface: Int2ObjectSortedMap
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 Int2ObjectSortedMap<V>
Specified by:
comparator in interface SortedMap<Integer,V>
See Also:
SortedMap.comparator()

headMap

public Int2ObjectSortedMap<V> headMap(int to)
Description copied from interface: Int2ObjectSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Int2ObjectSortedMap<V>
See Also:
SortedMap.headMap(Object)

tailMap

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

Specified by:
tailMap in interface Int2ObjectSortedMap<V>
See Also:
SortedMap.tailMap(Object)

subMap

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

Specified by:
subMap in interface Int2ObjectSortedMap<V>
See Also:
SortedMap.subMap(Object,Object)

clone

public Int2ObjectRBTreeMap<V> 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.