it.unimi.dsi.fastutil.ints

Class Int2ObjectRBTreeMap<V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Int2ObjectFunction<V>, Int2ObjectMap<V>, Int2ObjectSortedMap<V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Integer,V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>

public class Int2ObjectRBTreeMap<V>
extends AbstractInt2ObjectSortedMap<V>
implements java.io.Serializable, java.lang.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.AbstractInt2ObjectMap

AbstractInt2ObjectMap.BasicEntry<V>, AbstractInt2ObjectMap.BasicEntrySet<V>

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

Int2ObjectSortedMap.FastSortedEntrySet<V>

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

Int2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
Int2ObjectRBTreeMap<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(java.lang.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.
Int2ObjectSortedMap<V>	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2ObjectMap.Entry<V>>	int2ObjectEntrySet() 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.
Int2ObjectSortedMap<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.
Int2ObjectSortedMap<V>	tailMap(int from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ObjectCollection<V>	values() Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, 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.Int2ObjectFunction

apply

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

equals, forEach, hashCode, putAll, replaceAll

Constructor Detail

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap()

Creates a new empty tree map.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(java.util.Map<? extends java.lang.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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(java.util.SortedMap<java.lang.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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(Int2ObjectMap<? 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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(Int2ObjectSortedMap<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.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(int[] k,
                           V[] v,
                           java.util.Comparator<? super java.lang.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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Int2ObjectRBTreeMap

public Int2ObjectRBTreeMap(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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public V put(int k,
             V v)

Description copied from interface: Int2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

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

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

Specified by:

remove in interface Int2ObjectFunction<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(java.lang.Object v)

Specified by:

containsValue in interface java.util.Map<java.lang.Integer,V>

Overrides:

containsValue in class AbstractInt2ObjectMap<V>

clear

public void clear()

Description copied from interface: Int2ObjectMap

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

Specified by:

clear in interface Int2ObjectMap<V>

Specified by:

clear in interface java.util.Map<java.lang.Integer,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from interface: Int2ObjectMap

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

Specified by:

containsKey in interface Int2ObjectFunction<V>

Specified by:

containsKey in interface Int2ObjectMap<V>

Overrides:

containsKey in class AbstractInt2ObjectMap<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: Int2ObjectMap

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 Int2ObjectMap<V>

Specified by:

size in interface java.util.Map<java.lang.Integer,V>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Integer,V>

Overrides:

isEmpty in class AbstractInt2ObjectMap<V>

get

public V get(int k)

Description copied from interface: Int2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ObjectFunction<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: Int2ObjectSortedMap

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

Specified by:

firstIntKey in interface Int2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

lastIntKey in interface Int2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

int2ObjectEntrySet

public ObjectSortedSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()

Description copied from interface: Int2ObjectSortedMap

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:

int2ObjectEntrySet in interface Int2ObjectMap<V>

Specified by:

int2ObjectEntrySet in interface Int2ObjectSortedMap<V>

Returns:

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

See Also:

Int2ObjectSortedMap.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 Int2ObjectMap<V>

Specified by:

keySet in interface Int2ObjectSortedMap<V>

Specified by:

keySet in interface java.util.Map<java.lang.Integer,V>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Integer,V>

Overrides:

keySet in class AbstractInt2ObjectSortedMap<V>

Returns:

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

See Also:

Map.keySet()

values

public ObjectCollection<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 Int2ObjectMap<V>

Specified by:

values in interface Int2ObjectSortedMap<V>

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

Specified by:

values in interface java.util.SortedMap<java.lang.Integer,V>

Overrides:

values in class AbstractInt2ObjectSortedMap<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: Int2ObjectSortedMap

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 Int2ObjectSortedMap<V>

Specified by:

comparator in interface java.util.SortedMap<java.lang.Integer,V>

See Also:

SortedMap.comparator()

headMap

public Int2ObjectSortedMap<V> headMap(int to)

Description copied from interface: Int2ObjectSortedMap

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 Int2ObjectSortedMap<V>

See Also:

SortedMap.headMap(Object)

tailMap

public Int2ObjectSortedMap<V> tailMap(int from)

Description copied from interface: Int2ObjectSortedMap

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 Int2ObjectSortedMap<V>

See Also:

SortedMap.tailMap(Object)

subMap

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

Description copied from interface: Int2ObjectSortedMap

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 Int2ObjectSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

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

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of this tree map.