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:

Int2IntFunction, Int2IntMap, Int2IntSortedMap, Serializable, Cloneable, Function<Integer,Integer>, IntUnaryOperator, 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.AbstractInt2IntSortedMap

AbstractInt2IntSortedMap.KeySetIterator, AbstractInt2IntSortedMap.ValuesCollection, AbstractInt2IntSortedMap.ValuesIterator

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntMap

AbstractInt2IntMap.BasicEntry, AbstractInt2IntMap.BasicEntrySet

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

Fields

Modifier and Type	Field and Description
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<Int2IntMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap.Entry	firstEntry The first key in this map.
protected IntSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap.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.
protected Comparator<? super Integer>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap.Entry	tree A reference to the root entry.
protected IntCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
int	addTo(int k, int incr) Adds an increment to value currently associated with a key.
void	clear() Removes all of the mappings from this map (optional operation).
Int2IntRBTreeMap	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) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(int v) Returns true if this map maps one or more keys to the specified value.
int	firstIntKey() Returns the first (lowest) key currently in this map.
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 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() Returns the last (highest) key currently in this map.
int	put(int k, int v) Adds a pair to the map (optional operation).
int	remove(int k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
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.AbstractInt2IntMap

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentNullable, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, getOrDefault, merge, merge, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

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

applyAsInt

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap.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.ints.Int2IntRBTreeMap.Entry firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.ints.Int2IntRBTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient ObjectSortedSet<Int2IntMap.Entry> entries

Cached set of entries.

keys

protected transient IntSortedSet keys

Cached set of keys.

values

protected transient IntCollection 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.

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

addTo

public int addTo(int k,
                 int incr)

Adds an increment to value currently associated with a key.

Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

Parameters:

k - the key.

incr - the increment.

Returns:

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

put

public int put(int k,
               int v)

Description copied from interface: Int2IntFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Int2IntFunction

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 (optional operation).

Specified by:

remove in interface Int2IntFunction

Parameters:

k - the key.

Returns:

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

See Also:

Function.remove(Object)

containsValue

public boolean containsValue(int v)

Description copied from interface: Int2IntMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Int2IntMap

Overrides:

containsValue in class AbstractInt2IntMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Int2IntMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Int2IntMap

Specified by:

clear in interface Map<Integer,Integer>

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from interface: Int2IntMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Int2IntFunction

Specified by:

containsKey in interface Int2IntMap

Overrides:

containsKey in class AbstractInt2IntMap

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

size

public int size()

Description copied from interface: Int2IntMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Int2IntMap

Specified by:

size in interface Map<Integer,Integer>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

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()

Description copied from interface: Int2IntSortedMap

Returns the first (lowest) key currently in this map.

Specified by:

firstIntKey in interface Int2IntSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Description copied from interface: Int2IntSortedMap

Returns the last (highest) key currently in this map.

Specified by:

lastIntKey in interface Int2IntSortedMap

See Also:

SortedMap.lastKey()

int2IntEntrySet

public ObjectSortedSet<Int2IntMap.Entry> int2IntEntrySet()

Description copied from interface: Int2IntSortedMap

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:

int2IntEntrySet in interface Int2IntMap

Specified by:

int2IntEntrySet in interface Int2IntSortedMap

Returns:

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

See Also:

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

Specified by:

keySet in interface SortedMap<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>

Specified by:

values in interface SortedMap<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.

Note that this specification strengthens the one given in SortedMap.headMap(Object).

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.

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

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.

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:

subMap in interface Int2IntSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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