TObjectDoubleHashMap (jcore-mallet-0.4 1.0.0 API)

java.lang.Object
- gnu.trove.THash
- - gnu.trove.TObjectHash
  - - gnu.trove.TObjectDoubleHashMap

All Implemented Interfaces:

TObjectHashingStrategy, Serializable, Cloneable
```
public class TObjectDoubleHashMap
extends TObjectHash
implements Serializable
```
An open addressed Map implementation for Object keys and double values. Created: Sun Nov 4 08:52:45 2001

Version:

$Id: TObjectDoubleHashMap.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 double[] _values
the values of the map
- Fields inherited from class gnu.trove.TObjectHash
  _set, 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 double[]`	`_values` the values of the map

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`adjustValue(Object key, double amount)` Adjusts the primitive value mapped to key.
`void`	`clear()` Empties the map.
`boolean`	`containsKey(Object key)` checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(double 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(TObjectDoubleProcedure procedure)` Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TObjectProcedure procedure)` Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TDoubleProcedure procedure)` Executes `procedure` for each value in the map.
`double`	`get(Object key)` retrieves the value for `key`
`double[]`	`getValues()` Returns the values of the map.
`boolean`	`increment(Object key)` Increments the primitive value mapped to key by 1
`TObjectDoubleIterator`	`iterator()`
`Object[]`	`keys()` returns the keys of the map.
`double`	`put(Object key, double value)` Inserts a key/value pair into the map.
`protected void`	`rehash(int newCapacity)` rehashes the map to the new capacity.
`double`	`remove(Object key)` Deletes a key/value pair from the map.
`protected void`	`removeAt(int index)` removes the mapping at `index` from the map.
`boolean`	`retainEntries(TObjectDoubleProcedure 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(TDoubleFunction function)` Transform the values in this map using `function`.

Methods inherited from class gnu.trove.TObjectHash
capacity, clone, computeHashCode, contains, equals, forEach, index, insertionIndex

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 double[] _values
```
    the values of the map
- Constructor Detail
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap()
```
    Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap(int initialCapacity)
```
    Creates a new TObjectDoubleHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
    
    Parameters:
    
    initialCapacity - an int value
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap(int initialCapacity,
                            float loadFactor)
```
    Creates a new TObjectDoubleHashMap 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
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap(TObjectHashingStrategy strategy)
```
    Creates a new TObjectDoubleHashMap instance with the default capacity and load factor.
    
    Parameters:
    
    strategy - used to compute hash codes and to compare keys.
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap(int initialCapacity,
                            TObjectHashingStrategy strategy)
```
    Creates a new TObjectDoubleHashMap 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.
  - TObjectDoubleHashMap
```
public TObjectDoubleHashMap(int initialCapacity,
                            float loadFactor,
                            TObjectHashingStrategy strategy)
```
    Creates a new TObjectDoubleHashMap 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
  - iterator
```
public TObjectDoubleIterator iterator()
```
    Returns:
    
    an iterator over the entries in this map
  - setUp
```
protected int setUp(int initialCapacity)
```
    initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
    
    Overrides:
    
    setUp in class TObjectHash
    
    Parameters:
    
    initialCapacity - an int value
    
    Returns:
    
    the actual capacity chosen
  - put
```
public double put(Object key,
                  double value)
```
    Inserts a key/value pair into the map.
    
    Parameters:
    
    key - an Object value
    
    value - an double 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 double get(Object key)
```
    retrieves the value for key
    
    Parameters:
    
    key - an Object 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 double remove(Object key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    an double 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 TObjectHash
    
    Parameters:
    
    index - an int value
  - getValues
```
public double[] getValues()
```
    Returns the values of the map.
    
    Returns:
    
    a Collection value
  - keys
```
public Object[] keys()
```
    returns the keys of the map.
    
    Returns:
    
    a Set value
  - containsValue
```
public boolean containsValue(double val)
```
    checks for the presence of val in the values of the map.
    
    Parameters:
    
    val - an double value
    
    Returns:
    
    a boolean value
  - containsKey
```
public boolean containsKey(Object key)
```
    checks for the present of key in the keys of the map.
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    a boolean value
  - forEachKey
```
public boolean forEachKey(TObjectProcedure procedure)
```
    Executes procedure for each key in the map.
    
    Parameters:
    
    procedure - a TObjectProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
public boolean forEachValue(TDoubleProcedure procedure)
```
    Executes procedure for each value in the map.
    
    Parameters:
    
    procedure - a TDoubleProcedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
public boolean forEachEntry(TObjectDoubleProcedure procedure)
```
    Executes procedure for each key/value entry in the map.
    
    Parameters:
    
    procedure - a TOObjectDoubleProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - retainEntries
```
public boolean retainEntries(TObjectDoubleProcedure 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(TDoubleFunction function)
```
    Transform the values in this map using function.
    
    Parameters:
    
    function - a TDoubleFunction value
  - increment
```
public boolean increment(Object key)
```
    Increments the primitive value mapped to key by 1
    
    Parameters:
    
    key - the key of the value to increment
    
    Returns:
    
    true if a mapping was found and modified.
  - adjustValue
```
public boolean adjustValue(Object key,
                           double amount)
```
    Adjusts the primitive value mapped to key.
    
    Parameters:
    
    key - the key of the value to increment
    
    amount - the amount to adjust the value by.
    
    Returns:
    
    true if a mapping was found and modified.

Class TObjectDoubleHashMap

Field Summary

Fields inherited from class gnu.trove.TObjectHash

Fields inherited from class gnu.trove.THash

Constructor Summary

Method Summary

Methods inherited from class gnu.trove.TObjectHash

Methods inherited from class gnu.trove.THash

Methods inherited from class java.lang.Object

Field Detail

_values

Constructor Detail

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

TObjectDoubleHashMap

Method Detail

iterator

setUp

put

rehash

get

clear

remove

equals

removeAt

getValues

keys

containsValue

containsKey

forEachKey

forEachValue

forEachEntry

retainEntries

transformValues

increment

adjustValue