it.unimi.dsi.fastutil.ints
Class Int2IntRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2IntFunction
      it.unimi.dsi.fastutil.ints.AbstractInt2IntMap
          it.unimi.dsi.fastutil.ints.AbstractInt2IntSortedMap
              it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap

All Implemented Interfaces:

Function<Integer,Integer>, Int2IntFunction, Int2IntMap, Int2IntSortedMap, Serializable, Cloneable, Map<Integer,Integer>, SortedMap<Integer,Integer>

public class Int2IntRBTreeMap
extends AbstractInt2IntSortedMap
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.AbstractInt2IntMap

AbstractInt2IntMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2IntSortedMap

Int2IntSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2IntMap

Int2IntMap.FastEntrySet

Field Summary

static long

serialVersionUID

Constructor Summary

Int2IntRBTreeMap()
Creates a new empty tree map.

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

Int2IntRBTreeMap(int[] k, int[] v)
Creates a new tree map using the elements of two parallel arrays.

Int2IntRBTreeMap(int[] k, int[] v, Comparator<? super Integer> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Int2IntRBTreeMap(Int2IntMap m)
Creates a new tree map copying a given map.

Int2IntRBTreeMap(Int2IntSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

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

Int2IntRBTreeMap(SortedMap<Integer,Integer> 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).
Object	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 AbstractInt2IntMap.keySet().
boolean	containsValue(int v) Checks whether the given value is contained in AbstractInt2IntMap.values().
int	firstIntKey()
int	get(int k) Returns the value to which the given key is mapped.
Int2IntSortedMap	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2IntMap.Entry>	int2IntEntrySet() Returns a type-specific 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()
Integer	put(Integer ok, Integer ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	put(int k, int v) Adds a pair to the map.
int	remove(int k) Removes the mapping with the given key.
Integer	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.
Int2IntSortedMap	subMap(int from, int to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Int2IntSortedMap	tailMap(int from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
IntCollection	values() Returns a type-specific collection view of the values contained in this map.

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

containsValue, equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2IntFunction

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

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Int2IntRBTreeMap

public Int2IntRBTreeMap()

Creates a new empty tree map.

Int2IntRBTreeMap

public Int2IntRBTreeMap(Comparator<? super Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2IntRBTreeMap

public Int2IntRBTreeMap(Map<? extends Integer,? extends Integer> m)

Creates a new tree map copying a given map.

Parameters:

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

Int2IntRBTreeMap

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

Int2IntRBTreeMap

public Int2IntRBTreeMap(Int2IntMap m)

Creates a new tree map copying a given map.

Parameters:

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

Int2IntRBTreeMap

public Int2IntRBTreeMap(Int2IntSortedMap 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.

Int2IntRBTreeMap

public Int2IntRBTreeMap(int[] k,
                        int[] 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.

Int2IntRBTreeMap

public Int2IntRBTreeMap(int[] k,
                        int[] 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 int put(int k,
               int v)

Description copied from interface: Int2IntFunction

Adds a pair to the map.

Specified by:

put in interface Int2IntFunction

Overrides:

put in class AbstractInt2IntFunction

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 int remove(int k)

Description copied from interface: Int2IntFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2IntFunction

Overrides:

remove in class AbstractInt2IntFunction

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 Integer put(Integer ok,
                   Integer ov)

Description copied from class: AbstractInt2IntFunction

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

Specified by:

put in interface Map<Integer,Integer>

Overrides:

put in class AbstractInt2IntFunction

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 Integer remove(Object ok)

Description copied from class: AbstractInt2IntFunction

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

Specified by:

remove in interface Map<Integer,Integer>

Overrides:

remove in class AbstractInt2IntFunction

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(int v)

Description copied from class: AbstractInt2IntMap

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

Specified by:

containsValue in interface Int2IntMap

Overrides:

containsValue in class AbstractInt2IntMap

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

Specified by:

clear in interface Map<Integer,Integer>

Overrides:

clear in class AbstractInt2IntFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2IntMap

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

Specified by:

containsKey in interface Int2IntFunction

Overrides:

containsKey in class AbstractInt2IntMap

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

Specified by:

size in interface Map<Integer,Integer>

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

Overrides:

isEmpty in class AbstractInt2IntMap

get

public int get(int k)

Description copied from interface: Int2IntFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2IntFunction

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 Int2IntSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2IntSortedMap

See Also:

SortedMap.lastKey()

int2IntEntrySet

public ObjectSortedSet<Int2IntMap.Entry> int2IntEntrySet()

Description copied from interface: Int2IntMap

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 Int2IntMap.entrySet() so that it returns an ObjectSet of objects of type Int2IntMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

int2IntEntrySet in interface Int2IntMap

Specified by:

int2IntEntrySet in interface Int2IntSortedMap

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Int2IntMap.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 Int2IntMap

Specified by:

keySet in interface Int2IntSortedMap

Specified by:

keySet in interface Map<Integer,Integer>

Overrides:

keySet in class AbstractInt2IntSortedMap

Returns:

a type-specific sorted set view of the keys contained in this map.

See Also:

Map.keySet()

values

public IntCollection 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 Int2IntMap

Specified by:

values in interface Int2IntSortedMap

Specified by:

values in interface Map<Integer,Integer>

Overrides:

values in class AbstractInt2IntSortedMap

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

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 Int2IntSortedMap

Specified by:

comparator in interface SortedMap<Integer,Integer>

See Also:

SortedMap.comparator()

headMap

public Int2IntSortedMap headMap(int to)

Description copied from interface: Int2IntSortedMap

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Int2IntSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2IntSortedMap tailMap(int from)

Description copied from interface: Int2IntSortedMap

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Int2IntSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2IntSortedMap subMap(int from,
                               int to)

Description copied from interface: Int2IntSortedMap

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Int2IntSortedMap

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.

Overrides:

clone in class Object

Returns:

a deep copy of this tree map.