Package it.unimi.dsi.fastutil.shorts

Class Short2IntAVLTreeMap

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2IntFunction

it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap

it.unimi.dsi.fastutil.shorts.AbstractShort2IntSortedMap

it.unimi.dsi.fastutil.shorts.Short2IntAVLTreeMap

All Implemented Interfaces:

Function<java.lang.Short,java.lang.Integer>, Short2IntFunction, Short2IntMap, Short2IntSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Short,java.lang.Integer>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Short,java.lang.Integer>, java.util.SortedMap<java.lang.Short,java.lang.Integer>

public class Short2IntAVLTreeMap
extends AbstractShort2IntSortedMap
implements java.io.Serializable, java.lang.Cloneable

A type-specific AVL 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.shorts.AbstractShort2IntMap

AbstractShort2IntMap.BasicEntry, AbstractShort2IntMap.BasicEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntMap

Short2IntMap.FastEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntSortedMap

Short2IntSortedMap.FastSortedEntrySet

Constructor Summary

Constructors

Constructor	Description
Short2IntAVLTreeMap()	Creates a new empty tree map.
Short2IntAVLTreeMap(short[] k, int[] v)	Creates a new tree map using the elements of two parallel arrays.
Short2IntAVLTreeMap(short[] k, int[] v, java.util.Comparator<? super java.lang.Short> c)	Creates a new tree map using the elements of two parallel arrays and the given comparator.
Short2IntAVLTreeMap(Short2IntMap m)	Creates a new tree map copying a given map.
Short2IntAVLTreeMap(Short2IntSortedMap m)	Creates a new tree map copying a given sorted map (and its Comparator).
Short2IntAVLTreeMap(java.util.Comparator<? super java.lang.Short> c)	Creates a new empty tree map with the given comparator.
Short2IntAVLTreeMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> m)	Creates a new tree map copying a given map.
Short2IntAVLTreeMap(java.util.SortedMap<java.lang.Short,java.lang.Integer> m)	Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

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

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap

equals, hashCode, putAll, toString

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

equals, forEach, hashCode, putAll, replaceAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntFunction

applyAsInt

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2IntMap

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.shorts.Short2IntSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Constructor Detail

Short2IntAVLTreeMap

public Short2IntAVLTreeMap()

Creates a new empty tree map.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(java.util.Comparator<? super java.lang.Short> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Integer> m)

Creates a new tree map copying a given map.

Parameters:

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

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(java.util.SortedMap<java.lang.Short,java.lang.Integer> 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.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(Short2IntMap m)

Creates a new tree map copying a given map.

Parameters:

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

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(Short2IntSortedMap 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.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(short[] k,
                           int[] v,
                           java.util.Comparator<? super java.lang.Short> 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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Short2IntAVLTreeMap

public Short2IntAVLTreeMap(short[] k,
                           int[] 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:

java.lang.IllegalArgumentException - if k and v have different lengths.

Method Detail

addTo

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

Description copied from interface: Short2IntFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Short2IntFunction

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

Description copied from interface: Short2IntFunction

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

Specified by:

remove in interface Short2IntFunction

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

Description copied from interface: Short2IntMap

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

Specified by:

containsValue in interface Short2IntMap

Overrides:

containsValue in class AbstractShort2IntMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Short2IntMap

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

Specified by:

clear in interface Function<java.lang.Short,java.lang.Integer>

Specified by:

clear in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

clear in interface Short2IntMap

See Also:

Map.clear()

containsKey

public boolean containsKey(short k)

Description copied from interface: Short2IntMap

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

Specified by:

containsKey in interface Short2IntFunction

Specified by:

containsKey in interface Short2IntMap

Overrides:

containsKey in class AbstractShort2IntMap

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

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 Function<java.lang.Short,java.lang.Integer>

Specified by:

size in interface java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

size in interface Short2IntMap

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Short,java.lang.Integer>

Overrides:

isEmpty in class AbstractShort2IntMap

get

public int get(short k)

Description copied from interface: Short2IntFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Short2IntFunction

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)

firstShortKey

public short firstShortKey()

Description copied from interface: Short2IntSortedMap

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

Specified by:

firstShortKey in interface Short2IntSortedMap

See Also:

SortedMap.firstKey()

lastShortKey

public short lastShortKey()

Description copied from interface: Short2IntSortedMap

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

Specified by:

lastShortKey in interface Short2IntSortedMap

See Also:

SortedMap.lastKey()

short2IntEntrySet

public ObjectSortedSet<Short2IntMap.Entry> short2IntEntrySet()

Description copied from interface: Short2IntSortedMap

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:

short2IntEntrySet in interface Short2IntMap

Specified by:

short2IntEntrySet in interface Short2IntSortedMap

Returns:

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

See Also:

Short2IntSortedMap.entrySet()

keySet

public ShortSortedSet 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 java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

keySet in interface Short2IntMap

Specified by:

keySet in interface Short2IntSortedMap

Specified by:

keySet in interface java.util.SortedMap<java.lang.Short,java.lang.Integer>

Overrides:

keySet in class AbstractShort2IntSortedMap

Returns:

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

See Also:

Map.keySet()

values

public IntCollection 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 java.util.Map<java.lang.Short,java.lang.Integer>

Specified by:

values in interface Short2IntMap

Specified by:

values in interface Short2IntSortedMap

Specified by:

values in interface java.util.SortedMap<java.lang.Short,java.lang.Integer>

Overrides:

values in class AbstractShort2IntSortedMap

Returns:

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

See Also:

Map.values()

comparator

public ShortComparator comparator()

Description copied from interface: Short2IntSortedMap

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 Short2IntSortedMap

Specified by:

comparator in interface java.util.SortedMap<java.lang.Short,java.lang.Integer>

See Also:

SortedMap.comparator()

headMap

public Short2IntSortedMap headMap(short to)

Description copied from interface: Short2IntSortedMap

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 Short2IntSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Short2IntSortedMap tailMap(short from)

Description copied from interface: Short2IntSortedMap

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 Short2IntSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Short2IntSortedMap subMap(short from,
                                 short to)

Description copied from interface: Short2IntSortedMap

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 Short2IntSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

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