it.unimi.dsi.fastutil.ints
Class Int2ByteRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2ByteFunction
      it.unimi.dsi.fastutil.ints.AbstractInt2ByteMap
          it.unimi.dsi.fastutil.ints.AbstractInt2ByteSortedMap
              it.unimi.dsi.fastutil.ints.Int2ByteRBTreeMap

All Implemented Interfaces:

Function<Integer,Byte>, Int2ByteFunction, Int2ByteMap, Int2ByteSortedMap, Serializable, Cloneable, Map<Integer,Byte>, SortedMap<Integer,Byte>

public class Int2ByteRBTreeMap
extends AbstractInt2ByteSortedMap
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.ints.AbstractInt2ByteMap

AbstractInt2ByteMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ByteSortedMap

Int2ByteSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ByteMap

Int2ByteMap.FastEntrySet

Field Summary

static long

serialVersionUID

Constructor Summary

Int2ByteRBTreeMap()
Creates a new empty tree map.

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

Int2ByteRBTreeMap(int[] k, byte[] v)
Creates a new tree map using the elements of two parallel arrays.

Int2ByteRBTreeMap(int[] k, byte[] v, Comparator<? super Integer> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Int2ByteRBTreeMap(Int2ByteMap m)
Creates a new tree map copying a given map.

Int2ByteRBTreeMap(Int2ByteSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Int2ByteRBTreeMap(Map<? extends Integer,? extends Byte> m)
Creates a new tree map copying a given map.

Int2ByteRBTreeMap(SortedMap<Integer,Byte> 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.
IntComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(int k) Checks whether the given value is contained in AbstractInt2ByteMap.keySet().
boolean	containsValue(byte v) Checks whether the given value is contained in AbstractInt2ByteMap.values().
int	firstIntKey()
byte	get(int k) Returns the value to which the given key is mapped.
Int2ByteSortedMap	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2ByteMap.Entry>	int2ByteEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
int	lastIntKey()
byte	put(int k, byte v) Adds a pair to the map.
Byte	put(Integer ok, Byte ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
byte	remove(int k) Removes the mapping with the given key.
Byte	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.
Int2ByteSortedMap	subMap(int from, int to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Int2ByteSortedMap	tailMap(int from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
ByteCollection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ByteSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ByteMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ByteFunction

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.ints.Int2ByteFunction

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

Int2ByteRBTreeMap

public Int2ByteRBTreeMap()

Creates a new empty tree map.

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(Comparator<? super Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(Map<? extends Integer,? extends Byte> m)

Creates a new tree map copying a given map.

Parameters:

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

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(SortedMap<Integer,Byte> 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.

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(Int2ByteMap m)

Creates a new tree map copying a given map.

Parameters:

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

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(Int2ByteSortedMap 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.

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(int[] k,
                         byte[] v,
                         Comparator<? super Integer> 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.

Int2ByteRBTreeMap

public Int2ByteRBTreeMap(int[] k,
                         byte[] 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 byte put(int k,
                byte v)

Description copied from interface: Int2ByteFunction

Adds a pair to the map.

Specified by:

put in interface Int2ByteFunction

Overrides:

put in class AbstractInt2ByteFunction

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 byte remove(int k)

Description copied from interface: Int2ByteFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2ByteFunction

Overrides:

remove in class AbstractInt2ByteFunction

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 Byte put(Integer ok,
                Byte ov)

Description copied from class: AbstractInt2ByteFunction

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<Integer,Byte>

Specified by:

put in interface Map<Integer,Byte>

Overrides:

put in class AbstractInt2ByteFunction

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 Byte remove(Object ok)

Description copied from class: AbstractInt2ByteFunction

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<Integer,Byte>

Specified by:

remove in interface Map<Integer,Byte>

Overrides:

remove in class AbstractInt2ByteFunction

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(byte v)

Description copied from class: AbstractInt2ByteMap

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

Specified by:

containsValue in interface Int2ByteMap

Overrides:

containsValue in class AbstractInt2ByteMap

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<Integer,Byte>

Specified by:

clear in interface Map<Integer,Byte>

Overrides:

clear in class AbstractInt2ByteFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2ByteMap

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

Specified by:

containsKey in interface Int2ByteFunction

Overrides:

containsKey in class AbstractInt2ByteMap

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<Integer,Byte>

Specified by:

size in interface Map<Integer,Byte>

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<Integer,Byte>

Overrides:

isEmpty in class AbstractInt2ByteMap

get

public byte get(int k)

Description copied from interface: Int2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ByteFunction

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)

firstIntKey

public int firstIntKey()

Specified by:

firstIntKey in interface Int2ByteSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2ByteSortedMap

See Also:

SortedMap.lastKey()

int2ByteEntrySet

public ObjectSortedSet<Int2ByteMap.Entry> int2ByteEntrySet()

Description copied from interface: Int2ByteMap

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 Int2ByteMap.entrySet() so that it returns an ObjectSet of objects of type Int2ByteMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

int2ByteEntrySet in interface Int2ByteMap

Specified by:

int2ByteEntrySet in interface Int2ByteSortedMap

Returns:

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

See Also:

Int2ByteMap.entrySet()

keySet

public IntSortedSet 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 Int2ByteMap

Specified by:

keySet in interface Int2ByteSortedMap

Specified by:

keySet in interface Map<Integer,Byte>

Overrides:

keySet in class AbstractInt2ByteSortedMap

Returns:

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

See Also:

Map.keySet()

values

public ByteCollection 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 Int2ByteMap

Specified by:

values in interface Int2ByteSortedMap

Specified by:

values in interface Map<Integer,Byte>

Overrides:

values in class AbstractInt2ByteSortedMap

Returns:

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

See Also:

Map.values()

comparator

public IntComparator comparator()

Description copied from interface: Int2ByteSortedMap

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 Int2ByteSortedMap

Specified by:

comparator in interface SortedMap<Integer,Byte>

See Also:

SortedMap.comparator()

headMap

public Int2ByteSortedMap headMap(int to)

Description copied from interface: Int2ByteSortedMap

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

Specified by:

headMap in interface Int2ByteSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2ByteSortedMap tailMap(int from)

Description copied from interface: Int2ByteSortedMap

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

Specified by:

tailMap in interface Int2ByteSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2ByteSortedMap subMap(int from,
                                int to)

Description copied from interface: Int2ByteSortedMap

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

Specified by:

subMap in interface Int2ByteSortedMap

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.