com.gemstone.gnu.trove.TObjectHash Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-trove Show documentation
Show all versions of gemfire-trove Show documentation
SnappyData store based off Pivotal GemFireXD
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.
///////////////////////////////////////////////////////////////////////////////
/*
* Contains changes for GemFireXD distributed data platform.
*
* Portions Copyright (c) 2010-2015 Pivotal Software, Inc. 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.
*/
package com.gemstone.gnu.trove;
import java.io.Serializable;
import java.lang.Class;
/**
* An open addressed hashing implementation for Object types.
*
* Created: Sun Nov 4 08:56:06 2001
*
* @author Eric D. Friedman
* @version $Id: TObjectHash.java,v 1.16 2004/02/25 14:05:29 ericdf Exp $
*/
abstract public class TObjectHash extends THash implements Serializable, TObjectHashingStrategy {
/**
* optional statistics object to track number of hash collisions
* and time spent probing based on hash collisions
*/
protected transient HashingStats stats;
/** the set of Objects */
protected transient Object[] _set;
/** the strategy used to hash objects in this collection. */
protected TObjectHashingStrategy _hashingStrategy;
public static final Object REMOVED = new Object();
/**
* Creates a new TObjectHash instance with the
* default capacity and load factor.
*/
public TObjectHash() {
super();
this._hashingStrategy = this;
}
/**
* Creates a new TObjectHash instance with the
* default capacity and load factor and a custom hashing strategy.
*
* @param strategy used to compute hash codes and to compare objects.
*/
public TObjectHash(TObjectHashingStrategy strategy) {
super();
this._hashingStrategy = strategy;
}
/**
* Creates a new TObjectHash instance whose capacity
* is the next highest prime above initialCapacity + 1
* unless that value is already prime.
*
* @param initialCapacity an int value
*/
public TObjectHash(int initialCapacity) {
super(initialCapacity);
this._hashingStrategy = this;
}
/**
* Creates a new TObjectHash instance whose capacity
* is the next highest prime above initialCapacity + 1
* unless that value is already prime. Uses the specified custom
* hashing strategy.
*
* @param initialCapacity an int value
* @param strategy used to compute hash codes and to compare objects.
*/
public TObjectHash(int initialCapacity, TObjectHashingStrategy strategy) {
super(initialCapacity);
this._hashingStrategy = strategy;
}
/**
* Creates a new TObjectHash 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 TObjectHash(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
this._hashingStrategy = this;
}
/**
* Creates a new TObjectHash instance with a prime
* value at or near the specified capacity and load factor. Uses
* the specified custom hashing strategy.
*
* @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 objects.
*/
public TObjectHash(int initialCapacity, float loadFactor, TObjectHashingStrategy strategy) {
super(initialCapacity, loadFactor);
this._hashingStrategy = strategy != null ? strategy : this;
}
// GemStoneAddition
/**
* Set the statistics object for tracking hash code collisions.
* Should be called before the first element is added.
*/
public final void setHashingStats(HashingStats stats) {
this.stats = stats;
}
// GemStoneAddition
public final void setHashingStrategy(TObjectHashingStrategy strategy) {
this._hashingStrategy = strategy;
}
// GemStoneAddition
public final boolean isEqualHashingStrategy(Class classId) {
return classId.isInstance(this._hashingStrategy);
}
// GemStoneAddition
public final String getHashingStrategyName() {
return this._hashingStrategy.getClass().getSimpleName();
}
/**
* @return a shallow clone of this collection
*/
@Override // GemStoneAddition
public Object clone() {
TObjectHash h = (TObjectHash)super.clone();
h._set = this._set.clone();
return h;
}
@Override // GemStoneAddition
protected int capacity() {
return _set.length;
}
@Override // GemStoneAddition
protected void removeAt(int index) {
super.removeAt(index);
_set[index] = REMOVED;
}
/**
* initializes the Object set of this hash table.
*
* @param initialCapacity an int value
* @return an int value
*/
@Override // GemStoneAddition
protected int setUp(int initialCapacity) {
int capacity;
capacity = super.setUp(initialCapacity);
_set = new Object[capacity];
return capacity;
}
/**
* 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(TObjectProcedure procedure) {
Object[] set = _set;
for (int i = set.length; i-- > 0;) {
if (set[i] != null
&& set[i] != REMOVED
&& ! procedure.execute(set[i])) {
return false;
}
}
return true;
}
// GemStone changes BEGIN
public final Object firstKey() {
final Object[] set = _set;
Object key;
for (int i = set.length; i-- > 0;) {
if ((key = set[i]) != null && key != REMOVED) {
return key;
}
}
return null;
}
// GemStone changes END
/**
* Searches the set for obj
*
* @param obj an Object value
* @return a boolean value
*/
public boolean contains(Object obj) {
return index(obj) >= 0;
}
/**
* Locates the index of obj.
*
* @param obj an Object value
* @return the index of obj or -1 if it isn't in the set.
*/
protected int index(Object obj) {
final int hash, length;
final Object[] set;
Object cur;
int probe, index;
final TObjectHashingStrategy hashingStrategy;
set = _set;
length = set.length;
hashingStrategy = _hashingStrategy;
hash = hashingStrategy.computeHashCode(obj) & 0x7fffffff;
index = hash % length;
cur = set[index];
if (cur != null
&& (cur == REMOVED || ! hashingStrategy.equals(cur, obj))) {
long start = -1L;
if (this.stats != null) {
start = this.stats.getNanoTime();
}
// see Knuth, p. 529
probe = 1 + (hash % (length - 2));
do {
index -= probe;
if (index < 0) {
index += length;
}
cur = set[index];
} while (cur != null
&& (cur == REMOVED || ! hashingStrategy.equals(cur, obj)));
if (this.stats != null) {
this.stats.endQueryResultsHashCollisionProbe(start);
}
}
return cur == null ? -1 : index;
}
/**
* Locates the index at which obj can be inserted. if
* there is already a value equal()ing obj in the set,
* returns that value's index as -index - 1.
*
* @param obj an Object value
* @return the index of a FREE slot at which obj can be inserted
* or, if obj is already stored in the hash, the negative value of
* that index, minus 1: -index -1.
*/
protected int insertionIndex(Object obj) {
final int hash, length;
final Object[] set;
Object cur;
int probe, index;
final TObjectHashingStrategy hashingStrategy;
set = _set;
length = set.length;
hashingStrategy = _hashingStrategy;
hash = hashingStrategy.computeHashCode(obj) & 0x7fffffff;
index = hash % length;
cur = set[index];
if (cur == null) {
return index; // empty, all done
} else if (cur != REMOVED && hashingStrategy.equals(cur, obj)) {
return -index -1; // already stored
} else { // already FULL or REMOVED, must probe
long start = -1L;
if (this.stats != null) {
start = this.stats.getNanoTime();
this.stats.incQueryResultsHashCollisions();
}
// compute the double hash
probe = 1 + (hash % (length - 2));
// if the slot we landed on is FULL (but not removed), probe
// until we find an empty slot, a REMOVED slot, or an element
// equal to the one we are trying to insert.
// finding an empty slot means that the value is not present
// and that we should use that slot as the insertion point;
// finding a REMOVED slot means that we need to keep searching,
// however we want to remember the offset of that REMOVED slot
// so we can reuse it in case a "new" insertion (i.e. not an update)
// is possible.
// finding a matching value means that we've found that our desired
// key is already in the table
if (cur != REMOVED) {
// starting at the natural offset, probe until we find an
// offset that isn't full.
do {
index -= probe;
if (index < 0) {
index += length;
}
cur = set[index];
} while (cur != null
&& cur != REMOVED
&& ! hashingStrategy.equals(cur, obj));
}
// 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 (cur == REMOVED) {
int firstRemoved = index;
while (cur != null
&& (cur == REMOVED || ! hashingStrategy.equals(cur, obj))) {
index -= probe;
if (index < 0) {
index += length;
}
cur = set[index];
}
if (this.stats != null) {
this.stats.endQueryResultsHashCollisionProbe(start);
}
return (cur != null
&& cur != REMOVED) ? -index -1 : firstRemoved;
}
// if it's full, the key is already stored
if (this.stats != null) {
this.stats.endQueryResultsHashCollisionProbe(start);
}
return (cur != null
&& cur != REMOVED) ? -index -1 : index;
}
}
/**
* This is the default implementation of TObjectHashingStrategy:
* it delegates hashing to the Object's hashCode method.
*
* @param o object for which the hashcode is to be computed
* @return the hashCode
* @see Object#hashCode()
*/
public final int computeHashCode(Object o) {
// GemStone changes BEGIN
return o != null ? o.hashCode() : 0;
/* (original code)
return o.hashCode();
*/
// GemStone changes END
}
/**
* This is the default implementation of TObjectHashingStrategy:
* it delegates equality comparisons to the first parameter's
* equals() method.
*
* @param o1 an Object value
* @param o2 an Object value
* @return true if the objects are equal
* @see Object#equals(Object)
*/
public final boolean equals(Object o1, Object o2) {
// GemStone changes BEGIN
return o1 != null ? o1.equals(o2) : o2 == null;
/* (original code)
return o1.equals(o2);
*/
// GemStone changes END
}
/**
* Convenience methods for subclasses to use in throwing exceptions about
* badly behaved user objects employed as keys. We have to throw an
* IllegalArgumentException with a rather verbose message telling the
* user that they need to fix their object implementation to conform
* to the general contract for java.lang.Object.
*
* @param o1 the first of the equal elements with unequal hash codes.
* @param o2 the second of the equal elements with unequal hash codes.
* @exception IllegalArgumentException the whole point of this method.
*/
protected final void throwObjectContractViolation(Object o1, Object o2)
throws IllegalArgumentException {
throw new IllegalArgumentException("Equal objects must have equal hashcodes. "
+ "During rehashing, Trove discovered that "
+ "the following two objects claim to be "
+ "equal (as in java.lang.Object.equals()) "
+ "but their hashCodes (or those calculated by "
+ "your TObjectHashingStrategy) are not equal."
+ "This violates the general contract of "
+ "java.lang.Object.hashCode(). See bullet point two "
+ "in that method's documentation. "
+ "object #1 =" + objToString(o1)
+ "; object #2 =" + objToString(o2));
}
private static String objToString(Object o) {
if (o instanceof Object[]) {
return java.util.Arrays.toString((Object[])o);
} else {
return String.valueOf(o);
}
}
} // TObjectHash