gnu.trove.THashMap 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.
///////////////////////////////////////////////////////////////////////////////
package gnu.trove;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Array;
import java.util.*;
/**
* An implementation of the Map interface which uses an open addressed
* hash table to store its contents.
*
* Created: Sun Nov 4 08:52:45 2001
*
* @author Eric D. Friedman
*/
public class THashMap extends TObjectHash implements Map {
/** the values of the map */
protected transient V[] _values;
/**
* Creates a new THashMap instance with the default
* capacity and load factor.
*/
public THashMap() {
super();
}
/**
* Creates a new THashMap instance with the default
* capacity and load factor.
* @param strategy used to compute hash codes and to compare objects.
*/
public THashMap(TObjectHashingStrategy strategy) {
super(strategy);
}
/**
* Creates a new THashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
*/
public THashMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Creates a new THashMap instance with a prime
* capacity equal to or greater than initialCapacity and
* with the default load factor.
*
* @param initialCapacity an int value
* @param strategy used to compute hash codes and to compare objects.
*/
public THashMap(int initialCapacity, TObjectHashingStrategy strategy) {
super(initialCapacity, strategy);
}
/**
* Creates a new THashMap 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 THashMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Creates a new THashMap 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
* @param strategy used to compute hash codes and to compare objects.
*/
public THashMap(int initialCapacity, float loadFactor, TObjectHashingStrategy strategy) {
super(initialCapacity, loadFactor, strategy);
}
/**
* Creates a new THashMap instance which contains the
* key/value pairs in map.
*
* @param map a Map value
*/
public THashMap(Map map) {
this(map.size());
putAll(map);
}
/**
* Creates a new THashMap instance which contains the
* key/value pairs in map.
*
* @param map a Map value
* @param strategy used to compute hash codes and to compare objects.
*/
public THashMap(Map map, TObjectHashingStrategy strategy) {
this(map.size(), strategy);
putAll(map);
}
/**
* @return a shallow clone of this collection
*/
@Override
public THashMap clone() {
THashMap m = (THashMap)super.clone();
m._values = _values.clone();
return m;
}
/**
* initialize the value array of the map.
*
* @param initialCapacity an int value
* @return an int value
*/
@Override
protected int setUp(int initialCapacity) {
int capacity = super.setUp(initialCapacity);
_values = (V[]) (initialCapacity == JUST_CREATED_CAPACITY ? EMPTY_OBJECT_ARRAY : new Object[capacity]);
return capacity;
}
/**
* Inserts a key/value pair into the map.
*
* @param key an Object value
* @param value an Object value
* @return the previous value associated with key,
* or null if none was found.
*/
public V put(K key, V value) {
if (null == key) {
throw new NullPointerException("null keys not supported");
}
V previous = null;
int index = insertionIndex(key);
boolean alreadyStored = index < 0;
if (alreadyStored) {
index = -index -1;
previous = _values[index];
}
Object oldKey = _set[index];
_set[index] = key;
_values[index] = value;
if (!alreadyStored) {
postInsertHook(oldKey == null);
}
return previous;
}
/**
* 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 Map)) {
return false;
}
Map that = (Map)other;
if (that.size() != 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 TObjectObjectProcedure {
private int h;
HashProcedure() {
}
public int getHashCode() {
return h;
}
public final boolean execute(K key, V value) {
h += _hashingStrategy.computeHashCode(key) ^ (value == null ? 0 : value.hashCode());
return true;
}
}
private static final class EqProcedure implements TObjectObjectProcedure {
private final Map _otherMap;
EqProcedure(Map otherMap) {
_otherMap = otherMap;
}
public final boolean execute(K key, V value) {
V oValue = _otherMap.get(key);
return oValue == value || (oValue != null && oValue.equals(value));
}
}
/**
* 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 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;
Object[] set = _set;
for (int i = values.length; i-- > 0;) {
if (set[i] != null
&& set[i] != REMOVED
&& ! procedure.execute(values[i])) {
return false;
}
}
return true;
}
/**
* Executes procedure for each key/value entry in the
* map.
*
* @param procedure a TObjectObjectProcedure value
* @return false if the loop over the entries terminated because
* the procedure returned false for some entry.
*/
public boolean forEachEntry(TObjectObjectProcedure procedure) {
Object[] keys = _set;
V[] values = _values;
for (int i = keys.length; i-- > 0;) {
if (keys[i] != null
&& keys[i] != REMOVED
&& ! procedure.execute((K) 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(TObjectObjectProcedure procedure) {
Object[] keys = _set;
V[] values = _values;
stopCompactingOnRemove();
boolean modified = false;
try {
for (int i = keys.length; i-- > 0;) {
if (keys[i] != null
&& keys[i] != REMOVED
&& ! procedure.execute((K) keys[i],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;
Object[] set = _set;
for (int i = values.length; i-- > 0;) {
if (set[i] != null && set[i] != REMOVED) {
values[i] = function.execute(values[i]);
}
}
}
/**
* rehashes the map to the new capacity.
*
* @param newCapacity an int value
*/
@Override
protected void rehash(int newCapacity) {
int oldCapacity = _set.length;
Object[] oldKeys = _set;
V[] oldVals = _values;
_set = new Object[newCapacity];
_values = (V[]) new Object[newCapacity];
for (int i = oldCapacity; i-- > 0;) {
if(oldKeys[i] != null && oldKeys[i] != REMOVED) {
Object o = oldKeys[i];
int index = insertionIndex((K) 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 V get(Object key) {
int index = index((K) key);
return index < 0 ? null : _values[index];
}
/**
* Empties the map.
*
*/
@Override
public void clear() {
// optimization
if (size() != 0) {
super.clear();
Object[] keys = _set;
V[] values = _values;
for (int i = keys.length; i-- > 0;) {
keys[i] = null;
values[i] = null;
}
}
}
/**
* Deletes a key/value pair from the map.
*
* @param key an Object value
* @return an Object value
*/
public V remove(Object key) {
V prev = null;
int index = index((K) key);
if (index >= 0) {
prev = _values[index];
removeAt(index); // clear key,state; adjust size
}
return prev;
}
/**
* removes the mapping at index from the map.
*
* @param index an int value
*/
@Override
protected void removeAt(int index) {
_values[index] = null;
super.removeAt(index); // clear key, state; adjust size
}
/**
* Returns a view on the values of the map.
*
* @return a Collection value
*/
public Collection values() {
return new ValueView();
}
/**
* returns a Set view on the keys of the map.
*
* @return a Set value
*/
public Set keySet() {
return new KeyView();
}
/**
* Returns a Set view on the entries of the map.
*
* @return a Set value
*/
public Set> entrySet() {
return new EntryView();
}
/**
* checks for the presence of val in the values of the map.
*
* @param val an Object value
* @return a boolean value
*/
public boolean containsValue(Object val) {
Object[] set = _set;
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 (set[i] != null && set[i] != REMOVED &&
val == vals[i]) {
return true;
}
}
} else {
for (int i = vals.length; i-- > 0;) {
if (set[i] != null && set[i] != REMOVED &&
(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 Object value
* @return a boolean value
*/
public boolean containsKey(Object key) {
return contains(key);
}
/**
* copies the key/value mappings in map into this map.
*
* @param map a Map value
*/
public void putAll(Map map) {
ensureCapacity(map.size());
// could optimize this for cases when map instanceof THashMap
for (Map.Entry e : map.entrySet()) {
put(e.getKey(), e.getValue());
}
}
/**
* a view onto the values of the map.
*
*/
protected class ValueView extends MapBackedView {
@Override
public Iterator iterator() {
return new THashIterator(THashMap.this) {
@Override
protected V objectAtIndex(int index) {
return _values[index];
}
};
}
@Override
public boolean containsElement(V value) {
return containsValue(value);
}
@Override
public boolean removeElement(V value) {
boolean changed = false;
Object[] values = _values;
Object[] set = _set;
for (int i = values.length; i-- > 0;) {
if (set[i] != null && set[i] != REMOVED &&
value == values[i] ||
(null != values[i] && values[i].equals(value))) {
removeAt(i);
changed = true;
}
}
return changed;
}
}
/**
* a view onto the entries of the map.
*
*/
protected class EntryView extends MapBackedView> {
EntryView() {
}
private final class EntryIterator extends THashIterator> {
EntryIterator(THashMap map) {
super(map);
}
@Override
public Entry objectAtIndex(final int index) {
return new Entry((K) _set[index], _values[index], index);
}
}
@Override
public Iterator> iterator() {
return new EntryIterator(THashMap.this);
}
@Override
public boolean removeElement(Map.Entry entry) {
// have to effectively reimplement Map.remove here
// because we need to return true/false depending on
// whether the removal took place. Since the Entry's
// value can be null, this means that we can't rely
// on the value of the object returned by Map.remove()
// to determine whether a deletion actually happened.
//
// Note also that the deletion is only legal if
// both the key and the value match.
K key = keyForEntry(entry);
int index = index(key);
if (index >= 0) {
Object val = valueForEntry(entry);
if (val == _values[index] ||
(null != val && val.equals(_values[index]))) {
removeAt(index); // clear key,state; adjust size
return true;
}
}
return false;
}
@Override
public boolean containsElement(Map.Entry entry) {
Object val = get(keyForEntry(entry));
Object entryValue = entry.getValue();
return entryValue == val ||
(null != val && val.equals(entryValue));
}
protected V valueForEntry(Map.Entry entry) {
return entry.getValue();
}
protected K keyForEntry(Map.Entry entry) {
return entry.getKey();
}
}
private abstract class MapBackedView implements Set {
MapBackedView() {
}
public abstract Iterator iterator();
public abstract boolean removeElement(E key);
public abstract boolean containsElement(E key);
public boolean contains(Object key) {
return containsElement((E) key);
}
public boolean remove(Object o) {
return removeElement((E) o);
}
public boolean containsAll(Collection collection) {
for (Object element : collection) {
if (!contains(element)) {
return false;
}
}
return true;
}
public boolean removeAll(Collection collection) {
boolean changed = false;
for (Object element : collection) {
if (remove(element)) {
changed = true;
}
}
return changed;
}
public void clear() {
THashMap.this.clear();
}
public boolean add(E obj) {
throw new UnsupportedOperationException();
}
public int size() {
return THashMap.this.size();
}
public Object[] toArray() {
Object[] result = new Object[size()];
Iterator e = iterator();
for (int i = 0; e.hasNext(); i++) {
result[i] = e.next();
}
return result;
}
public T[] toArray(T[] a){
int size = size();
if (a.length < size) {
a = (T[]) Array.newInstance(a.getClass().getComponentType(), size);
}
Iterator it = iterator();
Object[] result = a;
for (int i=0; i size) {
a[size] = null;
}
return a;
}
public boolean isEmpty() {
return THashMap.this.isEmpty();
}
public boolean addAll(Collection collection) {
throw new UnsupportedOperationException();
}
public boolean retainAll(Collection collection) {
boolean changed = false;
Iterator i = iterator();
while (i.hasNext()) {
if (! collection.contains(i.next())) {
i.remove();
changed = true;
}
}
return changed;
}
}
/**
* a view onto the keys of the map.
*/
protected class KeyView extends MapBackedView {
KeyView() {
}
@Override
public Iterator iterator() {
return new TObjectHashIterator(THashMap.this);
}
@Override
public boolean removeElement(K key) {
return null != THashMap.this.remove(key);
}
@Override
public boolean containsElement(K key) {
return THashMap.this.contains(key);
}
}
final class Entry implements Map.Entry {
private final K key;
private V val;
private final int index;
Entry(final K key, V value, final int index) {
this.key = key;
val = value;
this.index = index;
}
public K getKey() {
return key;
}
public V getValue() {
return val;
}
public V setValue(V o) {
if (_values[index] != val) {
throw new ConcurrentModificationException();
}
_values[index] = o;
V prev = val; // need to return previous value
val = o; // update this entry's value, in case
// setValue is called again
return prev;
}
}
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) {
K key = (K) stream.readObject();
V val = (V) stream.readObject();
put(key, val);
}
}
public String toString() {
final StringBuilder sb = new StringBuilder();
forEachEntry(new TObjectObjectProcedure() {
public boolean execute(K key, V value) {
if (sb.length() != 0) {
sb.append(',').append(' ');
}
sb.append(key == this ? "(this Map)" : key);
sb.append('=');
sb.append(value == this ? "(this Map)" : value);
return true;
}
});
sb.append('}');
sb.insert(0, '{');
return sb.toString();
}
} // THashMap