it.unimi.dsi.fastutil.bytes

Class Byte2DoubleRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleFunction

it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleMap

it.unimi.dsi.fastutil.bytes.AbstractByte2DoubleSortedMap

it.unimi.dsi.fastutil.bytes.Byte2DoubleRBTreeMap

All Implemented Interfaces:

Byte2DoubleFunction, Byte2DoubleMap, Byte2DoubleSortedMap, Serializable, Cloneable, Function<Byte,Double>, IntToDoubleFunction, Map<Byte,Double>, SortedMap<Byte,Double>

public class Byte2DoubleRBTreeMap
extends AbstractByte2DoubleSortedMap
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.AbstractByte2DoubleSortedMap

AbstractByte2DoubleSortedMap.KeySetIterator, AbstractByte2DoubleSortedMap.ValuesCollection, AbstractByte2DoubleSortedMap.ValuesIterator

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

AbstractByte2DoubleMap.BasicEntry, AbstractByte2DoubleMap.BasicEntrySet

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

Byte2DoubleSortedMap.FastSortedEntrySet

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

Byte2DoubleMap.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<Byte2DoubleMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.bytes.Byte2DoubleRBTreeMap.Entry	firstEntry The first key in this map.
protected ByteSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.bytes.Byte2DoubleRBTreeMap.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.
protected Comparator<? super Byte>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.bytes.Byte2DoubleRBTreeMap.Entry	tree A reference to the root entry.
protected DoubleCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
double	addTo(byte k, double incr) Adds an increment to value currently associated with a key.
ObjectSortedSet<Byte2DoubleMap.Entry>	byte2DoubleEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
void	clear() Removes all of the mappings from this map (optional operation).
Byte2DoubleRBTreeMap	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(double 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.
double	get(byte k) Returns the value to which the given key is mapped.
Byte2DoubleSortedMap	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.
double	put(byte k, double v) Adds a pair to the map (optional operation).
double	remove(byte k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Byte2DoubleSortedMap	subMap(byte from, byte to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Byte2DoubleSortedMap	tailMap(byte from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
DoubleCollection	values() Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

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

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

applyAsDouble

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.bytes.Byte2DoubleRBTreeMap.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.Byte2DoubleRBTreeMap.Entry firstEntry

The first key in this map.

lastEntry

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

The last key in this map.

entries

protected transient ObjectSortedSet<Byte2DoubleMap.Entry> entries

Cached set of entries.

keys

protected transient ByteSortedSet keys

Cached set of keys.

values

protected transient DoubleCollection 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.

Constructor Detail

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap()

Creates a new empty tree map.

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap(Comparator<? super Byte> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap(Map<? extends Byte,? extends Double> m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2DoubleRBTreeMap

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

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap(Byte2DoubleMap m)

Creates a new tree map copying a given map.

Parameters:

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

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap(Byte2DoubleSortedMap 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.

Byte2DoubleRBTreeMap

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

Byte2DoubleRBTreeMap

public Byte2DoubleRBTreeMap(byte[] k,
                            double[] 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

addTo

public double addTo(byte k,
                    double 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 double put(byte k,
                  double v)

Description copied from interface: Byte2DoubleFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Byte2DoubleFunction

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

Description copied from interface: Byte2DoubleFunction

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

Specified by:

remove in interface Byte2DoubleFunction

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

Description copied from interface: Byte2DoubleMap

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

Specified by:

containsValue in interface Byte2DoubleMap

Overrides:

containsValue in class AbstractByte2DoubleMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Byte2DoubleMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Byte2DoubleMap

Specified by:

clear in interface Map<Byte,Double>

See Also:

Map.clear()

containsKey

public boolean containsKey(byte k)

Description copied from interface: Byte2DoubleMap

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

Specified by:

containsKey in interface Byte2DoubleFunction

Specified by:

containsKey in interface Byte2DoubleMap

Overrides:

containsKey in class AbstractByte2DoubleMap

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

size

public int size()

Description copied from interface: Byte2DoubleMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Byte2DoubleMap

Specified by:

size in interface Map<Byte,Double>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Byte,Double>

Overrides:

isEmpty in class AbstractByte2DoubleMap

get

public double get(byte k)

Description copied from interface: Byte2DoubleFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2DoubleFunction

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

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

Specified by:

firstByteKey in interface Byte2DoubleSortedMap

See Also:

SortedMap.firstKey()

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2DoubleSortedMap

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

Specified by:

lastByteKey in interface Byte2DoubleSortedMap

See Also:

SortedMap.lastKey()

byte2DoubleEntrySet

public ObjectSortedSet<Byte2DoubleMap.Entry> byte2DoubleEntrySet()

Description copied from interface: Byte2DoubleSortedMap

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:

byte2DoubleEntrySet in interface Byte2DoubleMap

Specified by:

byte2DoubleEntrySet in interface Byte2DoubleSortedMap

Returns:

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

See Also:

Byte2DoubleSortedMap.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 Byte2DoubleMap

Specified by:

keySet in interface Byte2DoubleSortedMap

Specified by:

keySet in interface Map<Byte,Double>

Specified by:

keySet in interface SortedMap<Byte,Double>

Overrides:

keySet in class AbstractByte2DoubleSortedMap

Returns:

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

See Also:

Map.keySet()

values

public DoubleCollection 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 Byte2DoubleMap

Specified by:

values in interface Byte2DoubleSortedMap

Specified by:

values in interface Map<Byte,Double>

Specified by:

values in interface SortedMap<Byte,Double>

Overrides:

values in class AbstractByte2DoubleSortedMap

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

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 Byte2DoubleSortedMap

Specified by:

comparator in interface SortedMap<Byte,Double>

See Also:

SortedMap.comparator()

headMap

public Byte2DoubleSortedMap headMap(byte to)

Description copied from interface: Byte2DoubleSortedMap

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

Note that this specification strengthens the one given in SortedMap.headMap(Object).

Specified by:

headMap in interface Byte2DoubleSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Byte2DoubleSortedMap tailMap(byte from)

Description copied from interface: Byte2DoubleSortedMap

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

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

Specified by:

tailMap in interface Byte2DoubleSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Byte2DoubleSortedMap subMap(byte from,
                                   byte to)

Description copied from interface: Byte2DoubleSortedMap

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

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:

subMap in interface Byte2DoubleSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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