TLongObjectHashMap (jcore-mallet-0.4 1.0.0 API)

java.lang.Object
- gnu.trove.THash
- - gnu.trove.TPrimitiveHash
  - - gnu.trove.TLongHash
    - - gnu.trove.TLongObjectHashMap

All Implemented Interfaces:

TLongHashingStrategy, Serializable, Cloneable
```
public class TLongObjectHashMap
extends TLongHash
implements Serializable
```
An open addressed Map implementation for long keys and Object values. Created: Sun Nov 4 08:52:45 2001

Version:

$Id: TLongObjectHashMap.java,v 1.3 2004/11/24 20:00:00 casutton Exp $

Author:

Eric D. Friedman

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Object[] _values
the values of the map
- Fields inherited from class gnu.trove.TLongHash
  _set
- Fields inherited from class gnu.trove.TPrimitiveHash
  _states, FREE, FULL, REMOVED
- Fields inherited from class gnu.trove.THash
  _free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

Fields
Modifier and Type	Field and Description
`protected Object[]`	`_values` the values of the map

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Empties the map.
`Object`	`clone()`
`boolean`	`containsKey(long key)` checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(Object val)` checks for the presence of `val` in the values of the map.
`boolean`	`equals(Object other)` Compares this map with another map for equality of their stored entries.
`boolean`	`forEachEntry(TLongObjectProcedure procedure)` Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TLongProcedure procedure)` Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TObjectProcedure procedure)` Executes `procedure` for each value in the map.
`Object`	`get(long key)` retrieves the value for `key`
`Object[]`	`getValues()` Returns the values of the map.
`TLongObjectIterator`	`iterator()`
`long[]`	`keys()` returns the keys of the map.
`Object`	`put(long key, Object value)` Inserts a key/value pair into the map.
`protected void`	`rehash(int newCapacity)` rehashes the map to the new capacity.
`Object`	`remove(long key)` Deletes a key/value pair from the map.
`protected void`	`removeAt(int index)` removes the mapping at `index` from the map.
`boolean`	`retainEntries(TLongObjectProcedure 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`.
`void`	`transformValues(TObjectFunction function)` Transform the values in this map using `function`.

Methods inherited from class gnu.trove.TLongHash
computeHashCode, contains, forEach, index, insertionIndex

Methods inherited from class gnu.trove.TPrimitiveHash
capacity

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

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

- Field Detail
  - _values
```
protected transient Object[] _values
```
    the values of the map
- Constructor Detail
  - TLongObjectHashMap
```
public TLongObjectHashMap()
```
    Creates a new TLongObjectHashMap instance with the default capacity and load factor.
  - TLongObjectHashMap
```
public TLongObjectHashMap(int initialCapacity)
```
    Creates a new TLongObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TLongObjectHashMap
```
public TLongObjectHashMap(int initialCapacity,
                          float loadFactor)
```
    Creates a new TLongObjectHashMap 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
  - TLongObjectHashMap
```
public TLongObjectHashMap(TLongHashingStrategy strategy)
```
    Creates a new TLongObjectHashMap instance with the default capacity and load factor.
    
    Parameters:
    
    strategy - used to compute hash codes and to compare keys.
  - TLongObjectHashMap
```
public TLongObjectHashMap(int initialCapacity,
                          TLongHashingStrategy strategy)
```
    Creates a new TLongObjectHashMap 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.
  - TLongObjectHashMap
```
public TLongObjectHashMap(int initialCapacity,
                          float loadFactor,
                          TLongHashingStrategy strategy)
```
    Creates a new TLongObjectHashMap 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 Object clone()
```
    Overrides:
    
    clone in class TLongHash
    
    Returns:
    
    a deep clone of this collection
  - iterator
```
public TLongObjectIterator iterator()
```
    Returns:
    
    a TLongObjectIterator 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 TLongHash
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - put
```
public Object put(long key,
                  Object value)
```
    Inserts a key/value pair into the map.
    
    Parameters:
    
    key - an long 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 Object get(long key)
```
    retrieves the value for key
    
    Parameters:
    
    key - an long 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 Object remove(long key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an long value
    
    Returns:
    
    an Object value
  - equals
```
public boolean equals(Object other)
```
    Compares this map with another map for equality of their stored entries.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    a boolean value
  - removeAt
```
protected void removeAt(int index)
```
    removes the mapping at index from the map.
    
    Overrides:
    
    removeAt in class TLongHash
    
    Parameters:
    
    index - an int value
  - getValues
```
public Object[] getValues()
```
    Returns the values of the map.
    
    Returns:
    
    a Collection value
  - keys
```
public long[] keys()
```
    returns the keys of the map.
    
    Returns:
    
    a Set value
  - containsValue
```
public boolean containsValue(Object 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(long key)
```
    checks for the present of key in the keys of the map.
    
    Parameters:
    
    key - an long value
    
    Returns:
    
    a boolean value
  - forEachKey
```
public boolean forEachKey(TLongProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Parameters:
    
    procedure - a TLongProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
public boolean forEachValue(TObjectProcedure 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(TLongObjectProcedure procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Parameters:
    
    procedure - a TOLongObjectProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - retainEntries
```
public boolean retainEntries(TLongObjectProcedure 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 function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TObjectFunction value

Class TLongObjectHashMap

Field Summary

Fields inherited from class gnu.trove.TLongHash

Fields inherited from class gnu.trove.TPrimitiveHash

Fields inherited from class gnu.trove.THash

Constructor Summary

Method Summary

Methods inherited from class gnu.trove.TLongHash

Methods inherited from class gnu.trove.TPrimitiveHash

Methods inherited from class gnu.trove.THash

Methods inherited from class java.lang.Object

Field Detail

_values

Constructor Detail

TLongObjectHashMap

TLongObjectHashMap

TLongObjectHashMap

TLongObjectHashMap

TLongObjectHashMap

TLongObjectHashMap

Method Detail

clone

iterator

setUp

put

rehash

get

clear

remove

equals

removeAt

getValues

keys

containsValue

containsKey

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues