gnu.trove.TShortObjectHashMap 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
The Trove library provides high speed regular and primitive
collections for Java.
///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////
package gnu.trove;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.io.Externalizable;
//////////////////////////////////////////////////
// THIS IS A GENERATED CLASS. DO NOT HAND EDIT! //
//////////////////////////////////////////////////
/**
* An open addressed Map implementation for short keys and Object values.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
*/
public class TShortObjectHashMap extends TShortHash implements Externalizable {
static final long serialVersionUID = 1L;
/** the values of the map */
protected transient V[] _values;
/**
* Creates a new TShortObjectHashMap instance with the default
* capacity and load factor.
*/
public TShortObjectHashMap() {
super();
}
/**
* Creates a new TShortObjectHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public TShortObjectHashMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Creates a new TShortObjectHashMap 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 TShortObjectHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Creates a new TShortObjectHashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TShortObjectHashMap(TShortHashingStrategy strategy) {
super(strategy);
}
/**
* Creates a new TShortObjectHashMap 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 TShortObjectHashMap(int initialCapacity, TShortHashingStrategy strategy) {
super(initialCapacity, strategy);
}
/**
* Creates a new TShortObjectHashMap 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 TShortObjectHashMap(int initialCapacity, float loadFactor, TShortHashingStrategy strategy) {
super(initialCapacity, loadFactor, strategy);
}
/**
* @return a deep clone of this collection
*/
public TShortObjectHashMap clone() {
TShortObjectHashMap m = (TShortObjectHashMap)super.clone();
m._values = (V[]) this._values.clone();
return m;
}
/**
* @return a TShortObjectIterator with access to this map's keys and values
*/
public TShortObjectIterator iterator() {
return new TShortObjectIterator(this);
}
/**
* initializes the hashtable to a prime capacity which is at least
* initialCapacity + 1.
*
* @param initialCapacity an int value
* @return the actual capacity chosen
*/
protected int setUp(int initialCapacity) {
int capacity;
capacity = super.setUp(initialCapacity);
_values = (V[]) new Object[capacity];
return capacity;
}
/**
* Inserts a key/value pair into the map.
*
* @param key an short value
* @param value an Object value
* @return the previous value associated with key,
* or (short)0 if none was found.
*/
public V put(short key, V value) {
byte previousState;
V previous = null;
int index = insertionIndex(key);
boolean isNewMapping = true;
if (index < 0) {
index = -index -1;
previous = _values[index];
isNewMapping = false;
}
previousState = _states[index];
_set[index] = key;
_states[index] = FULL;
_values[index] = value;
if (isNewMapping) {
postInsertHook(previousState == FREE);
}
return previous;
}
/**
* rehashes the map to the new capacity.
*
* @param newCapacity an int value
*/
protected void rehash(int newCapacity) {
int oldCapacity = _set.length;
short oldKeys[] = _set;
V oldVals[] = _values;
byte oldStates[] = _states;
_set = new short[newCapacity];
_values = (V[]) new Object[newCapacity];
_states = new byte[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(oldStates[i] == FULL) {
short o = oldKeys[i];
int index = insertionIndex(o);
_set[index] = o;
_values[index] = oldVals[i];
_states[index] = FULL;
}
}
}
/**
* retrieves the value for key
*
* @param key an short value
* @return the value of key or (short)0 if no such mapping exists.
*/
public V get(short key) {
int index = index(key);
return index < 0 ? null : _values[index];
}
/**
* Empties the map.
*
*/
public void clear() {
super.clear();
short[] keys = _set;
Object[] vals = _values;
byte[] states = _states;
for (int i = keys.length; i-- > 0;) {
keys[i] = (short)0;
vals[i] = null;
states[i] = FREE;
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an short value
* @return an Object value or (short)0 if no such mapping exists.
*/
public V remove(short key) {
V prev = null;
int index = index(key);
if (index >= 0) {
prev = _values[index];
removeAt(index); // clear key,state; adjust size
}
return prev;
}
/**
* Compares this map with another map for equality of their stored
* entries.
*
* @param other an Object value
* @return a boolean value
*/
public boolean equals(Object other) {
if (! (other instanceof TShortObjectHashMap)) {
return false;
}
TShortObjectHashMap that = (TShortObjectHashMap)other;
if (that.size() != this.size()) {
return false;
}
return forEachEntry(new EqProcedure(that));
}
public int hashCode() {
HashProcedure p = new HashProcedure();
forEachEntry(p);
return p.getHashCode();
}
private final class HashProcedure implements TShortObjectProcedure {
private int h = 0;
public int getHashCode() {
return h;
}
public final boolean execute(short key, Object value) {
h += (_hashingStrategy.computeHashCode(key) ^ HashFunctions.hash(value));
return true;
}
}
private static final class EqProcedure implements TShortObjectProcedure {
private final TShortObjectHashMap _otherMap;
EqProcedure(TShortObjectHashMap otherMap) {
_otherMap = otherMap;
}
public final boolean execute(short key, Object value) {
int index = _otherMap.index(key);
if (index >= 0 && eq(value, _otherMap.get(key))) {
return true;
}
return false;
}
/**
* Compare two objects for equality.
*/
private final 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
*/
protected void removeAt(int index) {
_values[index] = null;
super.removeAt(index); // clear key, state; adjust size
}
/**
* Returns the values of the map.
*
* @return a Collection value
*
* @see #getValues(Object[])
*/
public Object[] getValues() {
Object[] vals = new Object[size()];
V[] v = _values;
byte[] states = _states;
for (int i = v.length, j = 0; i-- > 0;) {
if (states[i] == FULL) {
vals[j++] = v[i];
}
}
return vals;
}
/**
* Return the values of the map; the runtime type of the returned array is that of
* the specified array.
*
* @param a the array into which the elements of this collection are to be
* stored, if it is big enough; otherwise, a new array of the same
* runtime type is allocated for this purpose.
* @return an array containing the elements of this collection
*
* @throws ArrayStoreException the runtime type of the specified array is
* not a supertype of the runtime type of every element in this
* collection.
* @throws NullPointerException if the specified array is null.
*
* @see #getValues()
*/
public T[] getValues( T[] a ) {
if (a.length < _size) {
a = (T[])java.lang.reflect.Array.newInstance(a.getClass().getComponentType(),
_size);
}
V[] v = _values;
byte[] states = _states;
for (int i = v.length, j = 0; i-- > 0;) {
if (states[i] == FULL) {
a[j++] = (T) v[i];
}
}
return a;
}
/**
* returns the keys of the map.
*
* @return a Set value
*/
public short[] keys() {
short[] keys = new short[size()];
short[] k = _set;
byte[] states = _states;
for (int i = k.length, j = 0; i-- > 0;) {
if (states[i] == FULL) {
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) {
byte[] states = _states;
V[] vals = _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 = vals.length; i-- > 0;) {
if (states[i] == FULL &&
val == vals[i]) {
return true;
}
}
} else {
for (int i = vals.length; i-- > 0;) {
if (states[i] == FULL &&
(val == vals[i] || val.equals(vals[i]))) {
return true;
}
}
} // end of else
return false;
}
/**
* checks for the present of key in the keys of the map.
*
* @param key an short value
* @return a boolean value
*/
public boolean containsKey(short key) {
return contains(key);
}
/**
* Executes procedure for each key in the map.
*
* @param procedure a TShortProcedure value
* @return false if the loop over the keys terminated because
* the procedure returned false for some key.
*/
public boolean forEachKey(TShortProcedure 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) {
byte[] states = _states;
V[] values = _values;
for (int i = values.length; i-- > 0;) {
if (states[i] == FULL && ! procedure.execute(values[i])) {
return false;
}
}
return true;
}
/**
* Executes procedure for each key/value entry in the
* map.
*
* @param procedure a TOShortObjectProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TShortObjectProcedure procedure) {
byte[] states = _states;
short[] keys = _set;
V[] values = _values;
for (int i = keys.length; i-- > 0;) {
if (states[i] == FULL && ! procedure.execute(keys[i],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(TShortObjectProcedure procedure) {
boolean modified = false;
byte[] states = _states;
short[] keys = _set;
V[] values = _values;
// Temporarily disable compaction. This is a fix for bug #1738760
tempDisableAutoCompaction();
try {
for (int i = keys.length; i-- > 0;) {
if (states[i] == FULL && ! procedure.execute(keys[i],values[i])) {
removeAt(i);
modified = true;
}
}
}
finally {
reenableAutoCompaction(true);
}
return modified;
}
/**
* Transform the values in this map using function.
*
* @param function a TObjectFunction value
*/
public void transformValues(TObjectFunction function) {
byte[] states = _states;
V[] values = _values;
for (int i = values.length; i-- > 0;) {
if (states[i] == FULL) {
values[i] = function.execute(values[i]);
}
}
}
public void writeExternal( ObjectOutput out ) throws IOException {
// VERSION
out.writeByte( 0 );
// NUMBER OF ENTRIES
out.writeInt( _size );
// ENTRIES
SerializationProcedure writeProcedure = new SerializationProcedure( out );
if (! forEachEntry(writeProcedure)) {
throw writeProcedure.exception;
}
}
public void readExternal( ObjectInput in )
throws IOException, ClassNotFoundException {
// VERSION
in.readByte();
// NUMBER OF ENTRIES
int size = in.readInt();
setUp( size );
// ENTRIES
while (size-- > 0) {
short key = in.readShort();
V val = (V) in.readObject();
put(key, val);
}
}
} // TShortObjectHashMap