Package it.unimi.dsi.fastutil.ints

Class Int2ReferenceRBTreeMap<V>

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceFunction<V>

it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceMap<V>

it.unimi.dsi.fastutil.ints.AbstractInt2ReferenceSortedMap<V>

it.unimi.dsi.fastutil.ints.Int2ReferenceRBTreeMap<V>

All Implemented Interfaces:

Function<Integer,V>, Int2ReferenceFunction<V>, Int2ReferenceMap<V>, Int2ReferenceSortedMap<V>, Serializable, Cloneable, Function<Integer,V>, IntFunction<V>, Map<Integer,V>, SequencedMap<Integer,V>, SortedMap<Integer,V>

public class Int2ReferenceRBTreeMap<V>
extends AbstractInt2ReferenceSortedMap<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.AbstractInt2ReferenceMap

AbstractInt2ReferenceMap.BasicEntry<V>, AbstractInt2ReferenceMap.BasicEntrySet<V>

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

Int2ReferenceMap.FastEntrySet<V>

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

Int2ReferenceSortedMap.FastSortedEntrySet<V>

Constructor Summary

Constructors

Constructor	Description
Int2ReferenceRBTreeMap()	Creates a new empty tree map.
Int2ReferenceRBTreeMap(int[] k, V[] v)	Creates a new tree map using the elements of two parallel arrays.
Int2ReferenceRBTreeMap(int[] k, V[] v, Comparator<? super Integer> c)	Creates a new tree map using the elements of two parallel arrays and the given comparator.
Int2ReferenceRBTreeMap(Int2ReferenceMap<? extends V> m)	Creates a new tree map copying a given map.
Int2ReferenceRBTreeMap(Int2ReferenceSortedMap<V> m)	Creates a new tree map copying a given sorted map (and its Comparator).
Int2ReferenceRBTreeMap(Comparator<? super Integer> c)	Creates a new empty tree map with the given comparator.
Int2ReferenceRBTreeMap(Map<? extends Integer,? extends V> m)	Creates a new tree map copying a given map.
Int2ReferenceRBTreeMap(SortedMap<Integer,V> m)	Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all of the mappings from this map (optional operation).
Int2ReferenceRBTreeMap<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)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(Object v)
int	firstIntKey()	Returns the first (lowest) key currently in this map.
V	get(int k)	Returns the value to which the given key is mapped.
Int2ReferenceSortedMap<V>	headMap(int to)	Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2ReferenceMap.Entry<V>>	int2ReferenceEntrySet()	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.
V	put(int k, V v)	Adds a pair to the map (optional operation).
V	remove(int k)	Removes the mapping with the given key (optional operation).
int	size()	Returns the number of key/value mappings in this map.
Int2ReferenceSortedMap<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.
Int2ReferenceSortedMap<V>	tailMap(int from)	Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ReferenceCollection<V>	values()	Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

andThen

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

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

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

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

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, get, getOrDefault, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

putFirst, putLast, reversed

Constructor Details

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap()

Creates a new empty tree map.

Int2ReferenceRBTreeMap

public Int2ReferenceRBTreeMap(Comparator<? super Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2ReferenceRBTreeMap

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

Int2ReferenceRBTreeMap

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

Int2ReferenceRBTreeMap

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

Int2ReferenceRBTreeMap

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

Int2ReferenceRBTreeMap

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

Int2ReferenceRBTreeMap

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

put

public V put(int k,
 V v)

Description copied from interface: Int2ReferenceFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Int2ReferenceFunction<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: Int2ReferenceFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Int2ReferenceFunction<V>

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

Description copied from class: AbstractInt2ReferenceMap

Specified by:

containsValue in interface Map<Integer,V>

Overrides:

containsValue in class AbstractInt2ReferenceMap<V>

clear

public void clear()

Description copied from interface: Int2ReferenceMap

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

Specified by:

clear in interface Function<Integer,V>

Specified by:

clear in interface Int2ReferenceMap<V>

Specified by:

clear in interface Map<Integer,V>

See Also:

• Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2ReferenceMap

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

Specified by:

containsKey in interface Int2ReferenceFunction<V>

Specified by:

containsKey in interface Int2ReferenceMap<V>

Overrides:

containsKey in class AbstractInt2ReferenceMap<V>

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

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

Specified by:

size in interface Int2ReferenceMap<V>

Specified by:

size in interface Map<Integer,V>

Returns:

the number of key-value mappings in this map.

See Also:

• Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Integer,V>

Overrides:

isEmpty in class AbstractInt2ReferenceMap<V>

get

public V get(int k)

Description copied from interface: Int2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ReferenceFunction<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()

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

firstIntKey in interface Int2ReferenceSortedMap<V>

See Also:

• SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

lastIntKey in interface Int2ReferenceSortedMap<V>

See Also:

• SortedMap.lastKey()

int2ReferenceEntrySet

public ObjectSortedSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

int2ReferenceEntrySet in interface Int2ReferenceMap<V>

Specified by:

int2ReferenceEntrySet in interface Int2ReferenceSortedMap<V>

Returns:

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

See Also:

• Int2ReferenceSortedMap.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 Int2ReferenceMap<V>

Specified by:

keySet in interface Int2ReferenceSortedMap<V>

Specified by:

keySet in interface Map<Integer,V>

Specified by:

keySet in interface SortedMap<Integer,V>

Overrides:

keySet in class AbstractInt2ReferenceSortedMap<V>

Returns:

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

See Also:

• Map.keySet()

values

public ReferenceCollection<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 Int2ReferenceMap<V>

Specified by:

values in interface Int2ReferenceSortedMap<V>

Specified by:

values in interface Map<Integer,V>

Specified by:

values in interface SortedMap<Integer,V>

Overrides:

values in class AbstractInt2ReferenceSortedMap<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: Int2ReferenceSortedMap

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Specified by:

comparator in interface Int2ReferenceSortedMap<V>

Specified by:

comparator in interface SortedMap<Integer,V>

See Also:

• SortedMap.comparator()

headMap

public Int2ReferenceSortedMap<V> headMap(int to)

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

headMap in interface Int2ReferenceSortedMap<V>

See Also:

• SortedMap.headMap(Object)

tailMap

public Int2ReferenceSortedMap<V> tailMap(int from)

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

tailMap in interface Int2ReferenceSortedMap<V>

See Also:

• SortedMap.tailMap(Object)

subMap

public Int2ReferenceSortedMap<V> subMap(int from,
 int to)

Description copied from interface: Int2ReferenceSortedMap

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

Specified by:

subMap in interface Int2ReferenceSortedMap<V>

See Also:

• SortedMap.subMap(Object,Object)

clone

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

Returns:

a deep copy of this tree map.