Class Byte2ByteRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.bytes.AbstractByte2ByteFunction

it.unimi.dsi.fastutil.bytes.AbstractByte2ByteMap

it.unimi.dsi.fastutil.bytes.AbstractByte2ByteSortedMap

it.unimi.dsi.fastutil.bytes.Byte2ByteRBTreeMap

All Implemented Interfaces:

Byte2ByteFunction, Byte2ByteMap, Byte2ByteSortedMap, Function<Byte,Byte>, Serializable, Cloneable, Function<Byte,Byte>, IntUnaryOperator, Map<Byte,Byte>, SequencedMap<Byte,Byte>, SortedMap<Byte,Byte>

public class Byte2ByteRBTreeMap
extends AbstractByte2ByteSortedMap
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.AbstractByte2ByteMap

AbstractByte2ByteMap.BasicEntry, AbstractByte2ByteMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ByteMap

Byte2ByteMap.FastEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ByteSortedMap

Byte2ByteSortedMap.FastSortedEntrySet

Constructor Summary

Constructors

Constructor	Description
Byte2ByteRBTreeMap()	Creates a new empty tree map.
Byte2ByteRBTreeMap(byte[] k, byte[] v)	Creates a new tree map using the elements of two parallel arrays.
Byte2ByteRBTreeMap(byte[] k, byte[] v, Comparator<? super Byte> c)	Creates a new tree map using the elements of two parallel arrays and the given comparator.
Byte2ByteRBTreeMap(Byte2ByteMap m)	Creates a new tree map copying a given map.
Byte2ByteRBTreeMap(Byte2ByteSortedMap m)	Creates a new tree map copying a given sorted map (and its Comparator).
Byte2ByteRBTreeMap(Comparator<? super Byte> c)	Creates a new empty tree map with the given comparator.
Byte2ByteRBTreeMap(Map<? extends Byte, ? extends Byte> m)	Creates a new tree map copying a given map.
Byte2ByteRBTreeMap(SortedMap<Byte,Byte> m)	Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Modifier and Type	Method	Description
byte	addTo(byte k, byte incr)	Adds an increment to value currently associated with a key.
ObjectSortedSet<Byte2ByteMap.Entry>	byte2ByteEntrySet()	Returns a type-specific set view of the mappings contained in this map.
void	clear()	Removes all associations from this function (optional operation).
Byte2ByteRBTreeMap	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)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(byte v)	Returns true if this map maps one or more keys to the specified value.
byte	firstByteKey()	Returns the first (lowest) key currently in this map.
byte	get(byte k)	Returns the value to which the given key is mapped.
Byte2ByteSortedMap	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()	Returns the last (highest) key currently in this map.
byte	put(byte k, byte v)	Adds a pair to the map (optional operation).
byte	remove(byte k)	Removes the mapping with the given key (optional operation).
int	size()	Returns the intended number of keys in this function, or -1 if no such number exists.
Byte2ByteSortedMap	subMap(byte from, byte to)	Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Byte2ByteSortedMap	tailMap(byte 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.bytes.AbstractByte2ByteMap

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfAbsentNullable, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, forEach, forEach, get, getOrDefault, getOrDefault, merge, merge, mergeByte, mergeByte, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

containsKey, equals, get, getOrDefault, hashCode, put, putAll, remove, replaceAll

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

putFirst, putLast, reversed

Constructor Details

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap()

Creates a new empty tree map.

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(Comparator<? super Byte> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(Map<? extends Byte, ? extends Byte> m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2ByteRBTreeMap

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

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(Byte2ByteMap m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(Byte2ByteSortedMap 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.

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(byte[] k,
 byte[] 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.

Byte2ByteRBTreeMap

public Byte2ByteRBTreeMap(byte[] 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 Details

addTo

public byte addTo(byte k,
 byte incr)

Adds an increment to value currently associated with a key.

Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

Parameters:

k - the key.

incr - the increment.

Returns:

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

put

public byte put(byte k,
 byte v)

Description copied from interface: Byte2ByteFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Byte2ByteFunction

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

Description copied from interface: Byte2ByteFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Byte2ByteFunction

Parameters:

k - the key.

Returns:

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

See Also:

• Function.remove(Object)

containsValue

public boolean containsValue(byte v)

Description copied from class: AbstractByte2ByteMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Byte2ByteMap

Overrides:

containsValue in class AbstractByte2ByteMap

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 Byte2ByteMap

Specified by:

clear in interface Function<Byte,Byte>

Specified by:

clear in interface Map<Byte,Byte>

See Also:

• Map.clear()

containsKey

public boolean containsKey(byte k)

Description copied from class: AbstractByte2ByteMap

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.

Specified by:

containsKey in interface Byte2ByteFunction

Specified by:

containsKey in interface Byte2ByteMap

Overrides:

containsKey in class AbstractByte2ByteMap

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

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. This default implementation, in particular, returns -1.

Specified by:

size in interface Byte2ByteMap

Specified by:

size in interface Function<Byte,Byte>

Specified by:

size in interface Map<Byte,Byte>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

See Also:

• Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Byte,Byte>

Overrides:

isEmpty in class AbstractByte2ByteMap

get

public byte get(byte k)

Description copied from interface: Byte2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2ByteFunction

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()

Description copied from interface: Byte2ByteSortedMap

Returns the first (lowest) key currently in this map.

Specified by:

firstByteKey in interface Byte2ByteSortedMap

See Also:

• SortedMap.firstKey()

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2ByteSortedMap

Returns the last (highest) key currently in this map.

Specified by:

lastByteKey in interface Byte2ByteSortedMap

See Also:

• SortedMap.lastKey()

byte2ByteEntrySet

public ObjectSortedSet<Byte2ByteMap.Entry> byte2ByteEntrySet()

Description copied from interface: Byte2ByteMap

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

Specified by:

byte2ByteEntrySet in interface Byte2ByteMap

Specified by:

byte2ByteEntrySet in interface Byte2ByteSortedMap

Returns:

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

See Also:

• Map.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 Byte2ByteMap

Specified by:

keySet in interface Byte2ByteSortedMap

Specified by:

keySet in interface Map<Byte,Byte>

Specified by:

keySet in interface SortedMap<Byte,Byte>

Overrides:

keySet in class AbstractByte2ByteSortedMap

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 Byte2ByteMap

Specified by:

values in interface Byte2ByteSortedMap

Specified by:

values in interface Map<Byte,Byte>

Specified by:

values in interface SortedMap<Byte,Byte>

Overrides:

values in class AbstractByte2ByteSortedMap

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

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Specified by:

comparator in interface Byte2ByteSortedMap

Specified by:

comparator in interface SortedMap<Byte,Byte>

See Also:

• SortedMap.comparator()

headMap

public Byte2ByteSortedMap headMap(byte to)

Description copied from interface: Byte2ByteSortedMap

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

Specified by:

headMap in interface Byte2ByteSortedMap

See Also:

• SortedMap.headMap(Object)

tailMap

public Byte2ByteSortedMap tailMap(byte from)

Description copied from interface: Byte2ByteSortedMap

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

Specified by:

tailMap in interface Byte2ByteSortedMap

See Also:

• SortedMap.tailMap(Object)

subMap

public Byte2ByteSortedMap subMap(byte from,
 byte to)

Description copied from interface: Byte2ByteSortedMap

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

Specified by:

subMap in interface Byte2ByteSortedMap

See Also:

• SortedMap.subMap(Object,Object)

clone

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