gnu.trove.TIntObjectHashMap 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;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
/**
* An open addressed Map implementation for int keys and Object values.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
*/
public class TIntObjectHashMap extends THash implements TIntHashingStrategy {
/** the values of the map */
protected transient V[] _values;
/** the set of ints */
protected transient int[] _set;
/** strategy used to hash values in this collection */
protected final TIntHashingStrategy _hashingStrategy;
/**
* Creates a new TIntObjectHashMap instance with the default
* capacity and load factor.
*/
public TIntObjectHashMap() {
_hashingStrategy = this;
}
/**
* Creates a new TIntObjectHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public TIntObjectHashMap(int initialCapacity) {
super(initialCapacity);
_hashingStrategy = this;
}
/**
* Creates a new TIntObjectHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the specified load factor.
*
* @param initialCapacity an int value
* @param loadFactor a float value
*/
public TIntObjectHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
_hashingStrategy = this;
}
/**
* Creates a new TIntObjectHashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TIntObjectHashMap(TIntHashingStrategy strategy) {
_hashingStrategy = strategy;
}
/**
* Creates a new TIntObjectHashMap 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 TIntObjectHashMap(int initialCapacity, TIntHashingStrategy strategy) {
super(initialCapacity);
_hashingStrategy = strategy;
}
/**
* Creates a new TIntObjectHashMap 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 TIntObjectHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy) {
super(initialCapacity, loadFactor);
_hashingStrategy = strategy;
}
/**
* @return a deep clone of this collection
*/
@Override
public TIntObjectHashMap clone() {
TIntObjectHashMap m = (TIntObjectHashMap)super.clone();
m._values = _values == EMPTY_OBJECT_ARRAY ? (V[])EMPTY_OBJECT_ARRAY : _values.clone();
m._set = _values == EMPTY_OBJECT_ARRAY ? null : _set.clone();
return m;
}
/**
* @return a TIntObjectIterator with access to this map's keys and values
*/
public TIntObjectIterator iterator() {
return new TIntObjectIterator(this);
}
/**
* initializes the hashtable 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);
_values = (V[]) (initialCapacity == JUST_CREATED_CAPACITY ? EMPTY_OBJECT_ARRAY : new Object[capacity]);
_set = initialCapacity == JUST_CREATED_CAPACITY ? null : new int[capacity];
return capacity;
}
/**
* Searches the set for val
*
* @param val an int value
* @return a boolean value
*/
public boolean contains(int val) {
return index(val) >= 0;
}
/**
* Returns the capacity of the hash table. This is the true
* physical capacity, without adjusting for the load factor.
*
* @return the physical capacity of the hash table.
*/
@Override
protected int capacity() {
return _values.length;
}
/**
* Executes procedure for each element in the set.
*
* @param procedure a TIntProcedure value
* @return false if the loop over the set terminated because
* the procedure returned false for some value.
*/
public boolean forEach(TIntProcedure procedure) {
int[] set = _set;
Object[] values = _values;
for (int i = values.length; i-- > 0;) {
if (isFull(values, i) && ! procedure.execute(set[i])) {
return false;
}
}
return true;
}
/**
* Inserts a key/value pair into the map.
*
* @param key an int value
* @param value an Object value
* @return the previous value associated with key,
* or null if none was found.
*/
public V put(int key, V value) {
boolean wasFree = false;
V previous = null;
int index = insertionIndex(key);
boolean isNewMapping = true;
if (index < 0) {
index = -index -1;
previous = unwrapNull(_values[index]);
isNewMapping = false;
}
else {
wasFree = isFree(_values, index);
}
_set[index] = key;
_values[index] = wrapNull(value);
if (isNewMapping) {
postInsertHook(wasFree);
}
return previous;
}
/**
* rehashes the map to the new capacity.
*
* @param newCapacity an int value
*/
@Override
protected void rehash(int newCapacity) {
int oldCapacity = capacity();
int[] oldKeys = _set;
V[] oldVals = _values;
_set = new int[newCapacity];
_values = (V[]) new Object[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(isFull(oldVals, i)) {
int o = oldKeys[i];
int index = insertionIndex(o);
_set[index] = o;
_values[index] = oldVals[i];
}
}
}
/**
* retrieves the value for key
*
* @param key an int value
* @return the value of key or null if no such mapping exists.
*/
public V get(int key) {
int index = index(key);
return index < 0 ? null : unwrapNull(_values[index]);
}
private static V unwrapNull(V value) {
return value == TObjectHash.NULL ? null : value;
}
private static V wrapNull(V value) {
return value == null ? (V)TObjectHash.NULL : value;
}
/**
* Empties the map.
*
*/
@Override
public void clear() {
super.clear();
int[] keys = _set;
Object[] values = _values;
for (int i = values.length; i-- > 0;) {
keys[i] = (int)0;
values[i] = null;
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an int value
* @return an Object value
*/
public V remove(int key) {
V prev = null;
int index = index(key);
if (index >= 0) {
prev = unwrapNull(_values[index]);
removeAt(index); // clear key,set; adjust size
}
return prev;
}
/**
* Locates the index of val.
*
* @param val an int value
* @return the index of val or -1 if it isn't in the set.
*/
protected int index(int val) {
int[] set = _set;
Object[] values = _values;
if (values == EMPTY_OBJECT_ARRAY) return -1;
int length = set.length;
int hash = _hashingStrategy.computeHashCode(val) & 0x7fffffff;
int index = hash % length;
if (!isFree(values, index) &&
(isRemoved(values, index) || set[index] != val)) {
// see Knuth, p. 529
int probe = 1 + (hash % (length - 2));
do {
index -= probe;
if (index < 0) {
index += length;
}
} while (!isFree(values, index) &&
(isRemoved(values, index) || set[index] != val));
}
return isFree(values, index) ? -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 int value
* @return an int value
*/
protected int insertionIndex(int val) {
if (_values == EMPTY_OBJECT_ARRAY) {
setUp((int) (DEFAULT_INITIAL_CAPACITY / DEFAULT_LOAD_FACTOR + 1));
}
Object[] values = _values;
int[] set = _set;
int length = set.length;
int hash = _hashingStrategy.computeHashCode(val) & 0x7fffffff;
int index = hash % length;
if (isFree(values, index)) {
return index; // empty, all done
}
if (isFull(values, index) && set[index] == val) {
return -index -1; // already stored
}
// 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.
// keep track of the first removed cell. it's the natural candidate for re-insertion
int firstRemoved = isRemoved(values, index) ? index : -1;
do {
index -= probe;
if (index < 0) {
index += length;
}
if (firstRemoved == -1 && isRemoved(values, index)) {
firstRemoved = index;
}
}
while (isFull(values, index) && 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 (isRemoved(values, index)) {
while (!isFree(values, index) &&
(isRemoved(values, index) || set[index] != val)) {
index -= probe;
if (index < 0) {
index += length;
}
}
}
// if it's full, the key is already stored
if (isFull(values, index)) {
return -index -1;
}
return firstRemoved == -1 ? index : firstRemoved;
}
static boolean isFull(Object[] values, int index) {
Object value = values[index];
return value != null && value != TObjectHash.REMOVED;
}
private static boolean isRemoved(Object[] values, int index) {
return values[index] == TObjectHash.REMOVED;
}
private static boolean isFree(Object[] values, int index) {
return values[index] == null;
}
/**
* Compares this map with another map for equality of their stored
* entries.
*
* @param other an Object value
* @return a boolean value
*/
@Override
public boolean equals(Object other) {
if (! (other instanceof TIntObjectHashMap)) {
return false;
}
TIntObjectHashMap that = (TIntObjectHashMap)other;
if (that.size() != size()) {
return false;
}
return forEachEntry(new EqProcedure(that));
}
@Override
public int hashCode() {
HashProcedure p = new HashProcedure();
forEachEntry(p);
return p.getHashCode();
}
private final class HashProcedure implements TIntObjectProcedure {
private int h;
HashProcedure() {
}
public int getHashCode() {
return h;
}
public final boolean execute(int key, V value) {
h += _hashingStrategy.computeHashCode(key) ^ HashFunctions.hash(value);
return true;
}
}
private static final class EqProcedure implements TIntObjectProcedure {
private final TIntObjectHashMap _otherMap;
EqProcedure(TIntObjectHashMap otherMap) {
_otherMap = otherMap;
}
public final boolean execute(int key, V value) {
int index = _otherMap.index(key);
return index >= 0 && eq(value, _otherMap.get(key));
}
/**
* Compare two objects for equality.
*/
private static boolean eq(Object o1, Object o2) {
return o1 == o2 || o1 != null && o1.equals(o2);
}
}
/**
* removes the mapping at index from the map.
*
* @param index an int value
*/
@Override
protected void removeAt(int index) {
_values[index] = (V)TObjectHash.REMOVED;
super.removeAt(index); // clear key, set; adjust size
}
/**
* Returns the values of the map.
*
* @return a value array
*/
public Object[] getValues() {
Object[] vals = new Object[size()];
V[] values = _values;
for (int i = values.length, j = 0; i-- > 0;) {
if (isFull(values, i)) {
vals[j++] = unwrapNull(values[i]);
}
}
return vals;
}
/**
* returns the keys of the map.
*
* @return a Set value
*/
public int[] keys() {
int[] keys = new int[size()];
int[] k = _set;
Object[] values = _values;
for (int i = values.length, j = 0; i-- > 0;) {
if (isFull(values, i)) {
keys[j++] = k[i];
}
}
return keys;
}
/**
* checks for the presence of val in the values of the map.
*
* @param val an Object value
* @return a boolean value
*/
public boolean containsValue(V val) {
V[] values = _values;
// special case null values so that we don't have to
// perform null checks before every call to equals()
if (null == val) {
for (int i = values.length; i-- > 0;) {
if (TObjectHash.NULL == values[i]) {
return true;
}
}
}
else {
for (int i = values.length; i-- > 0;) {
V value = unwrapNull(values[i]);
if (isFull(values, i) && (val == value || val.equals(value))) {
return true;
}
}
}
return false;
}
/**
* checks for the present of key in the keys of the map.
*
* @param key an int value
* @return a boolean value
*/
public boolean containsKey(int key) {
return contains(key);
}
/**
* Executes procedure for each key in the map.
*
* @param procedure a TIntProcedure value
* @return false if the loop over the keys terminated because
* the procedure returned false for some key.
*/
public boolean forEachKey(TIntProcedure procedure) {
return forEach(procedure);
}
/**
* Executes procedure for each value in the map.
*
* @param procedure a TObjectProcedure value
* @return false if the loop over the values terminated because
* the procedure returned false for some value.
*/
public boolean forEachValue(TObjectProcedure procedure) {
V[] values = _values;
for (int i = values.length; i-- > 0;) {
if (isFull(values, i) && ! procedure.execute(unwrapNull(values[i]))) {
return false;
}
}
return true;
}
/**
* Executes procedure for each key/value entry in the
* map.
*
* @param procedure a TOIntObjectProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TIntObjectProcedure procedure) {
int[] keys = _set;
V[] values = _values;
for (int i = values.length; i-- > 0;) {
if (isFull(values, i) && ! procedure.execute(keys[i],unwrapNull(values[i]))) {
return false;
}
}
return true;
}
/**
* Retains only those entries in the map for which the procedure
* returns a true value.
*
* @param procedure determines which entries to keep
* @return true if the map was modified.
*/
public boolean retainEntries(TIntObjectProcedure procedure) {
boolean modified = false;
int[] keys = _set;
V[] values = _values;
stopCompactingOnRemove();
try {
for (int i = values.length; i-- > 0;) {
if (isFull(values, i) && ! procedure.execute(keys[i],unwrapNull(values[i]))) {
removeAt(i);
modified = true;
}
}
}
finally {
startCompactingOnRemove(modified);
}
return modified;
}
/**
* Transform the values in this map using function.
*
* @param function a TObjectFunction value
*/
public void transformValues(TObjectFunction function) {
V[] values = _values;
for (int i = values.length; i-- > 0;) {
if (isFull(values, i)) {
values[i] = wrapNull(function.execute(unwrapNull(values[i])));
}
}
}
private void writeObject(ObjectOutputStream stream)
throws IOException {
stream.defaultWriteObject();
// number of entries
stream.writeInt(_size);
SerializationProcedure writeProcedure = new SerializationProcedure(stream);
if (! forEachEntry(writeProcedure)) {
throw writeProcedure.exception;
}
}
private void readObject(ObjectInputStream stream)
throws IOException, ClassNotFoundException {
stream.defaultReadObject();
int size = stream.readInt();
setUp(size);
while (size-- > 0) {
int key = stream.readInt();
V val = (V) stream.readObject();
put(key, val);
}
}
/**
* Default implementation of TIntHashingStrategy:
* delegates hashing to HashFunctions.hash(int).
*
* @param val the value to hash
* @return the hashcode.
*/
public final int computeHashCode(int val) {
return HashFunctions.hash(val);
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
forEachEntry(new TIntObjectProcedure() {
public boolean execute(int key, V value) {
if (sb.length() != 0) {
sb.append(',').append(' ');
}
sb.append(key);
sb.append('=');
sb.append(value == this ? "(this Map)" : value);
return true;
}
});
sb.append('}');
sb.insert(0, '{');
return sb.toString();
}
} // TIntObjectHashMap