it.unimi.dsi.fastutil.bytes
Class Byte2ReferenceRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceMap
      it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceSortedMap
          it.unimi.dsi.fastutil.bytes.Byte2ReferenceRBTreeMap

All Implemented Interfaces:

Byte2ReferenceMap, Byte2ReferenceSortedMap, Cloneable, Map, Serializable, SortedMap

public class Byte2ReferenceRBTreeMap

extends AbstractByte2ReferenceSortedMap

implements Serializable, Cloneable, Byte2ReferenceSortedMap

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 inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceMap

AbstractByte2ReferenceMap.BasicEntry

Field Summary

static long

serialVersionUID

Constructor Summary

Byte2ReferenceRBTreeMap()
Creates a new empty tree map.

Byte2ReferenceRBTreeMap(Byte2ReferenceMap m)
Creates a new tree map copying a given map.

Byte2ReferenceRBTreeMap(Byte2ReferenceSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Byte2ReferenceRBTreeMap(Comparator c)
Creates a new empty tree map with the given comparator.

Byte2ReferenceRBTreeMap(Map m)
Creates a new tree map copying a given map.

Byte2ReferenceRBTreeMap(SortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

void	clear()
Object	clone() Returns a deep copy of this tree map.
Comparator	comparator()
boolean	containsKey(byte k) Checks whether the given value is contained in keySet().
boolean	containsValue(Object v) Checks whether the given value is contained in values().
Set	entrySet()
byte	firstByteKey()
Object	firstKey() Delegates to the corresponding type-specific method.
Object	get(byte k) Returns the value to which the given key is mapped.
Object	get(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Byte2ReferenceSortedMap	headMap(byte to)
boolean	isEmpty()
Set	keySet() Returns a type-specific sorted set view of the keys contained in this map.
byte	lastByteKey()
Object	lastKey() Delegates to the corresponding type-specific method.
Object	put(byte k, Object v) Adds a pair to the map.
Object	put(Object ok, Object ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Object	remove(byte k) Removes the mapping with the given key.
Object	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size()
Byte2ReferenceSortedMap	subMap(byte from, byte to)
Byte2ReferenceSortedMap	tailMap(byte from)
Collection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceSortedMap

headMap, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceMap

containsKey, defaultReturnValue, defaultReturnValue, equals, getDefRetValue, hashCode, putAll, setDefRetValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ReferenceMap

defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, putAll

Methods inherited from interface java.util.SortedMap

headMap, subMap, tailMap

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap()

Creates a new empty tree map.

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap(Comparator c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a Comparator.

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap(Map m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap(SortedMap 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.

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap(Byte2ReferenceMap m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2ReferenceRBTreeMap

public Byte2ReferenceRBTreeMap(Byte2ReferenceSortedMap 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.

Method Detail

put

public final Object put(byte k,
                        Object v)

Description copied from interface: Byte2ReferenceMap

Adds a pair to the map.

Specified by:

put in interface Byte2ReferenceMap

Overrides:

put in class AbstractByte2ReferenceMap

remove

public final Object remove(byte k)

Description copied from interface: Byte2ReferenceMap

Removes the mapping with the given key.

Specified by:

remove in interface Byte2ReferenceMap

Overrides:

remove in class AbstractByte2ReferenceMap

put

public Object put(Object ok,
                  Object ov)

Description copied from class: AbstractByte2ReferenceMap

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 Map

Overrides:

put in class AbstractByte2ReferenceMap

remove

public Object remove(Object ok)

Description copied from class: AbstractByte2ReferenceMap

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 Map

Overrides:

remove in class AbstractByte2ReferenceMap

containsValue

public boolean containsValue(Object v)

Description copied from class: AbstractByte2ReferenceMap

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

Specified by:

containsValue in interface Map

Overrides:

containsValue in class AbstractByte2ReferenceMap

clear

public void clear()

Specified by:

clear in interface Map

Overrides:

clear in class AbstractByte2ReferenceMap

containsKey

public boolean containsKey(byte k)

Description copied from class: AbstractByte2ReferenceMap

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

Specified by:

containsKey in interface Byte2ReferenceMap

Overrides:

containsKey in class AbstractByte2ReferenceMap

size

public int size()

Specified by:

size in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class AbstractByte2ReferenceMap

get

public Object get(byte k)

Description copied from interface: Byte2ReferenceMap

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2ReferenceMap

Parameters:

k - the key.

Returns:

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

See Also:

Map.get(Object)

get

public Object get(Object ok)

Description copied from class: AbstractByte2ReferenceMap

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:

get in interface Map

Overrides:

get in class AbstractByte2ReferenceMap

firstByteKey

public byte firstByteKey()

Specified by:

firstByteKey in interface Byte2ReferenceSortedMap

See Also:

SortedMap.firstKey()

lastByteKey

public byte lastByteKey()

Specified by:

lastByteKey in interface Byte2ReferenceSortedMap

See Also:

SortedMap.lastKey()

firstKey

public Object firstKey()

Description copied from class: AbstractByte2ReferenceSortedMap

Delegates to the corresponding type-specific method.

Specified by:

firstKey in interface SortedMap

Overrides:

firstKey in class AbstractByte2ReferenceSortedMap

lastKey

public Object lastKey()

Description copied from class: AbstractByte2ReferenceSortedMap

Delegates to the corresponding type-specific method.

Specified by:

lastKey in interface SortedMap

Overrides:

lastKey in class AbstractByte2ReferenceSortedMap

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

keySet

public Set 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 Map

Overrides:

keySet in class AbstractByte2ReferenceSortedMap

Returns:

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

values

public Collection 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 Map

Overrides:

values in class AbstractByte2ReferenceMap

Returns:

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

comparator

public Comparator comparator()

Specified by:

comparator in interface SortedMap

headMap

public Byte2ReferenceSortedMap headMap(byte to)

Specified by:

headMap in interface Byte2ReferenceSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Byte2ReferenceSortedMap tailMap(byte from)

Specified by:

tailMap in interface Byte2ReferenceSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Byte2ReferenceSortedMap subMap(byte from,
                                      byte to)

Specified by:

subMap in interface Byte2ReferenceSortedMap

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.

Returns:

a deep copy of this tree map.