ShortObjectHashMap (HPPC-RT v0.7.5 API Documentation)

java.lang.Object
- com.carrotsearch.hppcrt.maps.ShortObjectHashMap<VType>

All Implemented Interfaces:

ShortObjectAssociativeContainer<VType>, ShortObjectMap<VType>, java.lang.Cloneable, java.lang.Iterable<ShortObjectCursor<VType>>
```
@Generated(date="2017-07-11T19:16:29+0200",
           value="KTypeVTypeHashMap.java")
public class ShortObjectHashMap<VType>
extends java.lang.Object
implements ShortObjectMap<VType>, java.lang.Cloneable
```
A hash map of short to Object, implemented using open addressing with linear probing for collision resolution.
The internal buffers of this implementation (keys, values), are always allocated to the nearest size that is a power of two. When the capacity exceeds the given load factor, the buffer size is doubled.

This implementation supports null values.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ShortObjectHashMap.EntryIterator` An iterator implementation for `iterator()`.
`class`	`ShortObjectHashMap.KeysCollection` A view of the keys inside this map.
`class`	`ShortObjectHashMap.KeysIterator` An iterator over the set of keys.
`class`	`ShortObjectHashMap.ValuesCollection` A view over the set of values of this map.
`class`	`ShortObjectHashMap.ValuesIterator` An iterator over the set of values.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allocatedDefaultKey` True if key = 0/null is in the map.
`VType`	`allocatedDefaultKeyValue` if allocatedDefaultKey = true, contains the associated V to the key = 0/null
`protected int`	`assigned` Cached number of assigned slots in `keys`.
`protected VType`	`defaultValue`
`protected IteratorPool<ShortObjectCursor<VType>,ShortObjectHashMap.EntryIterator>`	`entryIteratorPool` internal pool of EntryIterator
`short[]`	`keys` Hash-indexed array holding all keys.
`protected double`	`loadFactor` The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
`java.lang.Object[]`	`values` Hash-indexed array holding all values associated to the keys.

Constructor Summary

Constructors
Constructor and Description
`ShortObjectHashMap()` Default constructor: Creates a hash map with the default capacity of `Containers.DEFAULT_EXPECTED_ELEMENTS`, load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`ShortObjectHashMap(int initialCapacity)` Creates a hash map with the given initial capacity, default load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`ShortObjectHashMap(int initialCapacity, double loadFactor)` Creates a hash map with the given initial capacity, load factor.
`ShortObjectHashMap(ShortObjectAssociativeContainer<VType> container)` Create a hash map from all key-value pairs of another container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`capacity()` Return the maximum number of keys this container is guaranteed to hold without reallocating.
`void`	`clear()` Clear all keys and values in the container.
`ShortObjectHashMap<VType>`	`clone()`
`boolean`	`containsKey(short key)` Returns `true` if this container has an association to a value for the given key.
`boolean`	`equals(java.lang.Object obj)`
`<T extends ShortObjectPredicate<? super VType>> T`	`forEach(T predicate)` Applies a `predicate` to container elements, as long as the predicate returns `true`.
`<T extends ShortObjectProcedure<? super VType>> T`	`forEach(T procedure)` Applies a given procedure to all keys-value pairs in this container.
`static <VType> ShortObjectHashMap<VType>`	`from(short[] keys, VType[] values)` Creates a hash map from two index-aligned arrays of key-value pairs.
`static <VType> ShortObjectHashMap<VType>`	`from(ShortObjectAssociativeContainer<VType> container)` Create a hash map from another associative container.
`VType`	`get(short key)`
`VType`	`getDefaultValue()` Returns the "default value" value used in containers methods returning "default value"
`int`	`hashCode()`
`boolean`	`isEmpty()` Note that an empty container may still contain many deleted keys (that occupy buffer space).
`ShortObjectHashMap.EntryIterator`	`iterator()` Returns a cursor over the entries (key-value pairs) in this map.
`ShortObjectHashMap.KeysCollection`	`keys()` Returns a collection view of keys of this container.
`static <VType> ShortObjectHashMap<VType>`	`newInstance()` Create a new hash map without providing the full generic signature (constructor shortcut).
`static <VType> ShortObjectHashMap<VType>`	`newInstance(int initialCapacity, double loadFactor)` Create a new hash map with initial capacity and load factor control.
`VType`	`put(short key, VType value)` Place a given key and value in the container.
`int`	`putAll(java.lang.Iterable<? extends ShortObjectCursor<? extends VType>> iterable)` Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
`int`	`putAll(ShortObjectAssociativeContainer<? extends VType> container)` Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
`boolean`	`putIfAbsent(short key, VType value)` Trove-inspired API method.
`VType`	`remove(short key)` Remove the (key, value) pair associated with the given key, and returns the assocaited value.
`int`	`removeAll(ShortContainer other)` Removes all keys (and associated values) present in a given container.
`int`	`removeAll(ShortObjectPredicate<? super VType> predicate)` Removes all keys (and associated values) for which the predicate on (key, value) pairs returns `true`.
`int`	`removeAll(ShortPredicate predicate)` Removes all keys (and associated values) for which the predicate on keys returns `true`.
`void`	`setDefaultValue(VType defaultValue)` Set the "default value" value to be used in containers methods returning "default value"
`int`	`size()`
`java.lang.String`	`toString()` Convert the contents of this map to a human-friendly string.
`ShortObjectHashMap.ValuesCollection`	`values()` Returns a collection view of all values present in this container.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - defaultValue
```
protected VType defaultValue
```
  - keys
```
public short[] keys
```
    Hash-indexed array holding all keys.
    Direct map iteration: iterate {keys[i], values[i]} for i in [0; keys.length[ where keys[i] != 0/null, then also {0/null, allocatedDefaultKeyValue } is in the map if allocatedDefaultKey = true.
  - values
```
public java.lang.Object[] values
```
    Hash-indexed array holding all values associated to the keys. stored in keys.
  - allocatedDefaultKey
```
public boolean allocatedDefaultKey
```
    True if key = 0/null is in the map.
  - allocatedDefaultKeyValue
```
public VType allocatedDefaultKeyValue
```
    if allocatedDefaultKey = true, contains the associated V to the key = 0/null
  - assigned
```
protected int assigned
```
    Cached number of assigned slots in keys.
  - loadFactor
```
protected final double loadFactor
```
    The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
  - entryIteratorPool
```
protected final IteratorPool<ShortObjectCursor<VType>,ShortObjectHashMap.EntryIterator> entryIteratorPool
```
    internal pool of EntryIterator
- Constructor Detail
  - ShortObjectHashMap
```
public ShortObjectHashMap()
```
    Default constructor: Creates a hash map with the default capacity of Containers.DEFAULT_EXPECTED_ELEMENTS, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
    See class notes about hash distribution importance.
  - ShortObjectHashMap
```
public ShortObjectHashMap(int initialCapacity)
```
    Creates a hash map with the given initial capacity, default load factor of HashContainers.DEFAULT_LOAD_FACTOR.
    See class notes about hash distribution importance.
    
    Parameters:
    
    initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).
  - ShortObjectHashMap
```
public ShortObjectHashMap(int initialCapacity,
                          double loadFactor)
```
    Creates a hash map with the given initial capacity, load factor.
    
    Parameters:
    
    loadFactor - The load factor (greater than zero and smaller than 1).
  - ShortObjectHashMap
```
public ShortObjectHashMap(ShortObjectAssociativeContainer<VType> container)
```
    Create a hash map from all key-value pairs of another container.
- Method Detail
  - put
```
public VType put(short key,
                 VType value)
```
    Place a given key and value in the container.
    
    Specified by:
    
    put in interface ShortObjectMap<VType>
    
    Returns:
    
    Returns the value previously stored under the given key, if an equal key is already in the map and replaces the existing value only with the argument value. If the given key was not already in the map, the given (key, value) pair is inserted in the map and the default value is returned.
  - putAll
```
public int putAll(ShortObjectAssociativeContainer<? extends VType> container)
```
    Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
    
    Specified by:
    
    putAll in interface ShortObjectMap<VType>
    
    Returns:
    
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - putAll
```
public int putAll(java.lang.Iterable<? extends ShortObjectCursor<? extends VType>> iterable)
```
    Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
    
    Specified by:
    
    putAll in interface ShortObjectMap<VType>
    
    Returns:
    
    Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.
  - putIfAbsent
```
public boolean putIfAbsent(short key,
                           VType value)
```
    Trove-inspired API method. An equivalent of the following code:
```
 if (!map.containsKey(key))
      map.put(key, value);
 
```
    Specified by:
    
    putIfAbsent in interface ShortObjectMap<VType>
    
    Parameters:
    
    key - The key of the value to check.
    
    value - The value to put if key does not exist.
    
    Returns:
    
    true if key did not exist and value was placed in the map.
  - remove
```
public VType remove(short key)
```
    Remove the (key, value) pair associated with the given key, and returns the assocaited value. The default value is returned if the key did not exist in the map.
    
    Specified by:
    
    remove in interface ShortObjectMap<VType>
  - removeAll
```
public int removeAll(ShortContainer other)
```
    Removes all keys (and associated values) present in a given container.
    
    Specified by:
    
    removeAll in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
public int removeAll(ShortPredicate predicate)
```
    Removes all keys (and associated values) for which the predicate on keys returns true.
    
    Specified by:
    
    removeAll in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
public int removeAll(ShortObjectPredicate<? super VType> predicate)
```
    Removes all keys (and associated values) for which the predicate on (key, value) pairs returns true.
    
    Specified by:
    
    removeAll in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - get
```
public VType get(short key)
```
    Specified by:
    
    get in interface ShortObjectMap<VType>
    
    Returns:
    
    Returns the value associated with the given key, or the default value if the key is not associated with any value.
  - containsKey
```
public boolean containsKey(short key)
```
    Returns true if this container has an association to a value for the given key.
    
    Specified by:
    
    containsKey in interface ShortObjectAssociativeContainer<VType>
  - clear
```
public void clear()
```
    Clear all keys and values in the container.
    
    Specified by:
    
    clear in interface ShortObjectMap<VType>
  - size
```
public int size()
```
    Specified by:
    
    size in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    Returns the current size (number of assigned keys) in the container.
  - capacity
```
public int capacity()
```
    Return the maximum number of keys this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.
    
    Specified by:
    
    capacity in interface ShortObjectAssociativeContainer<VType>
  - isEmpty
```
public boolean isEmpty()
```
    Note that an empty container may still contain many deleted keys (that occupy buffer space). Adding even a single element to such a container may cause rehashing.
    
    Specified by:
    
    isEmpty in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    Return true if this hash map contains no assigned keys.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - iterator
```
public ShortObjectHashMap.EntryIterator iterator()
```
    Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below.
```
 for (IntShortCursor c : intShortMap)
 {
     System.out.println("index=" + c.index
       + " key=" + c.key
       + " value=" + c.value);
 }
 
```
    The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.
    Specified by:
    
    iterator in interface ShortObjectAssociativeContainer<VType>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<ShortObjectCursor<VType>>
  - forEach
```
public <T extends ShortObjectProcedure<? super VType>> T forEach(T procedure)
```
    Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ShortObjectProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.
    
    Specified by:
    
    forEach in interface ShortObjectAssociativeContainer<VType>
  - forEach
```
public <T extends ShortObjectPredicate<? super VType>> T forEach(T predicate)
```
    Applies a predicate to container elements, as long as the predicate returns true. The iteration is interrupted otherwise. Returns the argument (any subclass of ShortObjectPredicate. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example. The iteration is continued as long as the predicate returns true.
    
    Specified by:
    
    forEach in interface ShortObjectAssociativeContainer<VType>
  - keys
```
public ShortObjectHashMap.KeysCollection keys()
```
    Returns a collection view of keys of this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
    
    Specified by:
    
    keys in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    a new KeysCollection view of the keys of this map.
  - values
```
public ShortObjectHashMap.ValuesCollection values()
```
    Returns a collection view of all values present in this container. The returned collection is a view over the value set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
    
    Specified by:
    
    values in interface ShortObjectAssociativeContainer<VType>
    
    Returns:
    
    a new ValuesCollection view of the values of this map.
  - clone
```
public ShortObjectHashMap<VType> clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this map to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object
  - from
```
public static <VType> ShortObjectHashMap<VType> from(short[] keys,
                                                     VType[] values)
```
    Creates a hash map from two index-aligned arrays of key-value pairs. Default load factor is used.
  - from
```
public static <VType> ShortObjectHashMap<VType> from(ShortObjectAssociativeContainer<VType> container)
```
    Create a hash map from another associative container. (constructor shortcut) Default load factor is used.
  - newInstance
```
public static <VType> ShortObjectHashMap<VType> newInstance()
```
    Create a new hash map without providing the full generic signature (constructor shortcut).
  - newInstance
```
public static <VType> ShortObjectHashMap<VType> newInstance(int initialCapacity,
                                                            double loadFactor)
```
    Create a new hash map with initial capacity and load factor control. (constructor shortcut).
  - getDefaultValue
```
public VType getDefaultValue()
```
    Returns the "default value" value used in containers methods returning "default value"
    
    Specified by:
    
    getDefaultValue in interface ShortObjectMap<VType>
  - setDefaultValue
```
public void setDefaultValue(VType defaultValue)
```
    Set the "default value" value to be used in containers methods returning "default value"
    
    Specified by:
    
    setDefaultValue in interface ShortObjectMap<VType>

Class ShortObjectHashMap<VType>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

defaultValue

keys

values

allocatedDefaultKey

allocatedDefaultKeyValue

assigned

loadFactor

entryIteratorPool

Constructor Detail

ShortObjectHashMap

ShortObjectHashMap

ShortObjectHashMap

ShortObjectHashMap

Method Detail

put

putAll

putAll

putIfAbsent

remove

removeAll

removeAll

removeAll

get

containsKey

clear

size

capacity

isEmpty

hashCode

equals

iterator

forEach

forEach

keys

values

clone

toString

from

from

newInstance

newInstance

getDefaultValue

setDefaultValue