gnu.trove.TLongShortHashMap 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 long keys and short values.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
*/
public class TLongShortHashMap extends TLongHash implements Externalizable {
static final long serialVersionUID = 1L;
/** the values of the map */
protected transient short[] _values;
/**
* Creates a new TLongShortHashMap instance with the default
* capacity and load factor.
*/
public TLongShortHashMap() {
super();
}
/**
* Creates a new TLongShortHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public TLongShortHashMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Creates a new TLongShortHashMap 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 TLongShortHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Creates a new TLongShortHashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TLongShortHashMap(TLongHashingStrategy strategy) {
super(strategy);
}
/**
* Creates a new TLongShortHashMap 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 TLongShortHashMap(int initialCapacity, TLongHashingStrategy strategy) {
super(initialCapacity, strategy);
}
/**
* Creates a new TLongShortHashMap 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 TLongShortHashMap(int initialCapacity, float loadFactor, TLongHashingStrategy strategy) {
super(initialCapacity, loadFactor, strategy);
}
/**
* @return a deep clone of this collection
*/
public Object clone() {
TLongShortHashMap m = (TLongShortHashMap)super.clone();
m._values = (short[])this._values.clone();
return m;
}
/**
* @return a TLongShortIterator with access to this map's keys and values
*/
public TLongShortIterator iterator() {
return new TLongShortIterator(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 = new short[capacity];
return capacity;
}
/**
* Inserts a key/value pair into the map.
*
* @param key an long value
* @param value an short value
* @return the previous value associated with key,
* or (long)0 if none was found.
*/
public short put(long key, short value) {
byte previousState;
short previous = (short)0;
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;
long oldKeys[] = _set;
short oldVals[] = _values;
byte oldStates[] = _states;
_set = new long[newCapacity];
_values = new short[newCapacity];
_states = new byte[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(oldStates[i] == FULL) {
long 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 long value
* @return the value of key or (long)0 if no such mapping exists.
*/
public short get(long key) {
int index = index(key);
return index < 0 ? (short)0 : _values[index];
}
/**
* Empties the map.
*
*/
public void clear() {
super.clear();
long[] keys = _set;
short[] vals = _values;
byte[] states = _states;
for (int i = keys.length; i-- > 0;) {
keys[i] = (long)0;
vals[i] = (short)0;
states[i] = FREE;
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an long value
* @return an short value, or (long)0 if no mapping for key exists
*/
public short remove(long key) {
short prev = (short)0;
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 TLongShortHashMap)) {
return false;
}
TLongShortHashMap that = (TLongShortHashMap)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 TLongShortProcedure {
private int h = 0;
public int getHashCode() {
return h;
}
public final boolean execute(long key, short value) {
h += (_hashingStrategy.computeHashCode(key) ^ HashFunctions.hash(value));
return true;
}
}
private static final class EqProcedure implements TLongShortProcedure {
private final TLongShortHashMap _otherMap;
EqProcedure(TLongShortHashMap otherMap) {
_otherMap = otherMap;
}
public final boolean execute(long key, short value) {
int index = _otherMap.index(key);
if (index >= 0 && eq(value, _otherMap.get(key))) {
return true;
}
return false;
}
/**
* Compare two shorts for equality.
*/
private final boolean eq(short v1, short v2) {
return v1 == v2;
}
}
/**
* removes the mapping at index from the map.
*
* @param index an int value
*/
protected void removeAt(int index) {
_values[index] = (short)0;
super.removeAt(index); // clear key, state; adjust size
}
/**
* Returns the values of the map.
*
* @return a Collection value
*/
public short[] getValues() {
short[] vals = new short[size()];
short[] v = _values;
byte[] states = _states;
for (int i = v.length, j = 0; i-- > 0;) {
if (states[i] == FULL) {
vals[j++] = v[i];
}
}
return vals;
}
/**
* returns the keys of the map.
*
* @return a Set value
*/
public long[] keys() {
long[] keys = new long[size()];
long[] k = _set;
byte[] states = _states;
for (int i = k.length, j = 0; i-- > 0;) {
if (states[i] == FULL) {
keys[j++] = k[i];
}
}
return keys;
}
/**
* returns the keys of the map.
*
* @param a the array into which the elements of the list are to
* be stored, if it is big enough; otherwise, a new array of the
* same type is allocated for this purpose.
* @return a Set value
*/
public long[] keys(long[] a) {
int size = size();
if (a.length < size) {
a = (long[]) java.lang.reflect.Array.newInstance(
a.getClass().getComponentType(), size);
}
long[] k = (long[]) _set;
for (int i = k.length, j = 0; i-- > 0;) {
if (k[i] != FREE && k[i] != REMOVED) {
a[j++] = k[i];
}
}
return a;
}
/**
* checks for the presence of val in the values of the map.
*
* @param val an short value
* @return a boolean value
*/
public boolean containsValue(short val) {
byte[] states = _states;
short[] vals = _values;
for (int i = vals.length; i-- > 0;) {
if (states[i] == FULL && val == vals[i]) {
return true;
}
}
return false;
}
/**
* checks for the present of key in the keys of the map.
*
* @param key an long value
* @return a boolean value
*/
public boolean containsKey(long key) {
return contains(key);
}
/**
* Executes procedure for each key in the map.
*
* @param procedure a TLongProcedure value
* @return false if the loop over the keys terminated because
* the procedure returned false for some key.
*/
public boolean forEachKey(TLongProcedure procedure) {
return forEach(procedure);
}
/**
* Executes procedure for each value in the map.
*
* @param procedure a TShortProcedure value
* @return false if the loop over the values terminated because
* the procedure returned false for some value.
*/
public boolean forEachValue(TShortProcedure procedure) {
byte[] states = _states;
short[] 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 TOLongShortProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TLongShortProcedure procedure) {
byte[] states = _states;
long[] keys = _set;
short[] 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(TLongShortProcedure procedure) {
boolean modified = false;
byte[] states = _states;
long[] keys = _set;
short[] 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 TShortFunction value
*/
public void transformValues(TShortFunction function) {
byte[] states = _states;
short[] values = _values;
for (int i = values.length; i-- > 0;) {
if (states[i] == FULL) {
values[i] = function.execute(values[i]);
}
}
}
/**
* Increments the primitive value mapped to key by 1
*
* @param key the key of the value to increment
* @return true if a mapping was found and modified.
*/
public boolean increment(long key) {
return adjustValue(key, (short)1);
}
/**
* Adjusts the primitive value mapped to key.
*
* @param key the key of the value to increment
* @param amount the amount to adjust the value by.
* @return true if a mapping was found and modified.
*/
public boolean adjustValue(long key, short amount) {
int index = index(key);
if (index < 0) {
return false;
} else {
_values[index] += amount;
return true;
}
}
/**
* Adjusts the primitive value mapped to the key if the key is present in the map.
* Otherwise, the initial_value is put in the map.
*
* @param key the key of the value to increment
* @param adjust_amount the amount to adjust the value by
* @param put_amount the value put into the map if the key is not initial present
*
* @return the value present in the map after the adjustment or put operation
*
* @since 2.0b1
*/
public short adjustOrPutValue(final long key, final short adjust_amount, final short put_amount ) {
int index = insertionIndex(key);
final boolean isNewMapping;
final short newValue;
if (index < 0) {
index = -index -1;
newValue = ( _values[index] += adjust_amount );
isNewMapping = false;
} else {
newValue = ( _values[index] = put_amount );
isNewMapping = true;
}
byte previousState = _states[index];
_set[index] = key;
_states[index] = FULL;
if ( isNewMapping ) {
postInsertHook(previousState == FREE);
}
return newValue;
}
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) {
long key = in.readLong();
short val = in.readShort();
put(key, val);
}
}
} // TLongShortHashMap