it.unimi.dsi.fastutil.shorts
Class Short2IntRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2IntFunction
      extended by it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap
          extended by it.unimi.dsi.fastutil.shorts.AbstractShort2IntSortedMap
              extended by it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap
All Implemented Interfaces:
Function<Short,Integer>, Short2IntFunction, Short2IntMap, Short2IntSortedMap, Serializable, Cloneable, Map<Short,Integer>, SortedMap<Short,Integer>

public class Short2IntRBTreeMap
extends AbstractShort2IntSortedMap
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.AbstractShort2IntSortedMap
AbstractShort2IntSortedMap.KeySetIterator, AbstractShort2IntSortedMap.ValuesCollection, AbstractShort2IntSortedMap.ValuesIterator
 
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap
AbstractShort2IntMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntSortedMap
Short2IntSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntMap
Short2IntMap.FastEntrySet
 
Field Summary
protected  ShortComparator 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<Short2IntMap.Entry> entries
          Cached set of entries.
protected  it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry firstEntry
          The first key in this map.
protected  ShortSortedSet keys
          Cached set of keys.
protected  it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry 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.
static long serialVersionUID
           
protected  Comparator<? super Short> storedComparator
          This map's comparator, as provided in the constructor.
protected  it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry tree
          A reference to the root entry.
protected  IntCollection values
          Cached collection of values.
 
Fields inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntFunction
defRetValue
 
Constructor Summary
Short2IntRBTreeMap()
          Creates a new empty tree map.
Short2IntRBTreeMap(Comparator<? super Short> c)
          Creates a new empty tree map with the given comparator.
Short2IntRBTreeMap(Map<? extends Short,? extends Integer> m)
          Creates a new tree map copying a given map.
Short2IntRBTreeMap(short[] k, int[] v)
          Creates a new tree map using the elements of two parallel arrays.
Short2IntRBTreeMap(short[] k, int[] v, Comparator<? super Short> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Short2IntRBTreeMap(Short2IntMap m)
          Creates a new tree map copying a given map.
Short2IntRBTreeMap(Short2IntSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Short2IntRBTreeMap(SortedMap<Short,Integer> 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).
 Short2IntRBTreeMap 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 AbstractShort2IntMap.keySet().
 boolean containsValue(int v)
          Checks whether the given value is contained in AbstractShort2IntMap.values().
 short firstShortKey()
           
 int get(short k)
          Returns the value to which the given key is mapped.
 Short2IntSortedMap 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()
           
 int put(short k, int v)
          Adds a pair to the map.
 Integer put(Short ok, Integer ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Integer remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int remove(short k)
          Removes the mapping with the given key.
 ObjectSortedSet<Short2IntMap.Entry> short2IntEntrySet()
          Returns a type-specific sorted-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.
 Short2IntSortedMap subMap(short from, short to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Short2IntSortedMap tailMap(short from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 IntCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntFunction
containsKey, defaultReturnValue, defaultReturnValue, get
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntFunction
defaultReturnValue, defaultReturnValue
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, get
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

tree

protected transient it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry tree
A reference to the root entry.


count

protected int count
Number of entries in this map.


firstEntry

protected transient it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry firstEntry
The first key in this map.


lastEntry

protected transient it.unimi.dsi.fastutil.shorts.Short2IntRBTreeMap.Entry lastEntry
The last key in this map.


entries

protected transient volatile ObjectSortedSet<Short2IntMap.Entry> entries
Cached set of entries.


keys

protected transient volatile ShortSortedSet keys
Cached set of keys.


values

protected transient volatile IntCollection 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 Short> storedComparator
This map's comparator, as provided in the constructor.


actualComparator

protected transient ShortComparator 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.


serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Short2IntRBTreeMap

public Short2IntRBTreeMap()
Creates a new empty tree map.


Short2IntRBTreeMap

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

Parameters:
c - a (possibly type-specific) comparator.

Short2IntRBTreeMap

public Short2IntRBTreeMap(Map<? extends Short,? extends Integer> m)
Creates a new tree map copying a given map.

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

Short2IntRBTreeMap

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

Short2IntRBTreeMap

public Short2IntRBTreeMap(Short2IntMap m)
Creates a new tree map copying a given map.

Parameters:
m - a type-specific map to be copied into the new tree map.

Short2IntRBTreeMap

public Short2IntRBTreeMap(Short2IntSortedMap 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.

Short2IntRBTreeMap

public Short2IntRBTreeMap(short[] k,
                          int[] 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.

Short2IntRBTreeMap

public Short2IntRBTreeMap(short[] k,
                          int[] 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 int put(short k,
               int v)
Description copied from interface: Short2IntFunction
Adds a pair to the map.

Specified by:
put in interface Short2IntFunction
Overrides:
put in class AbstractShort2IntFunction
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 int remove(short k)
Description copied from interface: Short2IntFunction
Removes the mapping with the given key.

Specified by:
remove in interface Short2IntFunction
Overrides:
remove in class AbstractShort2IntFunction
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 Integer put(Short ok,
                   Integer ov)
Description copied from class: AbstractShort2IntFunction
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,Integer>
Specified by:
put in interface Map<Short,Integer>
Overrides:
put in class AbstractShort2IntFunction
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 Integer remove(Object ok)
Description copied from class: AbstractShort2IntFunction
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,Integer>
Specified by:
remove in interface Map<Short,Integer>
Overrides:
remove in class AbstractShort2IntFunction
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

containsValue

public boolean containsValue(int v)
Description copied from class: AbstractShort2IntMap
Checks whether the given value is contained in AbstractShort2IntMap.values().

Specified by:
containsValue in interface Short2IntMap
Overrides:
containsValue in class AbstractShort2IntMap
See Also:
Map.containsValue(Object)

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<Short,Integer>
Specified by:
clear in interface Map<Short,Integer>
Overrides:
clear in class AbstractShort2IntFunction
See Also:
Map.clear()

containsKey

public boolean containsKey(short k)
Description copied from class: AbstractShort2IntMap
Checks whether the given value is contained in AbstractShort2IntMap.keySet().

Specified by:
containsKey in interface Short2IntFunction
Overrides:
containsKey in class AbstractShort2IntMap
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,Integer>
Specified by:
size in interface Map<Short,Integer>
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,Integer>
Overrides:
isEmpty in class AbstractShort2IntMap

get

public int get(short k)
Description copied from interface: Short2IntFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Short2IntFunction
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 Short2IntSortedMap
See Also:
SortedMap.firstKey()

lastShortKey

public short lastShortKey()
Specified by:
lastShortKey in interface Short2IntSortedMap
See Also:
SortedMap.lastKey()

short2IntEntrySet

public ObjectSortedSet<Short2IntMap.Entry> short2IntEntrySet()
Description copied from interface: Short2IntSortedMap
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:
short2IntEntrySet in interface Short2IntMap
Specified by:
short2IntEntrySet in interface Short2IntSortedMap
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Short2IntSortedMap.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 Short2IntMap
Specified by:
keySet in interface Short2IntSortedMap
Specified by:
keySet in interface Map<Short,Integer>
Specified by:
keySet in interface SortedMap<Short,Integer>
Overrides:
keySet in class AbstractShort2IntSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public IntCollection 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 Short2IntMap
Specified by:
values in interface Short2IntSortedMap
Specified by:
values in interface Map<Short,Integer>
Specified by:
values in interface SortedMap<Short,Integer>
Overrides:
values in class AbstractShort2IntSortedMap
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: Short2IntSortedMap
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 Short2IntSortedMap
Specified by:
comparator in interface SortedMap<Short,Integer>
See Also:
SortedMap.comparator()

headMap

public Short2IntSortedMap headMap(short to)
Description copied from interface: Short2IntSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Short2IntSortedMap
See Also:
SortedMap.headMap(Object)

tailMap

public Short2IntSortedMap tailMap(short from)
Description copied from interface: Short2IntSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Short2IntSortedMap
See Also:
SortedMap.tailMap(Object)

subMap

public Short2IntSortedMap subMap(short from,
                                 short to)
Description copied from interface: Short2IntSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Short2IntSortedMap
See Also:
SortedMap.subMap(Object,Object)

clone

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


Copyright © 2011. All Rights Reserved.