com.gemstone.gnu.trove.TObjectLongHashMap 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.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
/**
* An open addressed Map implementation for Object keys and long values.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
* @version $Id: TObjectLongHashMap.java,v 1.13 2003/03/23 04:07:00 ericdf Exp $
*/
public class TObjectLongHashMap extends TObjectHash implements
Serializable {
private static final long serialVersionUID = -2411540076364070050L;
/** the values of the map */
protected transient long[] _values;
/** the default value returned by get() when map does not contain a key */
protected long defaultValue = 0L;
/**
* Creates a new TObjectLongHashMap instance with the default
* capacity and load factor.
*/
public TObjectLongHashMap() {
super();
}
/**
* Creates a new TObjectLongHashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public TObjectLongHashMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Creates a new TObjectLongHashMap 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 TObjectLongHashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Creates a new TObjectLongHashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare keys.
*/
public TObjectLongHashMap(TObjectHashingStrategy strategy) {
super(strategy);
}
/**
* Creates a new TObjectLongHashMap 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 TObjectLongHashMap(int initialCapacity, TObjectHashingStrategy strategy) {
super(initialCapacity, strategy);
}
/**
* Creates a new TObjectLongHashMap 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 TObjectLongHashMap(int initialCapacity, float loadFactor, TObjectHashingStrategy strategy) {
super(initialCapacity, loadFactor, strategy);
}
/**
* @return an iterator over the entries in this map
*/
public TObjectLongIterator iterator() {
return new TObjectLongIterator(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 // GemStoneAddition
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 Object value
* @param value an long value
* @return the previous value associated with key,
* or null if none was found.
*/
public final long put(Object key, long value) {
long previous = this.defaultValue;
int index = insertionIndex(key);
boolean isNewMapping = true;
if (index < 0) {
index = -index -1;
previous = _values[index];
isNewMapping = false;
}
Object oldKey = _set[index];
_set[index] = key;
_values[index] = value;
if (isNewMapping) {
postInsertHook(oldKey == null);
}
return previous;
}
/**
* rehashes the map to the new capacity.
*
* @param newCapacity an int value
*/
@Override // GemStoneAddition
protected void rehash(int newCapacity) {
int oldCapacity = _set.length;
Object oldKeys[] = _set;
long oldVals[] = _values;
_set = new Object[newCapacity];
_values = new long[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(oldKeys[i] != null && oldKeys[i] != REMOVED) {
Object o = oldKeys[i];
int index = insertionIndex(o);
if (index < 0) {
throwObjectContractViolation(_set[(-index -1)], o);
}
_set[index] = o;
_values[index] = oldVals[i];
}
}
}
/**
* retrieves the value for key
*
* @param key an Object value
* @return the value of key or null if no such mapping exists.
*/
public final long get(Object key) {
int index = index(key);
return index >= 0 ? _values[index] : this.defaultValue;
}
/**
* Empties the map.
*
*/
@Override // GemStoneAddition
public void clear() {
super.clear();
Object[] keys = _set;
long[] vals = _values;
for (int i = keys.length; i-- > 0;) {
keys[i] = null;
vals[i] = 0;
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an Object value
* @return an long value
*/
public final long remove(Object key) {
long prev = this.defaultValue;
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
*/
@Override // GemStoneAddition
public boolean equals(Object other) {
if (! (other instanceof TObjectLongHashMap)) {
return false;
}
TObjectLongHashMap that = (TObjectLongHashMap)other;
if (that.size() != this.size()) {
return false;
}
return forEachEntry(new EqProcedure(that));
}
// GemStoneAddition
public long getDefaultValue() {
return this.defaultValue;
}
/**
* {@inheritDoc}
*/
@Override // GemStoneAddition
public int hashCode() { // GemStoneAddition
int hash = 0;
final Object[] keys = _set;
final long[] values = _values;
Object key;
long value;
for (int i = values.length; i-- > 0;) {
key = keys[i];
if (key != null && key != REMOVED) {
value = values[i];
hash ^= key.hashCode();
hash ^= (value ^ (value >>> 32));
}
}
return hash;
}
private static final class EqProcedure implements TObjectLongProcedure {
private final TObjectLongHashMap _otherMap;
EqProcedure(TObjectLongHashMap otherMap) {
_otherMap = otherMap;
}
public final boolean execute(Object 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
*/
@Override // GemStoneAddition
protected void removeAt(int index) {
super.removeAt(index); // clear key, state; adjust size
_values[index] = 0;
}
/**
* Returns the values of the map.
*
* @return a Collection value
*/
public long[] getValues() {
long[] vals = new long[size()];
long[] v = _values;
Object[] keys = _set;
for (int i = v.length, j = 0; i-- > 0;) {
if (keys[i] != null && keys[i] != REMOVED) {
vals[j++] = v[i];
}
}
return vals;
}
/**
* returns the keys of the map.
*
* @return a Set value
*/
public Object[] keys() {
Object[] keys = new Object[size()];
Object[] k = _set;
for (int i = k.length, j = 0; i-- > 0;) {
if (k[i] != null && k[i] != REMOVED) {
keys[j++] = k[i];
}
}
return keys;
}
/**
* 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) {
Object[] keys = _set;
long[] vals = _values;
for (int i = vals.length; i-- > 0;) {
if (keys[i] != null && keys[i] != REMOVED && val == vals[i]) {
return true;
}
}
return false;
}
/**
* checks for the present of key in the keys of the map.
*
* @param key an Object value
* @return a boolean value
*/
public boolean containsKey(Object key) {
return contains(key);
}
/**
* Executes procedure for each key in the map.
*
* @param procedure a TObjectProcedure value
* @return false if the loop over the keys terminated because
* the procedure returned false for some key.
*/
public boolean forEachKey(TObjectProcedure 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) {
Object[] keys = _set;
long[] values = _values;
for (int i = values.length; i-- > 0;) {
if (keys[i] != null && keys[i] != REMOVED
&& ! procedure.execute(values[i])) {
return false;
}
}
return true;
}
/**
* Executes procedure for each key/value entry in the
* map.
*
* @param procedure a TOObjectLongProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TObjectLongProcedure procedure) {
Object[] keys = _set;
long[] values = _values;
for (int i = keys.length; i-- > 0;) {
if (keys[i] != null
&& keys[i] != REMOVED
&& ! 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(TObjectLongProcedure procedure) {
boolean modified = false;
Object[] keys = _set;
long[] values = _values;
for (int i = keys.length; i-- > 0;) {
if (keys[i] != null
&& keys[i] != REMOVED
&& ! procedure.execute(keys[i],values[i])) {
removeAt(i);
modified = true;
}
}
return modified;
}
/**
* Transform the values in this map using function.
*
* @param function a TLongFunction value
*/
public void transformValues(TLongFunction function) {
Object[] keys = _set;
long[] values = _values;
for (int i = values.length; i-- > 0;) {
if (keys[i] != null && keys[i] != REMOVED) {
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(Object key) {
return adjustValue(key, 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(Object key, long amount) {
int index = index(key);
if (index < 0) {
return false;
} else {
_values[index] += amount;
return true;
}
}
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) {
Object key = stream.readObject();
long val = stream.readLong();
put(key, val);
}
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append('{');
forEachEntry(new TObjectLongProcedure() {
@Override
public boolean execute(Object a, long b) {
sb.append(a == this ? "(this Map)" : a);
sb.append('=');
sb.append(b);
sb.append(", ");
return true;
}
});
return sb.append('}').toString();
}
} // TObjectLongHashMap