it.unimi.dsi.fastutil.shorts
Class Short2CharLinkedOpenHashMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction
      extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap
          extended by it.unimi.dsi.fastutil.shorts.AbstractShort2CharSortedMap
              extended by it.unimi.dsi.fastutil.shorts.Short2CharLinkedOpenHashMap
All Implemented Interfaces:
Function<java.lang.Short,java.lang.Character>, Hash, Short2CharFunction, Short2CharMap, Short2CharSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Short,java.lang.Character>, java.util.SortedMap<java.lang.Short,java.lang.Character>

public class Short2CharLinkedOpenHashMap
extends AbstractShort2CharSortedMap
implements java.io.Serializable, java.lang.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 AbstractShort2CharSortedMap.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.AbstractShort2CharMap
AbstractShort2CharMap.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.Short2CharSortedMap
Short2CharSortedMap.FastSortedEntrySet
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharMap
Short2CharMap.Entry, Short2CharMap.FastEntrySet
 
Field Summary
 
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
Short2CharLinkedOpenHashMap()
          Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.
Short2CharLinkedOpenHashMap(int expected)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
Short2CharLinkedOpenHashMap(int expected, float f)
          Creates a new hash map.
Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> m, float f)
          Creates a new hash map copying a given one.
Short2CharLinkedOpenHashMap(short[] k, char[] v)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.
Short2CharLinkedOpenHashMap(short[] k, char[] v, float f)
          Creates a new hash map using the elements of two parallel arrays.
Short2CharLinkedOpenHashMap(Short2CharMap m)
          Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
Short2CharLinkedOpenHashMap(Short2CharMap m, float f)
          Creates a new hash map copying a given type-specific one.
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 Short2CharLinkedOpenHashMap 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 AbstractShort2CharMap.keySet().
 boolean containsValue(char v)
          Checks whether the given value is contained in AbstractShort2CharMap.values().
 short firstShortKey()
          Returns the first key of this map in iteration order.
 char get(short k)
          Returns the value to which the given key is mapped.
 java.lang.Character get(java.lang.Short ok)
           
 char 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.
 char 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.
 Short2CharSortedMap 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.
 char put(short k, char v)
          Adds a pair to the map.
 java.lang.Character put(java.lang.Short ok, java.lang.Character ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 char putAndMoveToFirst(short k, char v)
          Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
 char putAndMoveToLast(short k, char 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.
 java.lang.Character remove(java.lang.Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 char remove(short k)
          Removes the mapping with the given key.
 char removeFirstChar()
          Removes the mapping associated with the first key in iteration order.
 char removeLastChar()
          Removes the mapping associated with the last key in iteration order.
 Short2CharSortedMap.FastSortedEntrySet short2CharEntrySet()
          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.
 Short2CharSortedMap subMap(short from, short to)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Short2CharSortedMap 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.
 CharCollection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharMap
containsValue, equals, putAll, toString
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction
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.Short2CharFunction
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
 

Constructor Detail

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(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.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(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.

Short2CharLinkedOpenHashMap

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


Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> 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.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> 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.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(Short2CharMap 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.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(Short2CharMap 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.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(short[] k,
                                   char[] 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:
java.lang.IllegalArgumentException - if k and v have different lengths.

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(short[] k,
                                   char[] 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:
java.lang.IllegalArgumentException - if k and v have different lengths.
Method Detail

put

public char put(short k,
                char v)
Description copied from interface: Short2CharFunction
Adds a pair to the map.

Specified by:
put in interface Short2CharFunction
Overrides:
put in class AbstractShort2CharFunction
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 java.lang.Character put(java.lang.Short ok,
                               java.lang.Character ov)
Description copied from class: AbstractShort2CharFunction
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<java.lang.Short,java.lang.Character>
Specified by:
put in interface java.util.Map<java.lang.Short,java.lang.Character>
Overrides:
put in class AbstractShort2CharFunction
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 char remove(short k)
Description copied from interface: Short2CharFunction
Removes the mapping with the given key.

Specified by:
remove in interface Short2CharFunction
Overrides:
remove in class AbstractShort2CharFunction
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 java.lang.Character remove(java.lang.Object ok)
Description copied from class: AbstractShort2CharFunction
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<java.lang.Short,java.lang.Character>
Specified by:
remove in interface java.util.Map<java.lang.Short,java.lang.Character>
Overrides:
remove in class AbstractShort2CharFunction
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

removeFirstChar

public char removeFirstChar()
Removes the mapping associated with the first key in iteration order.

Returns:
the value previously associated with the first key in iteration order.
Throws:
java.util.NoSuchElementException - is this map is empty.

removeLastChar

public char removeLastChar()
Removes the mapping associated with the last key in iteration order.

Returns:
the value previously associated with the last key in iteration order.
Throws:
java.util.NoSuchElementException - is this map is empty.

getAndMoveToFirst

public char 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 char 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 char putAndMoveToFirst(short k,
                              char 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 char putAndMoveToLast(short k,
                             char 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 java.lang.Character get(java.lang.Short ok)

get

public char get(short k)
Description copied from interface: Short2CharFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Short2CharFunction
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: AbstractShort2CharMap
Checks whether the given value is contained in AbstractShort2CharMap.keySet().

Specified by:
containsKey in interface Short2CharFunction
Overrides:
containsKey in class AbstractShort2CharMap
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(char v)
Description copied from class: AbstractShort2CharMap
Checks whether the given value is contained in AbstractShort2CharMap.values().

Specified by:
containsValue in interface Short2CharMap
Overrides:
containsValue in class AbstractShort2CharMap
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<java.lang.Short,java.lang.Character>
Specified by:
clear in interface java.util.Map<java.lang.Short,java.lang.Character>
Overrides:
clear in class AbstractShort2CharFunction
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<java.lang.Short,java.lang.Character>
Specified by:
size in interface java.util.Map<java.lang.Short,java.lang.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 java.util.Map<java.lang.Short,java.lang.Character>
Overrides:
isEmpty in class AbstractShort2CharMap

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 Short2CharSortedMap
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 Short2CharSortedMap
Returns:
the last key in iteration order.
See Also:
SortedMap.lastKey()

comparator

public ShortComparator comparator()
Description copied from interface: Short2CharSortedMap
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 Short2CharSortedMap
Specified by:
comparator in interface java.util.SortedMap<java.lang.Short,java.lang.Character>
See Also:
SortedMap.comparator()

tailMap

public Short2CharSortedMap tailMap(short from)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:
tailMap in interface Short2CharSortedMap
See Also:
SortedMap.tailMap(Object)

headMap

public Short2CharSortedMap headMap(short to)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:
headMap in interface Short2CharSortedMap
See Also:
SortedMap.headMap(Object)

subMap

public Short2CharSortedMap subMap(short from,
                                  short to)
Description copied from interface: Short2CharSortedMap
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:
subMap in interface Short2CharSortedMap
See Also:
SortedMap.subMap(Object,Object)

short2CharEntrySet

public Short2CharSortedMap.FastSortedEntrySet short2CharEntrySet()
Description copied from interface: Short2CharSortedMap
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:
short2CharEntrySet in interface Short2CharMap
Specified by:
short2CharEntrySet in interface Short2CharSortedMap
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
Short2CharSortedMap.entrySet()

keySet

public ShortSortedSet keySet()
Description copied from class: AbstractShort2CharSortedMap
Returns a type-specific-sorted-set view of the keys of this map.

The view is backed by the sorted set returned by AbstractShort2CharSortedMap.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 Short2CharMap
Specified by:
keySet in interface Short2CharSortedMap
Specified by:
keySet in interface java.util.Map<java.lang.Short,java.lang.Character>
Specified by:
keySet in interface java.util.SortedMap<java.lang.Short,java.lang.Character>
Overrides:
keySet in class AbstractShort2CharSortedMap
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 CharCollection values()
Description copied from class: AbstractShort2CharSortedMap
Returns a type-specific collection view of the values contained in this map.

The view is backed by the sorted set returned by AbstractShort2CharSortedMap.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 Short2CharMap
Specified by:
values in interface Short2CharSortedMap
Specified by:
values in interface java.util.Map<java.lang.Short,java.lang.Character>
Specified by:
values in interface java.util.SortedMap<java.lang.Short,java.lang.Character>
Overrides:
values in class AbstractShort2CharSortedMap
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 Short2CharLinkedOpenHashMap 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 java.lang.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 java.util.Map<java.lang.Short,java.lang.Character>
Overrides:
hashCode in class AbstractShort2CharMap
Returns:
a hash code for this map.