gnu.trove.TIntLongHashMap 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 int keys and long values.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
*/
public class TIntLongHashMap extends TIntHash implements Externalizable {
static final long serialVersionUID = 1L;
/** the values of the map */
protected transient long[] _values;
/**
* Creates a new TIntLongHashMap instance with the default
* capacity and load factor.
*/
public TIntLongHashMap() {
super();
}
/**
* Creates a new TIntLongHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public TIntLongHashMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Creates a new TIntLongHashMap 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 TIntLongHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Creates a new TIntLongHashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TIntLongHashMap(TIntHashingStrategy strategy) {
super(strategy);
}
/**
* Creates a new TIntLongHashMap 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 TIntLongHashMap(int initialCapacity, TIntHashingStrategy strategy) {
super(initialCapacity, strategy);
}
/**
* Creates a new TIntLongHashMap 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 TIntLongHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy) {
super(initialCapacity, loadFactor, strategy);
}
/**
* @return a deep clone of this collection
*/
public Object clone() {
TIntLongHashMap m = (TIntLongHashMap)super.clone();
m._values = (long[])this._values.clone();
return m;
}
/**
* @return a TIntLongIterator with access to this map's keys and values
*/
public TIntLongIterator iterator() {
return new TIntLongIterator(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 long[capacity];
return capacity;
}
/**
* Inserts a key/value pair into the map.
*
* @param key an int value
* @param value an long value
* @return the previous value associated with key,
* or (int)0 if none was found.
*/
public long put(int key, long value) {
byte previousState;
long previous = (long)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;
int oldKeys[] = _set;
long oldVals[] = _values;
byte oldStates[] = _states;
_set = new int[newCapacity];
_values = new long[newCapacity];
_states = new byte[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(oldStates[i] == FULL) {
int 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 int value
* @return the value of key or (int)0 if no such mapping exists.
*/
public long get(int key) {
int index = index(key);
return index < 0 ? (long)0 : _values[index];
}
/**
* Empties the map.
*
*/
public void clear() {
super.clear();
int[] keys = _set;
long[] vals = _values;
byte[] states = _states;
for (int i = keys.length; i-- > 0;) {
keys[i] = (int)0;
vals[i] = (long)0;
states[i] = FREE;
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an int value
* @return an long value, or (int)0 if no mapping for key exists
*/
public long remove(int key) {
long prev = (long)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 TIntLongHashMap)) {
return false;
}
TIntLongHashMap that = (TIntLongHashMap)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 TIntLongProcedure {
private int h = 0;
public int getHashCode() {
return h;
}
public final boolean execute(int key, long value) {
h += (_hashingStrategy.computeHashCode(key) ^ HashFunctions.hash(value));
return true;
}
}
private static final class EqProcedure implements TIntLongProcedure {
private final TIntLongHashMap _otherMap;
EqProcedure(TIntLongHashMap otherMap) {
_otherMap = otherMap;
}
public final boolean execute(int key, long value) {
int index = _otherMap.index(key);
if (index >= 0 && eq(value, _otherMap.get(key))) {
return true;
}
return false;
}
/**
* Compare two longs for equality.
*/
private final boolean eq(long v1, long v2) {
return v1 == v2;
}
}
/**
* removes the mapping at index from the map.
*
* @param index an int value
*/
protected void removeAt(int index) {
_values[index] = (long)0;
super.removeAt(index); // clear key, state; adjust size
}
/**
* Returns the values of the map.
*
* @return a Collection value
*/
public long[] getValues() {
long[] vals = new long[size()];
long[] 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 int[] keys() {
int[] keys = new int[size()];
int[] 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 int[] keys(int[] a) {
int size = size();
if (a.length < size) {
a = (int[]) java.lang.reflect.Array.newInstance(
a.getClass().getComponentType(), size);
}
int[] k = (int[]) _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 long value
* @return a boolean value
*/
public boolean containsValue(long val) {
byte[] states = _states;
long[] 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 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 TLongProcedure value
* @return false if the loop over the values terminated because
* the procedure returned false for some value.
*/
public boolean forEachValue(TLongProcedure procedure) {
byte[] states = _states;
long[] 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 TOIntLongProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TIntLongProcedure procedure) {
byte[] states = _states;
int[] keys = _set;
long[] 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(TIntLongProcedure procedure) {
boolean modified = false;
byte[] states = _states;
int[] keys = _set;
long[] 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 TLongFunction value
*/
public void transformValues(TLongFunction function) {
byte[] states = _states;
long[] 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(int key) {
return adjustValue(key, (long)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(int key, long 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 long adjustOrPutValue(final int key, final long adjust_amount, final long put_amount ) {
int index = insertionIndex(key);
final boolean isNewMapping;
final long 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) {
int key = in.readInt();
long val = in.readLong();
put(key, val);
}
}
} // TIntLongHashMap