it.unimi.dsi.fastutil.bytes

Class Byte2CharRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.bytes.AbstractByte2CharFunction

it.unimi.dsi.fastutil.bytes.AbstractByte2CharMap

it.unimi.dsi.fastutil.bytes.AbstractByte2CharSortedMap

it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap

All Implemented Interfaces:

Byte2CharFunction, Byte2CharMap, Byte2CharSortedMap, Function<Byte,Character>, Serializable, Cloneable, Map<Byte,Character>, SortedMap<Byte,Character>

public class Byte2CharRBTreeMap
extends AbstractByte2CharSortedMap
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.AbstractByte2CharSortedMap

AbstractByte2CharSortedMap.KeySetIterator, AbstractByte2CharSortedMap.ValuesCollection, AbstractByte2CharSortedMap.ValuesIterator

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2CharMap

AbstractByte2CharMap.BasicEntry

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

Byte2CharSortedMap.FastSortedEntrySet

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

Byte2CharMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteComparator	actualComparator This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
protected int	count Number of entries in this map.
protected ObjectSortedSet<Byte2CharMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry	firstEntry The first key in this map.
protected ByteSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry	lastEntry The last key in this map.
protected boolean	modified The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
static long	serialVersionUID
protected Comparator<? super Byte>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry	tree A reference to the root entry.
protected CharCollection	values Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2CharFunction

defRetValue

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ObjectSortedSet<Byte2CharMap.Entry>	byte2CharEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
Byte2CharRBTreeMap	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 AbstractByte2CharMap.keySet().
boolean	containsValue(char v) Checks whether the given value is contained in AbstractByte2CharMap.values().
byte	firstByteKey()
char	get(byte k) Returns the value to which the given key is mapped.
Byte2CharSortedMap	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()
char	put(byte k, char v) Adds a pair to the map.
Character	put(Byte ok, Character ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
char	remove(byte k) Removes the mapping with the given key.
Character	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.
Byte2CharSortedMap	subMap(byte from, byte to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Byte2CharSortedMap	tailMap(byte from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
CharCollection	values() Returns a type-specific collection view of the values contained in this map.

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

containsValue, equals, hashCode, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

tree

protected transient it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry tree

A reference to the root entry.

count

protected int count

Number of entries in this map.

firstEntry

protected transient it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.bytes.Byte2CharRBTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient volatile ObjectSortedSet<Byte2CharMap.Entry> entries

Cached set of entries.

keys

protected transient volatile ByteSortedSet keys

Cached set of keys.

values

protected transient volatile CharCollection values

Cached collection of values.

modified

protected transient boolean modified

The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.

storedComparator

protected Comparator<? super Byte> storedComparator

This map's comparator, as provided in the constructor.

actualComparator

protected transient ByteComparator actualComparator

This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Byte2CharRBTreeMap

public Byte2CharRBTreeMap()

Creates a new empty tree map.

Byte2CharRBTreeMap

public Byte2CharRBTreeMap(Comparator<? super Byte> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Byte2CharRBTreeMap

public Byte2CharRBTreeMap(Map<? extends Byte,? extends Character> m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2CharRBTreeMap

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

Byte2CharRBTreeMap

public Byte2CharRBTreeMap(Byte2CharMap m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2CharRBTreeMap

public Byte2CharRBTreeMap(Byte2CharSortedMap 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.

Byte2CharRBTreeMap

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

Byte2CharRBTreeMap

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

Description copied from interface: Byte2CharFunction

Adds a pair to the map.

Specified by:

put in interface Byte2CharFunction

Overrides:

put in class AbstractByte2CharFunction

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

Description copied from interface: Byte2CharFunction

Removes the mapping with the given key.

Specified by:

remove in interface Byte2CharFunction

Overrides:

remove in class AbstractByte2CharFunction

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

Description copied from class: AbstractByte2CharFunction

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,Character>

Specified by:

put in interface Map<Byte,Character>

Overrides:

put in class AbstractByte2CharFunction

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

Description copied from class: AbstractByte2CharFunction

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,Character>

Specified by:

remove in interface Map<Byte,Character>

Overrides:

remove in class AbstractByte2CharFunction

Returns:

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

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(char v)

Description copied from class: AbstractByte2CharMap

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

Specified by:

containsValue in interface Byte2CharMap

Overrides:

containsValue in class AbstractByte2CharMap

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,Character>

Specified by:

clear in interface Map<Byte,Character>

Overrides:

clear in class AbstractByte2CharFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(byte k)

Description copied from class: AbstractByte2CharMap

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

Specified by:

containsKey in interface Byte2CharFunction

Overrides:

containsKey in class AbstractByte2CharMap

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,Character>

Specified by:

size in interface Map<Byte,Character>

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,Character>

Overrides:

isEmpty in class AbstractByte2CharMap

get

public char get(byte k)

Description copied from interface: Byte2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2CharFunction

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 Byte2CharSortedMap

See Also:

SortedMap.firstKey()

lastByteKey

public byte lastByteKey()

Specified by:

lastByteKey in interface Byte2CharSortedMap

See Also:

SortedMap.lastKey()

byte2CharEntrySet

public ObjectSortedSet<Byte2CharMap.Entry> byte2CharEntrySet()

Description copied from interface: Byte2CharSortedMap

Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:

byte2CharEntrySet in interface Byte2CharMap

Specified by:

byte2CharEntrySet in interface Byte2CharSortedMap

Returns:

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

See Also:

Byte2CharSortedMap.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 Byte2CharMap

Specified by:

keySet in interface Byte2CharSortedMap

Specified by:

keySet in interface Map<Byte,Character>

Specified by:

keySet in interface SortedMap<Byte,Character>

Overrides:

keySet in class AbstractByte2CharSortedMap

Returns:

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

See Also:

Map.keySet()

values

public CharCollection 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 Byte2CharMap

Specified by:

values in interface Byte2CharSortedMap

Specified by:

values in interface Map<Byte,Character>

Specified by:

values in interface SortedMap<Byte,Character>

Overrides:

values in class AbstractByte2CharSortedMap

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

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 Byte2CharSortedMap

Specified by:

comparator in interface SortedMap<Byte,Character>

See Also:

SortedMap.comparator()

headMap

public Byte2CharSortedMap headMap(byte to)

Description copied from interface: Byte2CharSortedMap

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

Specified by:

headMap in interface Byte2CharSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Byte2CharSortedMap tailMap(byte from)

Description copied from interface: Byte2CharSortedMap

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

Specified by:

tailMap in interface Byte2CharSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Byte2CharSortedMap subMap(byte from,
                        byte to)

Description copied from interface: Byte2CharSortedMap

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

Specified by:

subMap in interface Byte2CharSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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