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<java.lang.Integer,V>
,Int2ReferenceFunction<V>
,Int2ReferenceMap<V>
,Int2ReferenceSortedMap<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 Int2ReferenceRBTreeMap<V> extends AbstractInt2ReferenceSortedMap<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.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, java.util.Comparator<? super java.lang.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 itsComparator
).Int2ReferenceRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)
Creates a new empty tree map with the given comparator.Int2ReferenceRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends V> m)
Creates a new tree map copying a given map.Int2ReferenceRBTreeMap(java.util.SortedMap<java.lang.Integer,V> m)
Creates a new tree map copying a given sorted map (and itsComparator
). -
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(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.Int2ReferenceSortedMap<V>
headMap(int to)
Returns a view of the portion of this sorted map whose keys are strictly less thantoKey
.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 fromfromKey
, inclusive, totoKey
, exclusive.Int2ReferenceSortedMap<V>
tailMap(int from)
Returns a view of the portion of this sorted map whose keys are greater than or equal tofromKey
.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 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
-
Constructor Details
-
Int2ReferenceRBTreeMap
public Int2ReferenceRBTreeMap()Creates a new empty tree map. -
Int2ReferenceRBTreeMap
public Int2ReferenceRBTreeMap(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.
-
Int2ReferenceRBTreeMap
Creates a new tree map copying a given map.- Parameters:
m
- aMap
to be copied into the new tree map.
-
Int2ReferenceRBTreeMap
Creates a new tree map copying a given sorted map (and itsComparator
).- Parameters:
m
- aSortedMap
to be copied into the new tree map.
-
Int2ReferenceRBTreeMap
Creates a new tree map copying a given map.- Parameters:
m
- a type-specific map to be copied into the new tree map.
-
Int2ReferenceRBTreeMap
Creates a new tree map copying a given sorted map (and itsComparator
).- Parameters:
m
- a type-specific sorted map to be copied into the new tree map.
-
Int2ReferenceRBTreeMap
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
- ifk
andv
have different lengths.
-
Int2ReferenceRBTreeMap
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
- ifk
andv
have different lengths.
-
-
Method Details
-
put
Description copied from interface:Int2ReferenceFunction
Adds a pair to the map (optional operation).- Specified by:
put
in interfaceInt2ReferenceFunction<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
Description copied from interface:Int2ReferenceFunction
Removes the mapping with the given key (optional operation).- Specified by:
remove
in interfaceInt2ReferenceFunction<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)Description copied from class:AbstractInt2ReferenceMap
- Specified by:
containsValue
in interfacejava.util.Map<java.lang.Integer,V>
- Overrides:
containsValue
in classAbstractInt2ReferenceMap<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. -
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 interfaceInt2ReferenceFunction<V>
- Specified by:
containsKey
in interfaceInt2ReferenceMap<V>
- Overrides:
containsKey
in classAbstractInt2ReferenceMap<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 thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
. -
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfacejava.util.Map<java.lang.Integer,V>
- Overrides:
isEmpty
in classAbstractInt2ReferenceMap<V>
-
get
Description copied from interface:Int2ReferenceFunction
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceInt2ReferenceFunction<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 interfaceInt2ReferenceSortedMap<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 interfaceInt2ReferenceSortedMap<V>
- See Also:
SortedMap.lastKey()
-
int2ReferenceEntrySet
Description copied from interface:Int2ReferenceSortedMap
Returns a type-specific sorted-set view of the mappings contained in this map.- Specified by:
int2ReferenceEntrySet
in interfaceInt2ReferenceMap<V>
- Specified by:
int2ReferenceEntrySet
in interfaceInt2ReferenceSortedMap<V>
- Returns:
- a type-specific sorted-set view of the mappings contained in this map.
- See Also:
Int2ReferenceSortedMap.entrySet()
-
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 interfaceInt2ReferenceMap<V>
- Specified by:
keySet
in interfaceInt2ReferenceSortedMap<V>
- Specified by:
keySet
in interfacejava.util.Map<java.lang.Integer,V>
- Specified by:
keySet
in interfacejava.util.SortedMap<java.lang.Integer,V>
- Overrides:
keySet
in classAbstractInt2ReferenceSortedMap<V>
- Returns:
- a type-specific sorted set view of the keys contained in this map.
- See Also:
Map.keySet()
-
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 interfaceInt2ReferenceMap<V>
- Specified by:
values
in interfaceInt2ReferenceSortedMap<V>
- Specified by:
values
in interfacejava.util.Map<java.lang.Integer,V>
- Specified by:
values
in interfacejava.util.SortedMap<java.lang.Integer,V>
- Overrides:
values
in classAbstractInt2ReferenceSortedMap<V>
- Returns:
- a type-specific collection view of the values contained in this map.
- See Also:
Map.values()
-
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 interfaceInt2ReferenceSortedMap<V>
- Specified by:
comparator
in interfacejava.util.SortedMap<java.lang.Integer,V>
- See Also:
SortedMap.comparator()
-
headMap
Description copied from interface:Int2ReferenceSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less thantoKey
.- Specified by:
headMap
in interfaceInt2ReferenceSortedMap<V>
- See Also:
SortedMap.headMap(Object)
-
tailMap
Description copied from interface:Int2ReferenceSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal tofromKey
.- Specified by:
tailMap
in interfaceInt2ReferenceSortedMap<V>
- See Also:
SortedMap.tailMap(Object)
-
subMap
Description copied from interface:Int2ReferenceSortedMap
Returns a view of the portion of this sorted map whose keys range fromfromKey
, inclusive, totoKey
, exclusive.- Specified by:
subMap
in interfaceInt2ReferenceSortedMap<V>
- See Also:
SortedMap.subMap(Object,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.
-