com.carrotsearch.hppc
Class ShortIntOpenHashMap

java.lang.Object
  extended by com.carrotsearch.hppc.ShortIntOpenHashMap
All Implemented Interfaces:
ShortIntAssociativeContainer, ShortIntMap, java.lang.Cloneable, java.lang.Iterable<ShortIntCursor>

@Generated(date="2011-07-12T16:58:50+0200",
           value="HPPC generated from: ShortIntOpenHashMap.java")
public class ShortIntOpenHashMap
extends java.lang.Object
implements ShortIntMap, java.lang.Cloneable

A hash map of short to int, implemented using open addressing with linear probing for collision resolution.

The internal buffers of this implementation (keys, values, allocated) 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.

See ObjectObjectOpenHashMap class for API similarities and differences against Java Collections.

Important node. The implementation uses power-of-two tables and linear probing, which may cause poor performance (many collisions) if hash values are not properly distributed. This implementation uses rehashing using MurmurHash3.

Author:
This code is inspired by the collaboration and implementation in the fastutil project.

Nested Class Summary
 class ShortIntOpenHashMap.KeysContainer
          A view of the keys inside this hash map.
 
Field Summary
 boolean[] allocated
          Information if an entry (slot) in the values table is allocated or empty.
 int assigned
          Cached number of assigned slots in allocated.
static int DEFAULT_CAPACITY
          Default capacity.
static float DEFAULT_LOAD_FACTOR
          Default load factor.
 short[] keys
          Hash-indexed array holding all keys.
 float loadFactor
          The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
static int MIN_CAPACITY
          Minimum capacity for the map.
 int[] values
          Hash-indexed array holding all values associated to the keys stored in keys.
 
Constructor Summary
ShortIntOpenHashMap()
          Creates a hash map with the default capacity of 16, load factor of 0.75f.
ShortIntOpenHashMap(int initialCapacity)
          Creates a hash map with the given initial capacity, default load factor of 0.75f.
ShortIntOpenHashMap(int initialCapacity, float loadFactor)
          Creates a hash map with the given initial capacity, load factor.
ShortIntOpenHashMap(ShortIntAssociativeContainer container)
          Create a hash map from all key-value pairs of another container.
 
Method Summary
 void clear()
          Clear all keys and values in the container.
 ShortIntOpenHashMap 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)
          Compares the specified object with this set for equality.
<T extends ShortIntProcedure>
T
forEach(T procedure)
          Applies a given procedure to all keys-value pairs in this container.
static ShortIntOpenHashMap from(short[] keys, int[] values)
          Creates a hash map from two index-aligned arrays of key-value pairs.
static ShortIntOpenHashMap from(ShortIntAssociativeContainer container)
          Create a hash map from another associative container.
 int get(short key)
          
 int hashCode()
          
 boolean isEmpty()
          
 java.util.Iterator<ShortIntCursor> iterator()
          Returns a cursor over the entries (key-value pairs) in this map.
 ShortIntOpenHashMap.KeysContainer keys()
          Returns a specialized view of the keys of this associated container.
 int lget()
          Returns the last value saved in a call to containsKey(short).
 int lset(int key)
          Sets the value corresponding to the key saved in the last call to containsKey(short), if and only if the key exists in the map already.
static ShortIntOpenHashMap newInstance()
          Create a new hash map without providing the full generic signature (constructor shortcut).
static ShortIntOpenHashMap newInstance(int initialCapacity, float loadFactor)
          Create a new hash map without providing the full generic signature (constructor shortcut).
protected  int nextCapacity(int current)
          Return the next possible capacity, counting from the current buffers' size.
 int put(short key, int value)
          Place a given key and value in the container.
 int putAll(java.lang.Iterable<? extends ShortIntCursor> iterable)
          Puts all key/value pairs from a given iterable into this map.
 int putAll(ShortIntAssociativeContainer 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, int value)
          Trove-inspired API method.
 int putOrAdd(short key, int putValue, int additionValue)
          Trove-inspired API method.
 int remove(short key)
          Remove all values at the given key.
 int removeAll(ShortContainer container)
          Removes all keys (and associated values) present in a given container.
 int removeAll(ShortPredicate predicate)
          Removes all keys (and associated values) for which the predicate returns true.
protected  int roundCapacity(int requestedCapacity)
          Round the capacity to the next allowed value.
protected  void shiftConflictingKeys(int slotCurr)
          Shift all the slot-conflicting keys allocated to (and including) slot.
 int size()
          
 java.lang.String toString()
          Convert the contents of this map to a human-friendly string.
 IntContainer values()
          Returns a container view of all values present in this container.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY
Default capacity.

See Also:
Constant Field Values

MIN_CAPACITY

public static final int MIN_CAPACITY
Minimum capacity for the map.

See Also:
Constant Field Values

DEFAULT_LOAD_FACTOR

public static final float DEFAULT_LOAD_FACTOR
Default load factor.

See Also:
Constant Field Values

keys

public short[] keys
Hash-indexed array holding all keys.

See Also:
values

values

public int[] values
Hash-indexed array holding all values associated to the keys stored in keys.

See Also:
keys

allocated

public boolean[] allocated
Information if an entry (slot) in the values table is allocated or empty.

See Also:
assigned

assigned

public int assigned
Cached number of assigned slots in allocated.


loadFactor

public final float loadFactor
The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).

Constructor Detail

ShortIntOpenHashMap

public ShortIntOpenHashMap()
Creates a hash map with the default capacity of 16, load factor of 0.75f.

See class notes about hash distribution importance.


ShortIntOpenHashMap

public ShortIntOpenHashMap(int initialCapacity)
Creates a hash map with the given initial capacity, default load factor of 0.75f.

See class notes about hash distribution importance.

Parameters:
initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).

ShortIntOpenHashMap

public ShortIntOpenHashMap(int initialCapacity,
                           float loadFactor)
Creates a hash map with the given initial capacity, 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).
loadFactor - The load factor (greater than zero and smaller than 1).

ShortIntOpenHashMap

public ShortIntOpenHashMap(ShortIntAssociativeContainer container)
Create a hash map from all key-value pairs of another container.

Method Detail

put

public int put(short key,
               int value)
Place a given key and value in the container.

Specified by:
put in interface ShortIntMap
Returns:
The value previously stored under the given key in the map is returned.

putAll

public final int putAll(ShortIntAssociativeContainer 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 ShortIntMap
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 final int putAll(java.lang.Iterable<? extends ShortIntCursor> iterable)
Puts all key/value pairs from a given iterable into this map.

Specified by:
putAll in interface ShortIntMap
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 final boolean putIfAbsent(short key,
                                 int value)
Trove-inspired API method. An equivalent of the following code:
 if (!map.containsKey(key)) map.put(value);
 

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.

putOrAdd

public final int putOrAdd(short key,
                          int putValue,
                          int additionValue)
Trove-inspired API method. An equivalent of the following code:
 if (map.containsKey(key)) 
    map.lset(map.lget() + additionValue);
 else
    map.put(key, putValue);
 

Parameters:
key - The key of the value to adjust.
putValue - The value to put if key does not exist.
additionValue - The value to add to the existing value if key exists.
Returns:
Returns the current value associated with key (after changes).

remove

public int remove(short key)
Remove all values at the given key. The default value for the key type is returned if the value does not exist in the map.

Specified by:
remove in interface ShortIntMap

shiftConflictingKeys

protected final void shiftConflictingKeys(int slotCurr)
Shift all the slot-conflicting keys allocated to (and including) slot.


removeAll

public final int removeAll(ShortContainer container)
Removes all keys (and associated values) present in a given container. An alias to:
 keys().removeAll(container)
 
but with no additional overhead.

Specified by:
removeAll in interface ShortIntAssociativeContainer
Returns:
Returns the number of elements actually removed as a result of this call.

removeAll

public final int removeAll(ShortPredicate predicate)
Removes all keys (and associated values) for which the predicate returns true. An alias to:
 keys().removeAll(container)
 
but with no additional overhead.

Specified by:
removeAll in interface ShortIntAssociativeContainer
Returns:
Returns the number of elements actually removed as a result of this call.

get

public int get(short key)

Use the following snippet of code to check for key existence first and then retrieve the value if it exists.

 if (map.containsKey(key))
   value = map.lget(); 
 

Specified by:
get in interface ShortIntMap
Returns:
Returns the value associated with the given key or the default value for the key type, if the key is not associated with any value. Important note: For primitive type values, the value returned for a non-existing key may not be the default value of the primitive type (it may be any value previously assigned to that slot).

lget

public int lget()
Returns the last value saved in a call to containsKey(short).

See Also:
containsKey(short)

lset

public int lset(int key)
Sets the value corresponding to the key saved in the last call to containsKey(short), if and only if the key exists in the map already.

Returns:
Returns the previous value stored under the given key.
See Also:
containsKey(short)

containsKey

public boolean containsKey(short key)
Returns true if this container has an association to a value for the given key.

Saves the associated value for fast access using lget() or lset(int).

 if (map.containsKey(key))
   value = map.lget();
 
or, for example to modify the value at the given key without looking up its slot twice:
 if (map.containsKey(key))
   map.lset(map.lget() + 1);
 

Specified by:
containsKey in interface ShortIntAssociativeContainer

roundCapacity

protected int roundCapacity(int requestedCapacity)
Round the capacity to the next allowed value.


nextCapacity

protected int nextCapacity(int current)
Return the next possible capacity, counting from the current buffers' size.


clear

public void clear()
Clear all keys and values in the container.

Does not release internal buffers.

Specified by:
clear in interface ShortIntAssociativeContainer

size

public int size()

Specified by:
size in interface ShortIntAssociativeContainer
Returns:
Returns the current size (number of assigned keys) in the container.

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 ShortIntAssociativeContainer
Returns:
Return true if this hash map contains no assigned keys.

hashCode

public int hashCode()

Specified by:
hashCode in interface ShortIntMap
Overrides:
hashCode in class java.lang.Object
Returns:
A hash code of elements stored in the map. The hash code is defined as a sum of hash codes of keys and values stored within the set). Because sum is commutative, this ensures that different order of elements in a set does not affect the hash code.

equals

public boolean equals(java.lang.Object obj)
Compares the specified object with this set for equality. Returns true if and only if the specified object is also a ShortIntMap and both objects contains exactly the same key-value pairs.

Specified by:
equals in interface ShortIntMap
Overrides:
equals in class java.lang.Object

iterator

public java.util.Iterator<ShortIntCursor> 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 ShortIntAssociativeContainer
Specified by:
iterator in interface java.lang.Iterable<ShortIntCursor>

forEach

public <T extends ShortIntProcedure> T forEach(T procedure)
Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ShortIntProcedure. 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 ShortIntAssociativeContainer

keys

public ShortIntOpenHashMap.KeysContainer keys()
Returns a specialized view of the keys of this associated container. The view additionally implements ObjectLookupContainer.

Specified by:
keys in interface ShortIntAssociativeContainer

values

public IntContainer values()
Description copied from interface: ShortIntAssociativeContainer
Returns a container view of all values present in 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:
values in interface ShortIntAssociativeContainer
Returns:
Returns a container with all values stored in this map.

clone

public ShortIntOpenHashMap 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 ShortIntOpenHashMap from(short[] keys,
                                       int[] values)
Creates a hash map from two index-aligned arrays of key-value pairs.


from

public static ShortIntOpenHashMap from(ShortIntAssociativeContainer container)
Create a hash map from another associative container.


newInstance

public static ShortIntOpenHashMap newInstance()
Create a new hash map without providing the full generic signature (constructor shortcut).


newInstance

public static ShortIntOpenHashMap newInstance(int initialCapacity,
                                              float loadFactor)
Create a new hash map without providing the full generic signature (constructor shortcut).



Copyright © 2011 Carrot Search s.c.. All Rights Reserved.