it.unimi.dsi.fastutil.bytes
Class Byte2ShortRBTreeMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.AbstractByte2ShortFunction
      extended by it.unimi.dsi.fastutil.bytes.AbstractByte2ShortMap
          extended by it.unimi.dsi.fastutil.bytes.AbstractByte2ShortSortedMap
              extended by it.unimi.dsi.fastutil.bytes.Byte2ShortRBTreeMap
All Implemented Interfaces:
Byte2ShortFunction, Byte2ShortMap, Byte2ShortSortedMap, Function<Byte,Short>, Serializable, Cloneable, Map<Byte,Short>, SortedMap<Byte,Short>

public class Byte2ShortRBTreeMap
extends AbstractByte2ShortSortedMap
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.bytes.AbstractByte2ShortMap
AbstractByte2ShortMap.BasicEntry
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ShortSortedMap
Byte2ShortSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ShortMap
Byte2ShortMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Byte2ShortRBTreeMap()
          Creates a new empty tree map.
Byte2ShortRBTreeMap(byte[] k, short[] v)
          Creates a new tree map using the elements of two parallel arrays.
Byte2ShortRBTreeMap(byte[] k, short[] v, Comparator<? super Byte> c)
          Creates a new tree map using the elements of two parallel arrays and the given comparator.
Byte2ShortRBTreeMap(Byte2ShortMap m)
          Creates a new tree map copying a given map.
Byte2ShortRBTreeMap(Byte2ShortSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Byte2ShortRBTreeMap(Comparator<? super Byte> c)
          Creates a new empty tree map with the given comparator.
Byte2ShortRBTreeMap(Map<? extends Byte,? extends Short> m)
          Creates a new tree map copying a given map.
Byte2ShortRBTreeMap(SortedMap<Byte,Short> m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 ObjectSortedSet<Byte2ShortMap.Entry> byte2ShortEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 Object clone()
          Returns a deep copy of this tree map.
 ByteComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 boolean containsKey(byte k)
          Checks whether the given value is contained in AbstractByte2ShortMap.keySet().
 boolean containsValue(short v)
          Checks whether the given value is contained in AbstractByte2ShortMap.values().
 byte firstByteKey()
           
 short get(byte k)
          Returns the value to which the given key is mapped.
 Byte2ShortSortedMap headMap(byte to)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 boolean isEmpty()
           
 ByteSortedSet keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 byte lastByteKey()
           
 short put(byte k, short v)
          Adds a pair to the map.
 Short put(Byte ok, Short ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 short remove(byte k)
          Removes the mapping with the given key.
 Short remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 Byte2ShortSortedMap subMap(byte from, byte to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Byte2ShortSortedMap tailMap(byte from)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ShortCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ShortSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ShortMap
containsValue, equals, hashCode, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ShortFunction
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.bytes.Byte2ShortFunction
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
 
Methods inherited from interface java.util.Map
containsKey, containsValue, equals, get, hashCode, putAll
 

Field Detail

serialVersionUID

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

Byte2ShortRBTreeMap

public Byte2ShortRBTreeMap()
Creates a new empty tree map.


Byte2ShortRBTreeMap

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

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

Byte2ShortRBTreeMap

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

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

Byte2ShortRBTreeMap

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

Byte2ShortRBTreeMap

public Byte2ShortRBTreeMap(Byte2ShortMap m)
Creates a new tree map copying a given map.

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

Byte2ShortRBTreeMap

public Byte2ShortRBTreeMap(Byte2ShortSortedMap 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.

Byte2ShortRBTreeMap

public Byte2ShortRBTreeMap(byte[] k,
                           short[] v,
                           Comparator<? super Byte> 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.

Byte2ShortRBTreeMap

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

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

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

containsValue

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

Specified by:
containsValue in interface Byte2ShortMap
Overrides:
containsValue in class AbstractByte2ShortMap
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<Byte,Short>
Specified by:
clear in interface Map<Byte,Short>
Overrides:
clear in class AbstractByte2ShortFunction
See Also:
Map.clear()

containsKey

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

Specified by:
containsKey in interface Byte2ShortFunction
Overrides:
containsKey in class AbstractByte2ShortMap
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<Byte,Short>
Specified by:
size in interface Map<Byte,Short>
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<Byte,Short>
Overrides:
isEmpty in class AbstractByte2ShortMap

get

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

Specified by:
get in interface Byte2ShortFunction
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)

firstByteKey

public byte firstByteKey()
Specified by:
firstByteKey in interface Byte2ShortSortedMap
See Also:
SortedMap.firstKey()

lastByteKey

public byte lastByteKey()
Specified by:
lastByteKey in interface Byte2ShortSortedMap
See Also:
SortedMap.lastKey()

byte2ShortEntrySet

public ObjectSortedSet<Byte2ShortMap.Entry> byte2ShortEntrySet()
Description copied from interface: Byte2ShortMap
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 Byte2ShortMap.entrySet() so that it returns an ObjectSet of objects of type Byte2ShortMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
byte2ShortEntrySet in interface Byte2ShortMap
Specified by:
byte2ShortEntrySet in interface Byte2ShortSortedMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Byte2ShortMap.entrySet()

keySet

public ByteSortedSet 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 Byte2ShortMap
Specified by:
keySet in interface Byte2ShortSortedMap
Specified by:
keySet in interface Map<Byte,Short>
Overrides:
keySet in class AbstractByte2ShortSortedMap
Returns:
a type-specific sorted set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ShortCollection 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 Byte2ShortMap
Specified by:
values in interface Byte2ShortSortedMap
Specified by:
values in interface Map<Byte,Short>
Overrides:
values in class AbstractByte2ShortSortedMap
Returns:
a type-specific collection view of the values contained in this map.
See Also:
Map.values()

comparator

public ByteComparator comparator()
Description copied from interface: Byte2ShortSortedMap
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 Byte2ShortSortedMap
Specified by:
comparator in interface SortedMap<Byte,Short>
See Also:
SortedMap.comparator()

headMap

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

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

tailMap

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

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

subMap

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

Specified by:
subMap in interface Byte2ShortSortedMap
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.