TIntObjectHashMap (core 1.0.20200330 API)

java.lang.Object
- gnu.trove.THash
- - gnu.trove.TIntObjectHashMap<V>

All Implemented Interfaces:

TIntHashingStrategy, java.io.Serializable, java.lang.Cloneable
```
public class TIntObjectHashMap<V>
extends THash
implements TIntHashingStrategy
```
An open addressed Map implementation for int keys and Object values. Created: Sun Nov 4 08:52:45 2001

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected TIntHashingStrategy`	`_hashingStrategy` strategy used to hash values in this collection
`protected int[]`	`_set` the set of ints
`protected V[]`	`_values` the values of the map

Fields inherited from class gnu.trove.THash
_deadkeys, _free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR, EMPTY_OBJECT_ARRAY, JUST_CREATED_CAPACITY

Constructor Summary

Constructors
Constructor and Description
`TIntObjectHashMap()` Creates a new `TIntObjectHashMap` instance with the default capacity and load factor.
`TIntObjectHashMap(int initialCapacity)` Creates a new `TIntObjectHashMap` instance with a prime capacity equal to or greater than `initialCapacity` and with the default load factor.
`TIntObjectHashMap(int initialCapacity, float loadFactor)` Creates a new `TIntObjectHashMap` instance with a prime capacity equal to or greater than `initialCapacity` and with the specified load factor.
`TIntObjectHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)` Creates a new `TIntObjectHashMap` instance with a prime value at or near the specified capacity and load factor.
`TIntObjectHashMap(int initialCapacity, TIntHashingStrategy strategy)` Creates a new `TIntObjectHashMap` instance whose capacity is the next highest prime above `initialCapacity + 1` unless that value is already prime.
`TIntObjectHashMap(TIntHashingStrategy strategy)` Creates a new `TIntObjectHashMap` instance with the default capacity and load factor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`capacity()` Returns the capacity of the hash table.
`void`	`clear()` Empties the map.
`TIntObjectHashMap<V>`	`clone()`
`int`	`computeHashCode(int val)` Default implementation of TIntHashingStrategy: delegates hashing to HashFunctions.hash(int).
`boolean`	`contains(int val)` Searches the set for `val`
`boolean`	`containsKey(int key)` checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(V val)` checks for the presence of `val` in the values of the map.
`boolean`	`equals(java.lang.Object other)` Compares this map with another map for equality of their stored entries.
`boolean`	`forEach(TIntProcedure procedure)` Executes `procedure` for each element in the set.
`boolean`	`forEachEntry(TIntObjectProcedure<V> procedure)` Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TIntProcedure procedure)` Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TObjectProcedure<V> procedure)` Executes `procedure` for each value in the map.
`V`	`get(int key)` retrieves the value for `key`
`java.lang.Object[]`	`getValues()` Returns the values of the map.
`int`	`hashCode()`
`protected int`	`index(int val)` Locates the index of `val`.
`protected int`	`insertionIndex(int val)` Locates the index at which `val` can be inserted.
`TIntObjectIterator<V>`	`iterator()`
`int[]`	`keys()` returns the keys of the map.
`V`	`put(int key, V value)` Inserts a key/value pair into the map.
`protected void`	`rehash(int newCapacity)` rehashes the map to the new capacity.
`V`	`remove(int key)` Deletes a key/value pair from the map.
`protected void`	`removeAt(int index)` removes the mapping at `index` from the map.
`boolean`	`retainEntries(TIntObjectProcedure<V> procedure)` Retains only those entries in the map for which the procedure returns a true value.
`protected int`	`setUp(int initialCapacity)` initializes the hashtable to a prime capacity which is at least `initialCapacity + 1`.
`java.lang.String`	`toString()`
`void`	`transformValues(TObjectFunction<V,V> function)` Transform the values in this map using `function`.

Methods inherited from class gnu.trove.THash
calculateGrownCapacity, compact, ensureCapacity, isEmpty, postInsertHook, size, startCompactingOnRemove, stopCompactingOnRemove, trimToSize

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

- Field Detail
  - _values
```
protected transient V[] _values
```
    the values of the map
  - _set
```
protected transient int[] _set
```
    the set of ints
  - _hashingStrategy
```
protected final TIntHashingStrategy _hashingStrategy
```
    strategy used to hash values in this collection
- Constructor Detail
  - TIntObjectHashMap
```
public TIntObjectHashMap()
```
    Creates a new TIntObjectHashMap instance with the default capacity and load factor.
  - TIntObjectHashMap
```
public TIntObjectHashMap(int initialCapacity)
```
    Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TIntObjectHashMap
```
public TIntObjectHashMap(int initialCapacity,
                         float loadFactor)
```
    Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
    
    Parameters:
    
    initialCapacity - an int value
    
    loadFactor - a float value
  - TIntObjectHashMap
```
public TIntObjectHashMap(TIntHashingStrategy strategy)
```
    Creates a new TIntObjectHashMap instance with the default capacity and load factor.
    
    Parameters:
    
    strategy - used to compute hash codes and to compare keys.
  - TIntObjectHashMap
```
public TIntObjectHashMap(int initialCapacity,
                         TIntHashingStrategy strategy)
```
    Creates a new TIntObjectHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
    
    Parameters:
    
    initialCapacity - an int value
    
    strategy - used to compute hash codes and to compare keys.
  - TIntObjectHashMap
```
public TIntObjectHashMap(int initialCapacity,
                         float loadFactor,
                         TIntHashingStrategy strategy)
```
    Creates a new TIntObjectHashMap instance with a prime value at or near the specified capacity and load factor.
    
    Parameters:
    
    initialCapacity - used to find a prime capacity for the table.
    
    loadFactor - used to calculate the threshold over which rehashing takes place.
    
    strategy - used to compute hash codes and to compare keys.
- Method Detail
  - clone
```
public TIntObjectHashMap<V> clone()
```
    Overrides:
    
    clone in class THash
    
    Returns:
    
    a deep clone of this collection
  - iterator
```
public TIntObjectIterator<V> iterator()
```
    Returns:
    
    a TIntObjectIterator with access to this map's keys and values
  - setUp
```
protected int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class THash
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - contains
```
public boolean contains(int val)
```
    Searches the set for val
    
    Parameters:
    
    val - an int value
    
    Returns:
    
    a boolean value
  - capacity
```
protected int capacity()
```
    Returns the capacity of the hash table. This is the true physical capacity, without adjusting for the load factor.
    
    Specified by:
    
    capacity in class THash
    
    Returns:
    
    the physical capacity of the hash table.
  - forEach
```
public boolean forEach(TIntProcedure procedure)
```
    Executes procedure for each element in the set.
    
    Parameters:
    
    procedure - a TIntProcedure value
    
    Returns:
    
    false if the loop over the set terminated because the procedure returned false for some value.
  - put
```
public V put(int key,
             V value)
```
    Inserts a key/value pair into the map.
    
    Parameters:
    
    key - an int value
    
    value - an Object value
    
    Returns:
    
    the previous value associated with key, or null if none was found.
  - rehash
```
protected void rehash(int newCapacity)
```
    rehashes the map to the new capacity.
    
    Specified by:
    
    rehash in class THash
    
    Parameters:
    
    newCapacity - an int value
  - get
```
public V get(int key)
```
    retrieves the value for key
    
    Parameters:
    
    key - an int value
    
    Returns:
    
    the value of key or null if no such mapping exists.
  - clear
```
public void clear()
```
    Empties the map.
    
    Overrides:
    
    clear in class THash
  - remove
```
public V remove(int key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an int value
    
    Returns:
    
    an Object value
  - index
```
protected int index(int val)
```
    Locates the index of val.
    
    Parameters:
    
    val - an int value
    
    Returns:
    
    the index of val or -1 if it isn't in the set.
  - insertionIndex
```
protected int insertionIndex(int val)
```
    Locates the index at which val can be inserted. if there is already a value equal()ing val in the set, returns that value as a negative integer.
    
    Parameters:
    
    val - an int value
    
    Returns:
    
    an int value
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this map with another map for equality of their stored entries.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    a boolean value
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - removeAt
```
protected void removeAt(int index)
```
    removes the mapping at index from the map.
    
    Overrides:
    
    removeAt in class THash
    
    Parameters:
    
    index - an int value
  - getValues
```
public java.lang.Object[] getValues()
```
    Returns the values of the map.
    
    Returns:
    
    a value array
  - keys
```
public int[] keys()
```
    returns the keys of the map.
    
    Returns:
    
    a Set value
  - containsValue
```
public boolean containsValue(V val)
```
    checks for the presence of val in the values of the map.
    
    Parameters:
    
    val - an Object value
    
    Returns:
    
    a boolean value
  - containsKey
```
public boolean containsKey(int key)
```
    checks for the present of key in the keys of the map.
    
    Parameters:
    
    key - an int value
    
    Returns:
    
    a boolean value
  - forEachKey
```
public boolean forEachKey(TIntProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Parameters:
    
    procedure - a TIntProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
public boolean forEachValue(TObjectProcedure<V> procedure)
```
    Executes procedure for each value in the map.
    
    Parameters:
    
    procedure - a TObjectProcedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
public boolean forEachEntry(TIntObjectProcedure<V> procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Parameters:
    
    procedure - a TOIntObjectProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - retainEntries
```
public boolean retainEntries(TIntObjectProcedure<V> procedure)
```
    Retains only those entries in the map for which the procedure returns a true value.
    
    Parameters:
    
    procedure - determines which entries to keep
    
    Returns:
    
    true if the map was modified.
  - transformValues
```
public void transformValues(TObjectFunction<V,V> function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TObjectFunction value
  - computeHashCode
```
public final int computeHashCode(int val)
```
    Default implementation of TIntHashingStrategy: delegates hashing to HashFunctions.hash(int).
    
    Specified by:
    
    computeHashCode in interface TIntHashingStrategy
    
    Parameters:
    
    val - the value to hash
    
    Returns:
    
    the hashcode.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TIntObjectHashMap<V>

Field Summary

Fields inherited from class gnu.trove.THash

Constructor Summary

Method Summary

Methods inherited from class gnu.trove.THash

Methods inherited from class java.lang.Object

Field Detail

_values

_set

_hashingStrategy

Constructor Detail

TIntObjectHashMap

TIntObjectHashMap

TIntObjectHashMap

TIntObjectHashMap

TIntObjectHashMap

TIntObjectHashMap

Method Detail

clone

iterator

setUp

contains

capacity

forEach

put

rehash

get

clear

remove

index

insertionIndex

equals

hashCode

removeAt

getValues

keys

containsValue

containsKey

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues

computeHashCode

toString