it.unimi.dsi.fastutil.ints
Class Int2ReferenceRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap
      it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap
          it.unimi.dsi.fastutil.ints.Int2ReferenceRBTreeMap

All Implemented Interfaces:

Cloneable, Int2ReferenceMap, Int2ReferenceSortedMap, Map, Serializable, SortedMap

public class Int2ReferenceRBTreeMap

extends AbstractInt2ReferenceSortedMap

implements Serializable, Cloneable, Int2ReferenceSortedMap

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.ints.AbstractInt2ReferenceMap

AbstractInt2ReferenceMap.BasicEntry

Field Summary

static long

serialVersionUID

Constructor Summary

Int2ReferenceRBTreeMap()
Creates a new empty tree map.

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

Int2ReferenceRBTreeMap(Int2ReferenceMap m)
Creates a new tree map copying a given map.

Int2ReferenceRBTreeMap(Int2ReferenceSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

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

Int2ReferenceRBTreeMap(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(int k) Checks whether the given value is contained in keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in values().
Set	entrySet()
int	firstIntKey()
Object	firstKey() Delegates to the corresponding type-specific method.
Object	get(int 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.
Int2ReferenceSortedMap	headMap(int to)
boolean	isEmpty()
Set	keySet() Returns a type-specific sorted set view of the keys contained in this map.
int	lastIntKey()
Object	lastKey() Delegates to the corresponding type-specific method.
Object	put(int k, Object 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.
Object	remove(int 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()
Int2ReferenceSortedMap	subMap(int from, int to)
Int2ReferenceSortedMap	tailMap(int from)
Collection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap

headMap, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap

containsKey, 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.ints.Int2ReferenceMap

defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue

Methods inherited from interface java.util.Map

containsKey, 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

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap()

Creates a new empty tree map.

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(Comparator c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a Comparator.

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(Map m)

Creates a new tree map copying a given map.

Parameters:

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

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(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.

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(Int2ReferenceMap m)

Creates a new tree map copying a given map.

Parameters:

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

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(Int2ReferenceSortedMap 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 Object put(int k,
                        Object v)

Description copied from interface: Int2ReferenceMap

Adds a pair to the map.

Specified by:

put in interface Int2ReferenceMap

Overrides:

put in class AbstractInt2ReferenceMap

remove

public final Object remove(int k)

Description copied from interface: Int2ReferenceMap

Removes the mapping with the given key.

Specified by:

remove in interface Int2ReferenceMap

Overrides:

remove in class AbstractInt2ReferenceMap

put

public Object put(Object ok,
                  Object ov)

Description copied from class: AbstractInt2ReferenceMap

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 AbstractInt2ReferenceMap

remove

public Object remove(Object ok)

Description copied from class: AbstractInt2ReferenceMap

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 AbstractInt2ReferenceMap

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractInt2ReferenceMap

Checks whether the given value is contained in AbstractInt2ReferenceMap.values().

Specified by:

containsValue in interface Map

Overrides:

containsValue in class AbstractInt2ReferenceMap

clear

public void clear()

Specified by:

clear in interface Map

Overrides:

clear in class AbstractInt2ReferenceMap

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2ReferenceMap

Checks whether the given value is contained in AbstractInt2ReferenceMap.keySet().

Specified by:

containsKey in interface Int2ReferenceMap

Overrides:

containsKey in class AbstractInt2ReferenceMap

size

public int size()

Specified by:

size in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class AbstractInt2ReferenceMap

get

public Object get(int k)

Description copied from interface: Int2ReferenceMap

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ReferenceMap

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: AbstractInt2ReferenceMap

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 AbstractInt2ReferenceMap

firstIntKey

public int firstIntKey()

Specified by:

firstIntKey in interface Int2ReferenceSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2ReferenceSortedMap

See Also:

SortedMap.lastKey()

firstKey

public Object firstKey()

Description copied from class: AbstractInt2ReferenceSortedMap

Delegates to the corresponding type-specific method.

Specified by:

firstKey in interface SortedMap

Overrides:

firstKey in class AbstractInt2ReferenceSortedMap

lastKey

public Object lastKey()

Description copied from class: AbstractInt2ReferenceSortedMap

Delegates to the corresponding type-specific method.

Specified by:

lastKey in interface SortedMap

Overrides:

lastKey in class AbstractInt2ReferenceSortedMap

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 AbstractInt2ReferenceSortedMap

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 AbstractInt2ReferenceMap

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 Int2ReferenceSortedMap headMap(int to)

Specified by:

headMap in interface Int2ReferenceSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2ReferenceSortedMap tailMap(int from)

Specified by:

tailMap in interface Int2ReferenceSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2ReferenceSortedMap subMap(int from,
                                     int to)

Specified by:

subMap in interface Int2ReferenceSortedMap

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.