gnu.trove.TLongHash Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trove4j Show documentation
Show all versions of trove4j Show documentation
Fork of trove4j library used in IntelliJ Platform.
The newest version!
///////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2001, Eric D. Friedman All Rights Reserved.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
///////////////////////////////////////////////////////////////////////////////
// THIS FILE IS AUTOGENERATED, PLEASE DO NOT EDIT OR ELSE
package gnu.trove;
/**
* An open addressed hashing implementation for long primitives.
*
* Created: Sun Nov 4 08:56:06 2001
*
* @author Eric D. Friedman
*/
public abstract class TLongHash extends TPrimitiveHash
implements TLongHashingStrategy {
/** the set of longs */
protected transient long[] _set;
/** strategy used to hash values in this collection */
protected final TLongHashingStrategy _hashingStrategy;
/**
* Creates a new TLongHash instance with the default
* capacity and load factor.
*/
public TLongHash() {
_hashingStrategy = this;
}
/**
* Creates a new TLongHash instance whose capacity
* is the next highest prime above initialCapacity + 1
* unless that value is already prime.
*
* @param initialCapacity an int value
*/
public TLongHash(int initialCapacity) {
super(initialCapacity);
_hashingStrategy = this;
}
/**
* Creates a new TLongHash instance with a prime
* value at or near the specified capacity and load factor.
*
* @param initialCapacity used to find a prime capacity for the table.
* @param loadFactor used to calculate the threshold over which
* rehashing takes place.
*/
public TLongHash(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
_hashingStrategy = this;
}
/**
* Creates a new TLongHash instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TLongHash(TLongHashingStrategy strategy) {
_hashingStrategy = strategy;
}
/**
* Creates a new TLongHash instance whose capacity
* is the next highest prime above initialCapacity + 1
* unless that value is already prime.
*
* @param initialCapacity an int value
* @param strategy used to compute hash codes and to compare keys.
*/
public TLongHash(int initialCapacity, TLongHashingStrategy strategy) {
super(initialCapacity);
_hashingStrategy = strategy;
}
/**
* Creates a new TLongHash instance with a prime
* value at or near the specified capacity and load factor.
*
* @param initialCapacity used to find a prime capacity for the table.
* @param loadFactor used to calculate the threshold over which
* rehashing takes place.
* @param strategy used to compute hash codes and to compare keys.
*/
public TLongHash(int initialCapacity, float loadFactor, TLongHashingStrategy strategy) {
super(initialCapacity, loadFactor);
_hashingStrategy = strategy;
}
/**
* @return a deep clone of this collection
*/
@Override
public Object clone() {
TLongHash h = (TLongHash)super.clone();
h._set = _set == null ? null : _set.clone();
return h;
}
/**
* initializes the hash table to a prime capacity which is at least
* initialCapacity + 1.
*
* @param initialCapacity an int value
* @return the actual capacity chosen
*/
@Override
protected int setUp(int initialCapacity) {
int capacity = super.setUp(initialCapacity);
_set = initialCapacity == JUST_CREATED_CAPACITY ? null : new long[capacity];
return capacity;
}
/**
* Searches the set for val
*
* @param val an long value
* @return a boolean value
*/
public boolean contains(long val) {
return index(val) >= 0;
}
/**
* Executes procedure for each element in the set.
*
* @param procedure a TObjectProcedure value
* @return false if the loop over the set terminated because
* the procedure returned false for some value.
*/
public boolean forEach(TLongProcedure procedure) {
byte[] states = _states;
long[] set = _set;
if (states != null) {
for (int i = states.length; i-- > 0;) {
if (states[i] == FULL && ! procedure.execute(set[i])) {
return false;
}
}
}
return true;
}
/**
* Releases the element currently stored at index.
*
* @param index an int value
*/
@Override
protected void removeAt(int index) {
_set[index] = (long)0;
super.removeAt(index);
}
/**
* Locates the index of val.
*
* @param val an long value
* @return the index of val or -1 if it isn't in the set.
*/
protected int index(long val) {
byte[] states = _states;
if (states == null) return -1;
long[] set = _set;
int length = states.length;
int hash = _hashingStrategy.computeHashCode(val) & 0x7fffffff;
int index = hash % length;
if (states[index] != FREE &&
(states[index] == REMOVED || set[index] != val)) {
// see Knuth, p. 529
int probe = 1 + (hash % (length - 2));
do {
index -= probe;
if (index < 0) {
index += length;
}
} while (states[index] != FREE &&
(states[index] == REMOVED || set[index] != val));
}
return states[index] == FREE ? -1 : index;
}
/**
* 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.
*
* @param val an long value
* @return an int value
*/
protected int insertionIndex(long val) {
if (_set == null) {
setUp((int) (DEFAULT_INITIAL_CAPACITY / DEFAULT_LOAD_FACTOR + 1));
}
byte[] states = _states;
long[] set = _set;
int length = states.length;
int hash = _hashingStrategy.computeHashCode(val) & 0x7fffffff;
int index = hash % length;
if (states[index] == FREE) {
return index; // empty, all done
} else if (states[index] == FULL && set[index] == val) {
return -index -1; // already stored
} else { // already FULL or REMOVED, must probe
// compute the double hash
int probe = 1 + (hash % (length - 2));
// starting at the natural offset, probe until we find an
// offset that isn't full.
do {
index -= probe;
if (index < 0) {
index += length;
}
} while (states[index] == FULL && set[index] != val);
// if the index we found was removed: continue probing until we
// locate a free location or an element which equal()s the
// one we have.
if (states[index] == REMOVED) {
int firstRemoved = index;
while (states[index] != FREE &&
(states[index] == REMOVED || set[index] != val)) {
index -= probe;
if (index < 0) {
index += length;
}
}
return states[index] == FULL ? -index -1 : firstRemoved;
}
// if it's full, the key is already stored
return states[index] == FULL ? -index -1 : index;
}
}
/**
* Default implementation of TLongHashingStrategy:
* delegates hashing to HashFunctions.hash(long).
*
* @param val the value to hash
* @return the hash code.
*/
public final int computeHashCode(long val) {
return HashFunctions.hash(val);
}
} // TLongHash