it.unimi.dsi.fastutil.longs

Class Long2LongRBTreeMap

java.lang.Object

it.unimi.dsi.fastutil.longs.AbstractLong2LongFunction

it.unimi.dsi.fastutil.longs.AbstractLong2LongMap

it.unimi.dsi.fastutil.longs.AbstractLong2LongSortedMap

it.unimi.dsi.fastutil.longs.Long2LongRBTreeMap

All Implemented Interfaces:

Long2LongFunction, Long2LongMap, Long2LongSortedMap, Serializable, Cloneable, Function<Long,Long>, LongUnaryOperator, Map<Long,Long>, SortedMap<Long,Long>

public class Long2LongRBTreeMap
extends AbstractLong2LongSortedMap
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.longs.AbstractLong2LongSortedMap

AbstractLong2LongSortedMap.KeySetIterator, AbstractLong2LongSortedMap.ValuesCollection, AbstractLong2LongSortedMap.ValuesIterator

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2LongMap

AbstractLong2LongMap.BasicEntry, AbstractLong2LongMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2LongSortedMap

Long2LongSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.longs.Long2LongMap

Long2LongMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected LongComparator	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<Long2LongMap.Entry>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.longs.Long2LongRBTreeMap.Entry	firstEntry The first key in this map.
protected LongSortedSet	keys Cached set of keys.
protected it.unimi.dsi.fastutil.longs.Long2LongRBTreeMap.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 Long>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.longs.Long2LongRBTreeMap.Entry	tree A reference to the root entry.
protected LongCollection	values Cached collection of values.

Fields inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2LongFunction

defRetValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	addTo(long k, long incr) Adds an increment to value currently associated with a key.
void	clear() Removes all of the mappings from this map (optional operation).
Long2LongRBTreeMap	clone() Returns a deep copy of this tree map.
LongComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(long k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(long v) Returns true if this map maps one or more keys to the specified value.
long	firstLongKey() Returns the first (lowest) key currently in this map.
long	get(long k) Returns the value to which the given key is mapped.
Long2LongSortedMap	headMap(long to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
LongSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
long	lastLongKey() Returns the last (highest) key currently in this map.
ObjectSortedSet<Long2LongMap.Entry>	long2LongEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
long	put(long k, long v) Adds a pair to the map (optional operation).
long	remove(long k) Removes the mapping with the given key (optional operation).
int	size() Returns the number of key/value mappings in this map.
Long2LongSortedMap	subMap(long from, long to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Long2LongSortedMap	tailMap(long from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
LongCollection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2LongMap

equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2LongFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2LongSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface it.unimi.dsi.fastutil.longs.Long2LongMap

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.longs.Long2LongFunction

applyAsLong

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.function.LongUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Field Detail

tree

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

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.longs.Long2LongRBTreeMap.Entry lastEntry

The last key in this map.

entries

protected transient ObjectSortedSet<Long2LongMap.Entry> entries

Cached set of entries.

keys

protected transient LongSortedSet keys

Cached set of keys.

values

protected transient LongCollection 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 Long> storedComparator

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

actualComparator

protected transient LongComparator 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

Long2LongRBTreeMap

public Long2LongRBTreeMap()

Creates a new empty tree map.

Long2LongRBTreeMap

public Long2LongRBTreeMap(Comparator<? super Long> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Long2LongRBTreeMap

public Long2LongRBTreeMap(Map<? extends Long,? extends Long> m)

Creates a new tree map copying a given map.

Parameters:

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

Long2LongRBTreeMap

public Long2LongRBTreeMap(SortedMap<Long,Long> 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.

Long2LongRBTreeMap

public Long2LongRBTreeMap(Long2LongMap m)

Creates a new tree map copying a given map.

Parameters:

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

Long2LongRBTreeMap

public Long2LongRBTreeMap(Long2LongSortedMap 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.

Long2LongRBTreeMap

public Long2LongRBTreeMap(long[] k,
                          long[] v,
                          Comparator<? super Long> 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.

Long2LongRBTreeMap

public Long2LongRBTreeMap(long[] k,
                          long[] 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 long addTo(long k,
                  long 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 long put(long k,
                long v)

Description copied from interface: Long2LongFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Long2LongFunction

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

Description copied from interface: Long2LongFunction

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

Specified by:

remove in interface Long2LongFunction

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

Description copied from interface: Long2LongMap

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

Specified by:

containsValue in interface Long2LongMap

Overrides:

containsValue in class AbstractLong2LongMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Long2LongMap

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

Specified by:

clear in interface Long2LongMap

Specified by:

clear in interface Map<Long,Long>

See Also:

Map.clear()

containsKey

public boolean containsKey(long k)

Description copied from interface: Long2LongMap

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

Specified by:

containsKey in interface Long2LongFunction

Specified by:

containsKey in interface Long2LongMap

Overrides:

containsKey in class AbstractLong2LongMap

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

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 Long2LongMap

Specified by:

size in interface Map<Long,Long>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Long,Long>

Overrides:

isEmpty in class AbstractLong2LongMap

get

public long get(long k)

Description copied from interface: Long2LongFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Long2LongFunction

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)

firstLongKey

public long firstLongKey()

Description copied from interface: Long2LongSortedMap

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

Specified by:

firstLongKey in interface Long2LongSortedMap

See Also:

SortedMap.firstKey()

lastLongKey

public long lastLongKey()

Description copied from interface: Long2LongSortedMap

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

Specified by:

lastLongKey in interface Long2LongSortedMap

See Also:

SortedMap.lastKey()

long2LongEntrySet

public ObjectSortedSet<Long2LongMap.Entry> long2LongEntrySet()

Description copied from interface: Long2LongSortedMap

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:

long2LongEntrySet in interface Long2LongMap

Specified by:

long2LongEntrySet in interface Long2LongSortedMap

Returns:

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

See Also:

Long2LongSortedMap.entrySet()

keySet

public LongSortedSet 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 Long2LongMap

Specified by:

keySet in interface Long2LongSortedMap

Specified by:

keySet in interface Map<Long,Long>

Specified by:

keySet in interface SortedMap<Long,Long>

Overrides:

keySet in class AbstractLong2LongSortedMap

Returns:

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

See Also:

Map.keySet()

values

public LongCollection 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 Long2LongMap

Specified by:

values in interface Long2LongSortedMap

Specified by:

values in interface Map<Long,Long>

Specified by:

values in interface SortedMap<Long,Long>

Overrides:

values in class AbstractLong2LongSortedMap

Returns:

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

See Also:

Map.values()

comparator

public LongComparator comparator()

Description copied from interface: Long2LongSortedMap

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 Long2LongSortedMap

Specified by:

comparator in interface SortedMap<Long,Long>

See Also:

SortedMap.comparator()

headMap

public Long2LongSortedMap headMap(long to)

Description copied from interface: Long2LongSortedMap

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 Long2LongSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Long2LongSortedMap tailMap(long from)

Description copied from interface: Long2LongSortedMap

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 Long2LongSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Long2LongSortedMap subMap(long from,
                                 long to)

Description copied from interface: Long2LongSortedMap

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 Long2LongSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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