it.unimi.dsi.fastutil.shorts
Class Short2ReferenceRBTreeMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceFunction<V>
      it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceMap<V>
          it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceSortedMap<V>
              it.unimi.dsi.fastutil.shorts.Short2ReferenceRBTreeMap<V>

All Implemented Interfaces:

Function<Short,V>, Short2ReferenceFunction<V>, Short2ReferenceMap<V>, Short2ReferenceSortedMap<V>, Serializable, Cloneable, Map<Short,V>, SortedMap<Short,V>

public class Short2ReferenceRBTreeMap<V>
extends AbstractShort2ReferenceSortedMap<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.AbstractShort2ReferenceMap

AbstractShort2ReferenceMap.BasicEntry<V>

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

Short2ReferenceSortedMap.FastSortedEntrySet<V>

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

Short2ReferenceMap.FastEntrySet<V>

Field Summary

static long

serialVersionUID

Constructor Summary

Short2ReferenceRBTreeMap()
Creates a new empty tree map.

Short2ReferenceRBTreeMap(Comparator<? super Short> c)
Creates a new empty tree map with the given comparator.

Short2ReferenceRBTreeMap(Map<? extends Short,? extends V> m)
Creates a new tree map copying a given map.

Short2ReferenceRBTreeMap(short[] k, V[] v)
Creates a new tree map using the elements of two parallel arrays.

Short2ReferenceRBTreeMap(short[] k, V[] v, Comparator<? super Short> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Short2ReferenceRBTreeMap(Short2ReferenceMap<? extends V> m)
Creates a new tree map copying a given map.

Short2ReferenceRBTreeMap(Short2ReferenceSortedMap<V> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Short2ReferenceRBTreeMap(SortedMap<Short,V> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

void	clear() Removes all associations from this function (optional operation).
Object	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) Checks whether the given value is contained in AbstractShort2ReferenceMap.keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in AbstractShort2ReferenceMap.values().
short	firstShortKey()
V	get(short k) Returns the value to which the given key is mapped.
Short2ReferenceSortedMap<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()
V	put(short k, V v) Adds a pair to the map.
V	put(Short ok, V ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
V	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
V	remove(short k) Removes the mapping with the given key.
ObjectSortedSet<Short2ReferenceMap.Entry<V>>	short2ReferenceEntrySet() Returns a type-specific set view of the mappings contained in this map.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
Short2ReferenceSortedMap<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.
Short2ReferenceSortedMap<V>	tailMap(short 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.shorts.AbstractShort2ReferenceSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

defaultReturnValue, defaultReturnValue

Methods inherited from interface it.unimi.dsi.fastutil.Function

containsKey, get

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, putAll

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap()

Creates a new empty tree map.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(Comparator<? super Short> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(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.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(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.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(Short2ReferenceMap<? 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.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(Short2ReferenceSortedMap<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.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(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.

Short2ReferenceRBTreeMap

public Short2ReferenceRBTreeMap(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: Short2ReferenceFunction

Adds a pair to the map.

Specified by:

put in interface Short2ReferenceFunction<V>

Overrides:

put in class AbstractShort2ReferenceFunction<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: Short2ReferenceFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2ReferenceFunction<V>

Overrides:

remove in class AbstractShort2ReferenceFunction<V>

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

put

public V put(Short ok,
             V ov)

Description copied from class: AbstractShort2ReferenceFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<Short,V>

Specified by:

put in interface Map<Short,V>

Overrides:

put in class AbstractShort2ReferenceFunction<V>

Parameters:

ok - the key.

ov - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public V remove(Object ok)

Description copied from class: AbstractShort2ReferenceFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

remove in interface Function<Short,V>

Specified by:

remove in interface Map<Short,V>

Overrides:

remove in class AbstractShort2ReferenceFunction<V>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractShort2ReferenceMap

Checks whether the given value is contained in AbstractShort2ReferenceMap.values().

Specified by:

containsValue in interface Map<Short,V>

Overrides:

containsValue in class AbstractShort2ReferenceMap<V>

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Short,V>

Specified by:

clear in interface Map<Short,V>

Overrides:

clear in class AbstractShort2ReferenceFunction<V>

See Also:

Map.clear()

containsKey

public boolean containsKey(short k)

Description copied from class: AbstractShort2ReferenceMap

Checks whether the given value is contained in AbstractShort2ReferenceMap.keySet().

Specified by:

containsKey in interface Short2ReferenceFunction<V>

Overrides:

containsKey in class AbstractShort2ReferenceMap<V>

See Also:

Function.containsKey(Object)

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<Short,V>

Specified by:

size in interface Map<Short,V>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Short,V>

Overrides:

isEmpty in class AbstractShort2ReferenceMap<V>

get

public V get(short k)

Description copied from interface: Short2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

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

Specified by:

firstShortKey in interface Short2ReferenceSortedMap<V>

See Also:

SortedMap.firstKey()

lastShortKey

public short lastShortKey()

Specified by:

lastShortKey in interface Short2ReferenceSortedMap<V>

See Also:

SortedMap.lastKey()

short2ReferenceEntrySet

public ObjectSortedSet<Short2ReferenceMap.Entry<V>> short2ReferenceEntrySet()

Description copied from interface: Short2ReferenceMap

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

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Short2ReferenceMap.entrySet() so that it returns an ObjectSet of objects of type Short2ReferenceMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

short2ReferenceEntrySet in interface Short2ReferenceMap<V>

Specified by:

short2ReferenceEntrySet in interface Short2ReferenceSortedMap<V>

Returns:

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

See Also:

Short2ReferenceMap.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 Short2ReferenceMap<V>

Specified by:

keySet in interface Short2ReferenceSortedMap<V>

Specified by:

keySet in interface Map<Short,V>

Overrides:

keySet in class AbstractShort2ReferenceSortedMap<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 Short2ReferenceMap<V>

Specified by:

values in interface Short2ReferenceSortedMap<V>

Specified by:

values in interface Map<Short,V>

Overrides:

values in class AbstractShort2ReferenceSortedMap<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: Short2ReferenceSortedMap

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

Specified by:

comparator in interface SortedMap<Short,V>

See Also:

SortedMap.comparator()

headMap

public Short2ReferenceSortedMap<V> headMap(short to)

Description copied from interface: Short2ReferenceSortedMap

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Short2ReferenceSortedMap<V>

See Also:

SortedMap.headMap(Object)

tailMap

public Short2ReferenceSortedMap<V> tailMap(short from)

Description copied from interface: Short2ReferenceSortedMap

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Short2ReferenceSortedMap<V>

See Also:

SortedMap.tailMap(Object)

subMap

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

Description copied from interface: Short2ReferenceSortedMap

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Short2ReferenceSortedMap<V>

See Also:

SortedMap.subMap(Object,Object)

clone

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

Overrides:

clone in class Object

Returns:

a deep copy of this tree map.