it.unimi.dsi.fastutil.shorts
Class Short2IntLinkedOpenHashMap

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.Short2IntLinkedOpenHashMap

All Implemented Interfaces:

Function<Short,Integer>, Hash, Short2IntFunction, Short2IntMap, Short2IntSortedMap, Serializable, Cloneable, Map<Short,Integer>, SortedMap<Short,Integer>

public class Short2IntLinkedOpenHashMap
extends AbstractShort2IntSortedMap
implements Serializable, Cloneable, Hash

A type-specific linked hash map with with a fast, small-footprint implementation.

Instances of this class use a hash table to represent a map. The table is enlarged as needed by doubling its size when new entries are created, but it is never made smaller (even on a clear()). A family of trimming methods lets you control the size of the table; this is particularly useful if you reuse instances of this class.

Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the set does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.

This class implements the interface of a sorted map, so to allow easy access of the iteration order: for instance, you can get the first key in iteration order with AbstractShort2IntSortedMap.firstKey() without having to create an iterator; however, this class partially violates the SortedMap contract because all submap methods throw an exception and comparator() returns always null.

Additional methods, such as getAndMoveToFirst(), make it easy to use instances of this class as a cache (e.g., with LRU policy).

The iterators provided by the views of this class using are type-specific list iterators, and can be started at any element which is a key of the map, or a NoSuchElementException exception will be thrown. If, however, the provided element is not the first or last key in the set, the first access to the list index will require linear time, as in the worst case the entire key set must be scanned in iteration order to retrieve the positional index of the starting key. If you use just the methods of a type-specific BidirectionalIterator, however, all operations will be performed in constant time.

See Also:

Hash, HashCommon, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2IntMap

AbstractShort2IntMap.BasicEntry

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

Hash.Strategy<K>

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

Short2IntSortedMap.FastSortedEntrySet

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

Short2IntMap.Entry, Short2IntMap.FastEntrySet

Field Summary

static long

serialVersionUID

Fields inherited from interface it.unimi.dsi.fastutil.Hash

DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR

Constructor Summary

Short2IntLinkedOpenHashMap()
Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.

Short2IntLinkedOpenHashMap(int expected)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.

Short2IntLinkedOpenHashMap(int expected, float f)
Creates a new hash map.

Short2IntLinkedOpenHashMap(Map<? extends Short,? extends Integer> m)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.

Short2IntLinkedOpenHashMap(Map<? extends Short,? extends Integer> m, float f)
Creates a new hash map copying a given one.

Short2IntLinkedOpenHashMap(short[] k, int[] v)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.

Short2IntLinkedOpenHashMap(short[] k, int[] v, float f)
Creates a new hash map using the elements of two parallel arrays.

Short2IntLinkedOpenHashMap(Short2IntMap m)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.

Short2IntLinkedOpenHashMap(Short2IntMap m, float f)
Creates a new hash map copying a given type-specific one.

Method Summary

int	add(short k, int incr) Adds an increment to value currently associated with a key.
void	clear() Removes all associations from this function (optional operation).
Short2IntLinkedOpenHashMap	clone() Returns a deep copy of this map.
ShortComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(short k) Checks whether the given value is contained in AbstractShort2IntMap.keySet().
boolean	containsValue(int v) Checks whether the given value is contained in AbstractShort2IntMap.values().
short	firstShortKey() Returns the first key of this map in iteration order.
int	get(short k) Returns the value to which the given key is mapped.
Integer	get(Short ok)
int	getAndMoveToFirst(short k) Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.
int	getAndMoveToLast(short k) Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.
int	growthFactor() Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full.
void	growthFactor(int growthFactor) Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full.
int	hashCode() Returns a hash code for this map.
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 of this map.
short	lastShortKey() Returns the last key of this map in iteration order.
int	put(short k, int v) Adds a pair to the map.
Integer	put(Short ok, Integer ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	putAndMoveToFirst(short k, int v) Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
int	putAndMoveToLast(short k, int v) Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.
boolean	rehash() Deprecated. A no-op.
Integer	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	remove(short k) Removes the mapping with the given key.
int	removeFirstInt() Removes the mapping associated with the first key in iteration order.
int	removeLastInt() Removes the mapping associated with the last key in iteration order.
Short2IntSortedMap.FastSortedEntrySet	short2IntEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
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.
boolean	trim() Rehashes the map, making the table as small as possible.
boolean	trim(int n) Rehashes this map if the table is too large.
IntCollection	values() Returns a type-specific collection view of the values contained in this map.

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

entrySet, firstKey, headMap, lastKey, subMap, tailMap

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

containsValue, equals, putAll, toString

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

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

defaultReturnValue, defaultReturnValue

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

containsKey, get

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(int expected,
                                  float f)

Creates a new hash map.

The actual table size will be the least power of two greater than expected/f.

Parameters:

expected - the expected number of elements in the hash set.

f - the load factor.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(int expected)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.

Parameters:

expected - the expected number of elements in the hash map.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap()

Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(Map<? extends Short,? extends Integer> m,
                                  float f)

Creates a new hash map copying a given one.

Parameters:

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

f - the load factor.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(Map<? extends Short,? extends Integer> m)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.

Parameters:

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

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(Short2IntMap m,
                                  float f)

Creates a new hash map copying a given type-specific one.

Parameters:

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

f - the load factor.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(Short2IntMap m)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.

Parameters:

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

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(short[] k,
                                  int[] v,
                                  float f)

Creates a new hash map using the elements of two parallel arrays.

Parameters:

k - the array of keys of the new hash map.

v - the array of corresponding values in the new hash map.

f - the load factor.

Throws:

IllegalArgumentException - if k and v have different lengths.

Short2IntLinkedOpenHashMap

public Short2IntLinkedOpenHashMap(short[] k,
                                  int[] v)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.

Parameters:

k - the array of keys of the new hash map.

v - the array of corresponding values in the new hash map.

Throws:

IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public int put(short k,
               int v)

Description copied from interface: Short2IntFunction

Adds a pair to the map.

Specified by:

put in interface Short2IntFunction

Overrides:

put in class AbstractShort2IntFunction

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)

put

public Integer put(Short ok,
                   Integer ov)

Description copied from class: AbstractShort2IntFunction

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<Short,Integer>

Specified by:

put in interface Map<Short,Integer>

Overrides:

put in class AbstractShort2IntFunction

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)

add

public int add(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.

remove

public int remove(short k)

Description copied from interface: Short2IntFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2IntFunction

Overrides:

remove in class AbstractShort2IntFunction

Returns:

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

See Also:

Function.remove(Object)

remove

public Integer remove(Object ok)

Description copied from class: AbstractShort2IntFunction

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<Short,Integer>

Specified by:

remove in interface Map<Short,Integer>

Overrides:

remove in class AbstractShort2IntFunction

Returns:

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

See Also:

Map.remove(Object)

removeFirstInt

public int removeFirstInt()

Removes the mapping associated with the first key in iteration order.

Returns:

the value previously associated with the first key in iteration order.

Throws:

NoSuchElementException - is this map is empty.

removeLastInt

public int removeLastInt()

Removes the mapping associated with the last key in iteration order.

Returns:

the value previously associated with the last key in iteration order.

Throws:

NoSuchElementException - is this map is empty.

getAndMoveToFirst

public int getAndMoveToFirst(short k)

Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.

Parameters:

k - the key.

Returns:

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

getAndMoveToLast

public int getAndMoveToLast(short k)

Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.

Parameters:

k - the key.

Returns:

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

putAndMoveToFirst

public int putAndMoveToFirst(short k,
                             int v)

Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.

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.

putAndMoveToLast

public int putAndMoveToLast(short k,
                            int v)

Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.

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.

get

public Integer get(Short ok)

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)

containsKey

public boolean containsKey(short k)

Description copied from class: AbstractShort2IntMap

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

Specified by:

containsKey in interface Short2IntFunction

Overrides:

containsKey in class AbstractShort2IntMap

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(int v)

Description copied from class: AbstractShort2IntMap

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

Specified by:

containsValue in interface Short2IntMap

Overrides:

containsValue in class AbstractShort2IntMap

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<Short,Integer>

Specified by:

clear in interface Map<Short,Integer>

Overrides:

clear in class AbstractShort2IntFunction

See Also:

Map.clear()

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<Short,Integer>

Specified by:

size in interface Map<Short,Integer>

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<Short,Integer>

Overrides:

isEmpty in class AbstractShort2IntMap

growthFactor

@Deprecated
public void growthFactor(int growthFactor)

Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full.

A no-op for backward compatibility.

Parameters:

growthFactor - unused.

growthFactor

@Deprecated
public int growthFactor()

Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full.

Gets the growth factor (2).

Returns:

the growth factor of this set, which is fixed (2).

See Also:

growthFactor(int)

firstShortKey

public short firstShortKey()

Returns the first key of this map in iteration order.

Specified by:

firstShortKey in interface Short2IntSortedMap

Returns:

the first key in iteration order.

See Also:

SortedMap.firstKey()

lastShortKey

public short lastShortKey()

Returns the last key of this map in iteration order.

Specified by:

lastShortKey in interface Short2IntSortedMap

Returns:

the last key in iteration order.

See Also:

SortedMap.lastKey()

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 SortedMap<Short,Integer>

See Also:

SortedMap.comparator()

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.

Specified by:

tailMap in interface Short2IntSortedMap

See Also:

SortedMap.tailMap(Object)

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.

Specified by:

headMap in interface Short2IntSortedMap

See Also:

SortedMap.headMap(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.

Specified by:

subMap in interface Short2IntSortedMap

See Also:

SortedMap.subMap(Object,Object)

short2IntEntrySet

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

Description copied from class: AbstractShort2IntSortedMap

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

The view is backed by the sorted set returned by AbstractShort2IntSortedMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

keySet in interface Short2IntMap

Specified by:

keySet in interface Short2IntSortedMap

Specified by:

keySet in interface Map<Short,Integer>

Specified by:

keySet in interface SortedMap<Short,Integer>

Overrides:

keySet in class AbstractShort2IntSortedMap

Returns:

a sorted set view of the keys of this map; it may be safely cast to a type-specific interface.

See Also:

Map.keySet()

values

public IntCollection values()

Description copied from class: AbstractShort2IntSortedMap

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

The view is backed by the sorted set returned by AbstractShort2IntSortedMap.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

values in interface Short2IntMap

Specified by:

values in interface Short2IntSortedMap

Specified by:

values in interface Map<Short,Integer>

Specified by:

values in interface SortedMap<Short,Integer>

Overrides:

values in class AbstractShort2IntSortedMap

Returns:

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

See Also:

Map.values()

rehash

@Deprecated
public boolean rehash()

Deprecated. A no-op.

A no-op for backward compatibility. The kind of tables implemented by this class never need rehashing.

If you need to reduce the table size to fit exactly this set, use trim().

Returns:

true.

See Also:

trim()

trim

public boolean trim()

Rehashes the map, making the table as small as possible.

This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.

If the table size is already the minimum possible, this method does nothing.

Returns:

true if there was enough memory to trim the map.

See Also:

trim(int)

trim

public boolean trim(int n)

Rehashes this map if the table is too large.

Let N be the smallest table size that can hold max(n,size()) entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this map in a table of size N.

This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.

Parameters:

n - the threshold for the trimming.

Returns:

true if there was enough memory to trim the map.

See Also:

trim()

clone

public Short2IntLinkedOpenHashMap clone()

Returns a deep copy of this map.

This method performs a deep copy of this hash map; the data stored in the map, 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 map.

hashCode

public int hashCode()

Returns a hash code for this map. This method overrides the generic method provided by the superclass. Since equals() is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.

Specified by:

hashCode in interface Map<Short,Integer>

Overrides:

hashCode in class AbstractShort2IntMap

Returns:

a hash code for this map.