it.unimi.dsi.fastutil.longs
Class Long2IntRBTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.longs.AbstractLong2IntMap
      extended byit.unimi.dsi.fastutil.longs.AbstractLong2IntSortedMap
          extended byit.unimi.dsi.fastutil.longs.Long2IntRBTreeMap
All Implemented Interfaces:
Cloneable, Long2IntMap, Long2IntSortedMap, Map, Serializable, SortedMap

public class Long2IntRBTreeMap
extends AbstractLong2IntSortedMap
implements Serializable, Cloneable, Long2IntSortedMap

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 inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2IntMap
AbstractLong2IntMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Long2IntRBTreeMap()
          Creates a new empty tree map.
Long2IntRBTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Long2IntRBTreeMap(Long2IntMap m)
          Creates a new tree map copying a given map.
Long2IntRBTreeMap(Long2IntSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Long2IntRBTreeMap(Map m)
          Creates a new tree map copying a given map.
Long2IntRBTreeMap(SortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
           
 Object clone()
          Returns a deep copy of this tree map.
 Comparator comparator()
           
 boolean containsKey(long k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(int v)
          Checks whether the given value is contained in values().
 Set entrySet()
           
 Object firstKey()
          Delegates to the corresponding type-specific method.
 long firstLongKey()
           
 int get(long k)
          Returns the value to which the given key is mapped.
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Long2IntSortedMap headMap(long to)
           
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 Object lastKey()
          Delegates to the corresponding type-specific method.
 long lastLongKey()
           
 int put(long k, int v)
          Adds a pair to the map.
 Object put(Object ok, Object ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int remove(long k)
          Removes the mapping with the given key.
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
           
 Long2IntSortedMap subMap(long from, long to)
           
 Long2IntSortedMap tailMap(long from)
           
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2IntSortedMap
headMap, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2IntMap
containsKey, containsValue, defaultReturnValue, defaultReturnValue, equals, getDefRetValue, hashCode, putAll, setDefRetValue, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2IntMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, hashCode, putAll
 
Methods inherited from interface java.util.SortedMap
headMap, subMap, tailMap
 

Field Detail

serialVersionUID

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

Long2IntRBTreeMap

public Long2IntRBTreeMap()
Creates a new empty tree map.


Long2IntRBTreeMap

public Long2IntRBTreeMap(Comparator c)
Creates a new empty tree map with the given comparator.

Parameters:
c - a Comparator.

Long2IntRBTreeMap

public Long2IntRBTreeMap(Map m)
Creates a new tree map copying a given map.

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

Long2IntRBTreeMap

public Long2IntRBTreeMap(SortedMap 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.

Long2IntRBTreeMap

public Long2IntRBTreeMap(Long2IntMap m)
Creates a new tree map copying a given map.

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

Long2IntRBTreeMap

public Long2IntRBTreeMap(Long2IntSortedMap 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.
Method Detail

put

public final int put(long k,
                     int v)
Description copied from interface: Long2IntMap
Adds a pair to the map.

Specified by:
put in interface Long2IntMap
Overrides:
put in class AbstractLong2IntMap

remove

public final int remove(long k)
Description copied from interface: Long2IntMap
Removes the mapping with the given key.

Specified by:
remove in interface Long2IntMap
Overrides:
remove in class AbstractLong2IntMap

put

public Object put(Object ok,
                  Object ov)
Description copied from class: AbstractLong2IntMap
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 Map
Overrides:
put in class AbstractLong2IntMap

remove

public Object remove(Object ok)
Description copied from class: AbstractLong2IntMap
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 Map
Overrides:
remove in class AbstractLong2IntMap

containsValue

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

Specified by:
containsValue in interface Long2IntMap
Overrides:
containsValue in class AbstractLong2IntMap

clear

public void clear()
Specified by:
clear in interface Map
Overrides:
clear in class AbstractLong2IntMap

containsKey

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

Specified by:
containsKey in interface Long2IntMap
Overrides:
containsKey in class AbstractLong2IntMap

size

public int size()
Specified by:
size in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map
Overrides:
isEmpty in class AbstractLong2IntMap

get

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

Specified by:
get in interface Long2IntMap
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

get

public Object get(Object ok)
Description copied from class: AbstractLong2IntMap
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:
get in interface Map
Overrides:
get in class AbstractLong2IntMap

firstLongKey

public long firstLongKey()
Specified by:
firstLongKey in interface Long2IntSortedMap
See Also:
SortedMap.firstKey()

lastLongKey

public long lastLongKey()
Specified by:
lastLongKey in interface Long2IntSortedMap
See Also:
SortedMap.lastKey()

firstKey

public Object firstKey()
Description copied from class: AbstractLong2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
firstKey in interface SortedMap
Overrides:
firstKey in class AbstractLong2IntSortedMap

lastKey

public Object lastKey()
Description copied from class: AbstractLong2IntSortedMap
Delegates to the corresponding type-specific method.

Specified by:
lastKey in interface SortedMap
Overrides:
lastKey in class AbstractLong2IntSortedMap

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

keySet

public Set 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 Map
Overrides:
keySet in class AbstractLong2IntSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.

values

public Collection 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 Map
Overrides:
values in class AbstractLong2IntMap
Returns:
a type-specific collection view of the values contained in this map.

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedMap

headMap

public Long2IntSortedMap headMap(long to)
Specified by:
headMap in interface Long2IntSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Long2IntSortedMap tailMap(long from)
Specified by:
tailMap in interface Long2IntSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Long2IntSortedMap subMap(long from,
                                long to)
Specified by:
subMap in interface Long2IntSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

public Object 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.

Returns:
a deep copy of this tree map.