it.unimi.dsi.fastutil.objects
Class Object2LongRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2LongMap
      it.unimi.dsi.fastutil.objects.AbstractObject2LongSortedMap
          it.unimi.dsi.fastutil.objects.Object2LongRBTreeMap

All Implemented Interfaces:

Cloneable, Map, Object2LongMap, Object2LongSortedMap, Serializable, SortedMap

public class Object2LongRBTreeMap

extends AbstractObject2LongSortedMap

implements Serializable, Cloneable, Object2LongSortedMap

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.objects.AbstractObject2LongMap

AbstractObject2LongMap.BasicEntry

Field Summary

static long

serialVersionUID

Constructor Summary

Object2LongRBTreeMap()
Creates a new empty tree map.

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

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

Object2LongRBTreeMap(Object2LongMap m)
Creates a new tree map copying a given map.

Object2LongRBTreeMap(Object2LongSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Object2LongRBTreeMap(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(Object k) Checks whether the given value is contained in keySet().
boolean	containsValue(long v) Checks whether the given value is contained in values().
Set	entrySet()
Object	firstKey() Delegates to the corresponding type-specific method.
Object	get(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
long	getLong(Object k) Returns the value to which the given key is mapped.
SortedMap	headMap(Object to) Delegates to the corresponding type-specific method.
boolean	isEmpty()
Set	keySet() Returns a type-specific sorted set view of the keys contained in this map.
Object	lastKey() Delegates to the corresponding type-specific method.
long	put(Object k, long 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(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
long	removeLong(Object k) Removes the mapping with the given key.
int	size()
SortedMap	subMap(Object from, Object to) Delegates to the corresponding type-specific method.
SortedMap	tailMap(Object from) Delegates to the corresponding type-specific method.
Collection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2LongMap

containsValue, 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.objects.Object2LongMap

defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Object2LongRBTreeMap

public Object2LongRBTreeMap()

Creates a new empty tree map.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Comparator c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a Comparator.

Object2LongRBTreeMap

public Object2LongRBTreeMap(Map m)

Creates a new tree map copying a given map.

Parameters:

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

Object2LongRBTreeMap

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

Object2LongRBTreeMap

public Object2LongRBTreeMap(Object2LongMap m)

Creates a new tree map copying a given map.

Parameters:

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

Object2LongRBTreeMap

public Object2LongRBTreeMap(Object2LongSortedMap 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 long put(Object k,
                      long v)

Description copied from interface: Object2LongMap

Adds a pair to the map.

Specified by:

put in interface Object2LongMap

Overrides:

put in class AbstractObject2LongMap

removeLong

public final long removeLong(Object k)

Description copied from interface: Object2LongMap

Removes the mapping with the given key.

Specified by:

removeLong in interface Object2LongMap

Overrides:

removeLong in class AbstractObject2LongMap

put

public Object put(Object ok,
                  Object ov)

Description copied from class: AbstractObject2LongMap

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 AbstractObject2LongMap

remove

public Object remove(Object ok)

Description copied from class: AbstractObject2LongMap

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 AbstractObject2LongMap

containsValue

public boolean containsValue(long v)

Description copied from class: AbstractObject2LongMap

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

Specified by:

containsValue in interface Object2LongMap

Overrides:

containsValue in class AbstractObject2LongMap

clear

public void clear()

Specified by:

clear in interface Map

Overrides:

clear in class AbstractObject2LongMap

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2LongMap

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

Specified by:

containsKey in interface Map

Overrides:

containsKey in class AbstractObject2LongMap

size

public int size()

Specified by:

size in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class AbstractObject2LongMap

getLong

public long getLong(Object k)

Description copied from interface: Object2LongMap

Returns the value to which the given key is mapped.

Specified by:

getLong in interface Object2LongMap

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: AbstractObject2LongMap

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 AbstractObject2LongMap

firstKey

public Object firstKey()

Description copied from class: AbstractObject2LongSortedMap

Delegates to the corresponding type-specific method.

Specified by:

firstKey in interface SortedMap

Overrides:

firstKey in class AbstractObject2LongSortedMap

lastKey

public Object lastKey()

Description copied from class: AbstractObject2LongSortedMap

Delegates to the corresponding type-specific method.

Specified by:

lastKey in interface SortedMap

Overrides:

lastKey in class AbstractObject2LongSortedMap

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 AbstractObject2LongSortedMap

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 AbstractObject2LongMap

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 SortedMap headMap(Object to)

Description copied from class: AbstractObject2LongSortedMap

Delegates to the corresponding type-specific method.

Specified by:

headMap in interface SortedMap

Overrides:

headMap in class AbstractObject2LongSortedMap

tailMap

public SortedMap tailMap(Object from)

Description copied from class: AbstractObject2LongSortedMap

Delegates to the corresponding type-specific method.

Specified by:

tailMap in interface SortedMap

Overrides:

tailMap in class AbstractObject2LongSortedMap

subMap

public SortedMap subMap(Object from,
                        Object to)

Description copied from class: AbstractObject2LongSortedMap

Delegates to the corresponding type-specific method.

Specified by:

subMap in interface SortedMap

Overrides:

subMap in class AbstractObject2LongSortedMap

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.