GNU Trove

gnu.trove
Class TIntHash

java.lang.Object
  |
  +--gnu.trove.THash
        |
        +--gnu.trove.TPrimitiveHash
              |
              +--gnu.trove.TIntHash
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, TIntHashingStrategy
Direct Known Subclasses:
TIntDoubleHashMap, TIntFloatHashMap, TIntHashSet, TIntIntHashMap, TIntLongHashMap, TIntObjectHashMap

public abstract class TIntHash
extends TPrimitiveHash
implements java.io.Serializable, TIntHashingStrategy

An open addressed hashing implementation for int primitives. Created: Sun Nov 4 08:56:06 2001

Version:
$Id: TIntHash.java,v 1.14 2004/02/25 14:05:29 ericdf Exp $
Author:
Eric D. Friedman
See Also:
Serialized Form

Field Summary
protected  TIntHashingStrategy _hashingStrategy
          strategy used to hash values in this collection
protected  int[] _set
          the set of ints
 
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
 
Constructor Summary
TIntHash()
          Creates a new TIntHash instance with the default capacity and load factor.
TIntHash(int initialCapacity)
          Creates a new TIntHash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TIntHash(int initialCapacity, float loadFactor)
          Creates a new TIntHash instance with a prime value at or near the specified capacity and load factor.
TIntHash(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
          Creates a new TIntHash instance with a prime value at or near the specified capacity and load factor.
TIntHash(int initialCapacity, TIntHashingStrategy strategy)
          Creates a new TIntHash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TIntHash(TIntHashingStrategy strategy)
          Creates a new TIntHash instance with the default capacity and load factor.
 
Method Summary
 java.lang.Object 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 forEach(TIntProcedure procedure)
          Executes procedure for each element in the set.
protected  int index(int val)
          Locates the index of val.
protected  int insertionIndex(int val)
          Locates the index at which val can be inserted.
protected  void removeAt(int index)
          Releases the element currently stored at index.
protected  int setUp(int initialCapacity)
          initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
 
Methods inherited from class gnu.trove.TPrimitiveHash
capacity
 
Methods inherited from class gnu.trove.THash
clear, compact, ensureCapacity, isEmpty, postInsertHook, rehash, size, trimToSize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_set

protected transient int[] _set
the set of ints


_hashingStrategy

protected TIntHashingStrategy _hashingStrategy
strategy used to hash values in this collection

Constructor Detail

TIntHash

public TIntHash()
Creates a new TIntHash instance with the default capacity and load factor.


TIntHash

public TIntHash(int initialCapacity)
Creates a new TIntHash instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.

Parameters:
initialCapacity - an int value

TIntHash

public TIntHash(int initialCapacity,
                float loadFactor)
Creates a new TIntHash 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.

TIntHash

public TIntHash(TIntHashingStrategy strategy)
Creates a new TIntHash instance with the default capacity and load factor.

Parameters:
strategy - used to compute hash codes and to compare keys.

TIntHash

public TIntHash(int initialCapacity,
                TIntHashingStrategy strategy)
Creates a new TIntHash 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.

TIntHash

public TIntHash(int initialCapacity,
                float loadFactor,
                TIntHashingStrategy strategy)
Creates a new TIntHash 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 java.lang.Object clone()
Overrides:
clone in class TPrimitiveHash
Returns:
a deep clone of this collection

setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Overrides:
setUp in class TPrimitiveHash
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

forEach

public boolean forEach(TIntProcedure procedure)
Executes procedure for each element in the set.

Parameters:
procedure - a TObjectProcedure value
Returns:
false if the loop over the set terminated because the procedure returned false for some value.

removeAt

protected void removeAt(int index)
Releases the element currently stored at index.

Overrides:
removeAt in class TPrimitiveHash
Parameters:
index - an int 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

computeHashCode

public final int computeHashCode(int val)
Default implementation of TIntHashingStrategy: delegates hashing to HashFunctions.hash(int).

Specified by:
computeHashCode in interface TIntHashingStrategy
Returns:
the hashcode.

GNU Trove

GNU Trove is copyright © 2001-2003 Eric D. Friedman. All Rights Reserved.