it.unimi.dsi.fastutil.shorts

Class Short2ObjectRBTreeMap<V>

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction<V>

it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectMap<V>

it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectSortedMap<V>

it.unimi.dsi.fastutil.shorts.Short2ObjectRBTreeMap<V>

All Implemented Interfaces:

Short2ObjectFunction<V>, Short2ObjectMap<V>, Short2ObjectSortedMap<V>, Serializable, Cloneable, Function<Short,V>, IntFunction<V>, Map<Short,V>, SortedMap<Short,V>

public class Short2ObjectRBTreeMap<V>
extends AbstractShort2ObjectSortedMap<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.shorts.AbstractShort2ObjectMap

AbstractShort2ObjectMap.BasicEntry<V>, AbstractShort2ObjectMap.BasicEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectSortedMap

Short2ObjectSortedMap.FastSortedEntrySet<V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectMap

Short2ObjectMap.FastEntrySet<V>

Constructor Summary

Constructors

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

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectMap

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.shorts.Short2ObjectFunction

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

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap()

Creates a new empty tree map.

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(Comparator<? super Short> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(Map<? extends Short,? extends V> m)

Creates a new tree map copying a given map.

Parameters:

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

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(SortedMap<Short,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.

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(Short2ObjectMap<? 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.

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(Short2ObjectSortedMap<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.

Short2ObjectRBTreeMap

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

Short2ObjectRBTreeMap

public Short2ObjectRBTreeMap(short[] 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(short k,
             V v)

Description copied from interface: Short2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Short2ObjectFunction<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(short k)

Description copied from interface: Short2ObjectFunction

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

Specified by:

remove in interface Short2ObjectFunction<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<Short,V>

Overrides:

containsValue in class AbstractShort2ObjectMap<V>

clear

public void clear()

Description copied from interface: Short2ObjectMap

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

Specified by:

clear in interface Short2ObjectMap<V>

Specified by:

clear in interface Map<Short,V>

See Also:

Map.clear()

containsKey

public boolean containsKey(short k)

Description copied from interface: Short2ObjectMap

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

Specified by:

containsKey in interface Short2ObjectFunction<V>

Specified by:

containsKey in interface Short2ObjectMap<V>

Overrides:

containsKey in class AbstractShort2ObjectMap<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: Short2ObjectMap

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

Specified by:

size in interface Map<Short,V>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Short,V>

Overrides:

isEmpty in class AbstractShort2ObjectMap<V>

get

public V get(short k)

Description copied from interface: Short2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

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

firstShortKey

public short firstShortKey()

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

firstShortKey in interface Short2ObjectSortedMap<V>

See Also:

SortedMap.firstKey()

lastShortKey

public short lastShortKey()

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

lastShortKey in interface Short2ObjectSortedMap<V>

See Also:

SortedMap.lastKey()

short2ObjectEntrySet

public ObjectSortedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()

Description copied from interface: Short2ObjectSortedMap

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:

short2ObjectEntrySet in interface Short2ObjectMap<V>

Specified by:

short2ObjectEntrySet in interface Short2ObjectSortedMap<V>

Returns:

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

See Also:

Short2ObjectSortedMap.entrySet()

keySet

public ShortSortedSet 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 Short2ObjectMap<V>

Specified by:

keySet in interface Short2ObjectSortedMap<V>

Specified by:

keySet in interface Map<Short,V>

Specified by:

keySet in interface SortedMap<Short,V>

Overrides:

keySet in class AbstractShort2ObjectSortedMap<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 Short2ObjectMap<V>

Specified by:

values in interface Short2ObjectSortedMap<V>

Specified by:

values in interface Map<Short,V>

Specified by:

values in interface SortedMap<Short,V>

Overrides:

values in class AbstractShort2ObjectSortedMap<V>

Returns:

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

See Also:

Map.values()

comparator

public ShortComparator comparator()

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

comparator in interface SortedMap<Short,V>

See Also:

SortedMap.comparator()

headMap

public Short2ObjectSortedMap<V> headMap(short to)

Description copied from interface: Short2ObjectSortedMap

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

See Also:

SortedMap.headMap(Object)

tailMap

public Short2ObjectSortedMap<V> tailMap(short from)

Description copied from interface: Short2ObjectSortedMap

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

See Also:

SortedMap.tailMap(Object)

subMap

public Short2ObjectSortedMap<V> subMap(short from,
                                       short to)

Description copied from interface: Short2ObjectSortedMap

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

See Also:

SortedMap.subMap(Object,Object)

clone

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