it.unimi.dsi.fastutil.objects

Class Object2ObjectRBTreeMap<K,V>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Object2ObjectFunction<K,V>, Object2ObjectMap<K,V>, Object2ObjectSortedMap<K,V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<K,V>, java.util.Map<K,V>, java.util.SortedMap<K,V>

public class Object2ObjectRBTreeMap<K,V>
extends AbstractObject2ObjectSortedMap<K,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.objects.AbstractObject2ObjectMap

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

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

Object2ObjectSortedMap.FastSortedEntrySet<K,V>

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

Object2ObjectMap.FastEntrySet<K,V>

Constructor Summary

Constructors

Constructor and Description
Object2ObjectRBTreeMap() Creates a new empty tree map.
Object2ObjectRBTreeMap(java.util.Comparator<? super K> c) Creates a new empty tree map with the given comparator.
Object2ObjectRBTreeMap(K[] k, V[] v) Creates a new tree map using the elements of two parallel arrays.
Object2ObjectRBTreeMap(K[] k, V[] v, java.util.Comparator<? super K> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2ObjectRBTreeMap(java.util.Map<? extends K,? extends V> m) Creates a new tree map copying a given map.
Object2ObjectRBTreeMap(Object2ObjectMap<? extends K,? extends V> m) Creates a new tree map copying a given map.
Object2ObjectRBTreeMap(Object2ObjectSortedMap<K,V> m) Creates a new tree map copying a given sorted map (and its Comparator).
Object2ObjectRBTreeMap(java.util.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).
Object2ObjectRBTreeMap<K,V>	clone() Returns a deep copy of this tree map.
java.util.Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(java.lang.Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(java.lang.Object v)
K	firstKey()
V	get(java.lang.Object k) Returns the value to which the given key is mapped.
Object2ObjectSortedMap<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<Object2ObjectMap.Entry<K,V>>	object2ObjectEntrySet() 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(java.lang.Object k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Object2ObjectSortedMap<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.
Object2ObjectSortedMap<K,V>	tailMap(K 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.objects.AbstractObject2ObjectMap

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

entrySet

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

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

Constructor Detail

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap()

Creates a new empty tree map.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(java.util.Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(java.util.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.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(java.util.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.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Object2ObjectMap<? 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.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Object2ObjectSortedMap<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.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(K[] k,
                              V[] v,
                              java.util.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:

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

Object2ObjectRBTreeMap

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

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

Method Detail

put

public V put(K k,
             V v)

Description copied from interface: Object2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Object2ObjectFunction<K,V>

Specified by:

put in interface Object2ObjectMap<K,V>

Specified by:

put in interface java.util.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(java.lang.Object k)

Description copied from interface: Object2ObjectFunction

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

Specified by:

remove in interface Object2ObjectFunction<K,V>

Specified by:

remove in interface Object2ObjectMap<K,V>

Specified by:

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

Specified by:

containsValue in interface java.util.Map<K,V>

Overrides:

containsValue in class AbstractObject2ObjectMap<K,V>

clear

public void clear()

Description copied from interface: Object2ObjectMap

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

Specified by:

clear in interface Object2ObjectMap<K,V>

Specified by:

clear in interface java.util.Map<K,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(java.lang.Object k)

Description copied from interface: Object2ObjectMap

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

Specified by:

containsKey in interface Object2ObjectMap<K,V>

Specified by:

containsKey in interface java.util.Map<K,V>

Overrides:

containsKey in class AbstractObject2ObjectMap<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: Object2ObjectMap

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

Specified by:

size in interface java.util.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 java.util.Map<K,V>

Overrides:

isEmpty in class AbstractObject2ObjectMap<K,V>

get

public V get(java.lang.Object k)

Description copied from interface: Object2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Object2ObjectFunction<K,V>

Specified by:

get in interface java.util.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 java.util.SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface java.util.SortedMap<K,V>

object2ObjectEntrySet

public ObjectSortedSet<Object2ObjectMap.Entry<K,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectSortedMap

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:

object2ObjectEntrySet in interface Object2ObjectMap<K,V>

Specified by:

object2ObjectEntrySet in interface Object2ObjectSortedMap<K,V>

Returns:

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

See Also:

Object2ObjectSortedMap.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 Object2ObjectMap<K,V>

Specified by:

keySet in interface Object2ObjectSortedMap<K,V>

Specified by:

keySet in interface java.util.Map<K,V>

Specified by:

keySet in interface java.util.SortedMap<K,V>

Overrides:

keySet in class AbstractObject2ObjectSortedMap<K,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 Object2ObjectMap<K,V>

Specified by:

values in interface Object2ObjectSortedMap<K,V>

Specified by:

values in interface java.util.Map<K,V>

Specified by:

values in interface java.util.SortedMap<K,V>

Overrides:

values in class AbstractObject2ObjectSortedMap<K,V>

Returns:

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

See Also:

Map.values()

comparator

public java.util.Comparator<? super K> comparator()

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

comparator in interface java.util.SortedMap<K,V>

See Also:

SortedMap.comparator()

headMap

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

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

headMap in interface java.util.SortedMap<K,V>

See Also:

SortedMap.headMap(Object)

tailMap

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

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

tailMap in interface java.util.SortedMap<K,V>

See Also:

SortedMap.tailMap(Object)

subMap

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

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

subMap in interface java.util.SortedMap<K,V>

See Also:

SortedMap.subMap(Object,Object)

clone

public Object2ObjectRBTreeMap<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 java.lang.Object

Returns:

a deep copy of this tree map.