it.unimi.dsi.fastutil.objects

Class Object2ReferenceRBTreeMap<K,V>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction<K,V>

it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceMap<K,V>

it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceSortedMap<K,V>

it.unimi.dsi.fastutil.objects.Object2ReferenceRBTreeMap<K,V>

All Implemented Interfaces:

Object2ReferenceFunction<K,V>, Object2ReferenceMap<K,V>, Object2ReferenceSortedMap<K,V>, Serializable, Cloneable, Function<K,V>, Map<K,V>, SortedMap<K,V>

public class Object2ReferenceRBTreeMap<K,V>
extends AbstractObject2ReferenceSortedMap<K,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.objects.AbstractObject2ReferenceSortedMap

AbstractObject2ReferenceSortedMap.KeySetIterator<K,V>, AbstractObject2ReferenceSortedMap.ValuesCollection, AbstractObject2ReferenceSortedMap.ValuesIterator<K,V>

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceMap

AbstractObject2ReferenceMap.BasicEntry<K,V>, AbstractObject2ReferenceMap.BasicEntrySet<K,V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceSortedMap

Object2ReferenceSortedMap.FastSortedEntrySet<K,V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceMap

Object2ReferenceMap.FastEntrySet<K,V>

Field Summary

Fields

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

Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction

defRetValue

Constructor Summary

Constructors

Constructor and Description
Object2ReferenceRBTreeMap() Creates a new empty tree map.
Object2ReferenceRBTreeMap(Comparator<? super K> c) Creates a new empty tree map with the given comparator.
Object2ReferenceRBTreeMap(K[] k, V[] v) Creates a new tree map using the elements of two parallel arrays.
Object2ReferenceRBTreeMap(K[] k, V[] v, Comparator<? super K> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2ReferenceRBTreeMap(Map<? extends K,? extends V> m) Creates a new tree map copying a given map.
Object2ReferenceRBTreeMap(Object2ReferenceMap<? extends K,? extends V> m) Creates a new tree map copying a given map.
Object2ReferenceRBTreeMap(Object2ReferenceSortedMap<K,V> m) Creates a new tree map copying a given sorted map (and its Comparator).
Object2ReferenceRBTreeMap(SortedMap<K,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).
Object2ReferenceRBTreeMap<K,V>	clone() Returns a deep copy of this tree map.
Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(Object v)
K	firstKey()
V	get(Object k) Returns the value to which the given key is mapped.
Object2ReferenceSortedMap<K,V>	headMap(K to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
ObjectSortedSet<K>	keySet() Returns a type-specific sorted set view of the keys contained in this map.
K	lastKey()
ObjectSortedSet<Object2ReferenceMap.Entry<K,V>>	object2ReferenceEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
V	put(K k, V v) Adds a pair to the map (optional operation).
V	remove(Object k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Object2ReferenceSortedMap<K,V>	subMap(K from, K to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Object2ReferenceSortedMap<K,V>	tailMap(K 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.objects.AbstractObject2ReferenceMap

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceSortedMap

entrySet

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceMap

defaultReturnValue, defaultReturnValue

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

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.objects.Object2ReferenceRBTreeMap.Entry<K,V> tree

A reference to the root entry.

count

protected int count

Number of entries in this map.

firstEntry

protected transient it.unimi.dsi.fastutil.objects.Object2ReferenceRBTreeMap.Entry<K,V> firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.objects.Object2ReferenceRBTreeMap.Entry<K,V> lastEntry

The last key in this map.

entries

protected transient ObjectSortedSet<Object2ReferenceMap.Entry<K,V>> entries

Cached set of entries.

keys

protected transient ObjectSortedSet<K> keys

Cached set of keys.

values

protected transient ReferenceCollection<V> 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 K> storedComparator

This map's comparator, as provided in the constructor.

actualComparator

protected transient Comparator<? super K> 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

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap()

Creates a new empty tree map.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(Map<? extends K,? extends V> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(SortedMap<K,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.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(Object2ReferenceMap<? extends K,? 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.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(Object2ReferenceSortedMap<K,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.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(K[] k,
                                 V[] v,
                                 Comparator<? super K> 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.

Object2ReferenceRBTreeMap

public Object2ReferenceRBTreeMap(K[] 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 Detail

put

public V put(K k,
             V v)

Description copied from interface: Object2ReferenceFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Object2ReferenceFunction<K,V>

Specified by:

put in interface Object2ReferenceMap<K,V>

Specified by:

put in interface Map<K,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(Object k)

Description copied from interface: Object2ReferenceFunction

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

Specified by:

remove in interface Object2ReferenceFunction<K,V>

Specified by:

remove in interface Object2ReferenceMap<K,V>

Specified by:

remove in interface Map<K,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)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractObject2ReferenceMap<K,V>

clear

public void clear()

Description copied from interface: Object2ReferenceMap

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

Specified by:

clear in interface Object2ReferenceMap<K,V>

Specified by:

clear in interface Map<K,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from interface: Object2ReferenceMap

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

Specified by:

containsKey in interface Object2ReferenceMap<K,V>

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractObject2ReferenceMap<K,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: Object2ReferenceMap

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 Object2ReferenceMap<K,V>

Specified by:

size in interface Map<K,V>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractObject2ReferenceMap<K,V>

get

public V get(Object k)

Description copied from interface: Object2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Object2ReferenceFunction<K,V>

Specified by:

get in interface Map<K,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)

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

object2ReferenceEntrySet

public ObjectSortedSet<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()

Description copied from interface: Object2ReferenceSortedMap

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:

object2ReferenceEntrySet in interface Object2ReferenceMap<K,V>

Specified by:

object2ReferenceEntrySet in interface Object2ReferenceSortedMap<K,V>

Returns:

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

See Also:

Object2ReferenceSortedMap.entrySet()

keySet

public ObjectSortedSet<K> 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 Object2ReferenceMap<K,V>

Specified by:

keySet in interface Object2ReferenceSortedMap<K,V>

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Overrides:

keySet in class AbstractObject2ReferenceSortedMap<K,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 Object2ReferenceMap<K,V>

Specified by:

values in interface Object2ReferenceSortedMap<K,V>

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

Overrides:

values in class AbstractObject2ReferenceSortedMap<K,V>

Returns:

a type-specific collection view of the values contained in this map.

See Also:

Map.values()

comparator

public Comparator<? super K> comparator()

Description copied from interface: Object2ReferenceSortedMap

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 Object2ReferenceSortedMap<K,V>

Specified by:

comparator in interface SortedMap<K,V>

See Also:

SortedMap.comparator()

headMap

public Object2ReferenceSortedMap<K,V> headMap(K to)

Description copied from interface: Object2ReferenceSortedMap

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 Object2ReferenceSortedMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

See Also:

SortedMap.headMap(Object)

tailMap

public Object2ReferenceSortedMap<K,V> tailMap(K from)

Description copied from interface: Object2ReferenceSortedMap

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 Object2ReferenceSortedMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

See Also:

SortedMap.tailMap(Object)

subMap

public Object2ReferenceSortedMap<K,V> subMap(K from,
                                             K to)

Description copied from interface: Object2ReferenceSortedMap

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 Object2ReferenceSortedMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

See Also:

SortedMap.subMap(Object,Object)

clone

public Object2ReferenceRBTreeMap<K,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 Object

Returns:

a deep copy of this tree map.