cern.colt.map.AbstractIntDoubleMap Maven / Gradle / Ivy
/*
Copyright (c) 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose
is hereby granted without fee, provided that the above copyright notice appear in all copies and
that both that copyright notice and this permission notice appear in supporting documentation.
CERN makes no representations about the suitability of this software for any purpose.
It is provided "as is" without expressed or implied warranty.
*/
package cern.colt.map;
import cern.colt.function.IntDoubleProcedure;
import cern.colt.function.IntProcedure;
import cern.colt.list.DoubleArrayList;
import cern.colt.list.IntArrayList;
/**
Abstract base class for hash maps holding (key,value) associations of type (int-->double).
First see the package summary and javadoc tree view to get the broad picture.
Implementation:
Almost all methods are expressed in terms of {@link #forEachKey(IntProcedure)}.
As such they are fully functional, but inefficient. Override them in subclasses if necessary.
@author [email protected]
@version 1.0, 09/24/99
@see java.util.HashMap
*/
public abstract class AbstractIntDoubleMap extends AbstractMap {
//public static int hashCollisions = 0; // for debug only
/**
* Makes this class non instantiable, but still let's others inherit from it.
*/
protected AbstractIntDoubleMap() {}
/**
Assigns the result of a function to each value; v[i] = function(v[i]).
@param function a function object taking as argument the current association's value.
*/
public void assign(final cern.colt.function.DoubleFunction function) {
copy().forEachPair(
new cern.colt.function.IntDoubleProcedure() {
public boolean apply(int key, double value) {
put(key,function.apply(value));
return true;
}
}
);
}
/**
* Clears the receiver, then adds all (key,value) pairs of othervalues to it.
*
* @param other the other map to be copied into the receiver.
*/
public void assign(AbstractIntDoubleMap other) {
clear();
other.forEachPair(
new IntDoubleProcedure() {
public boolean apply(int key, double value) {
put(key,value);
return true;
}
}
);
}
/**
* Returns true if the receiver contains the specified key.
*
* @return true if the receiver contains the specified key.
*/
public boolean containsKey(final int key) {
return ! forEachKey(
new IntProcedure() {
public boolean apply(int iterKey) {
return (key != iterKey);
}
}
);
}
/**
* Returns true if the receiver contains the specified value.
*
* @return true if the receiver contains the specified value.
*/
public boolean containsValue(final double value) {
return ! forEachPair(
new IntDoubleProcedure() {
public boolean apply(int iterKey, double iterValue) {
return (value != iterValue);
}
}
);
}
/**
* Returns a deep copy of the receiver; uses clone() and casts the result.
*
* @return a deep copy of the receiver.
*/
public AbstractIntDoubleMap copy() {
return (AbstractIntDoubleMap) clone();
}
/**
* Compares the specified object with this map for equality. Returns
* true if the given object is also a map and the two maps
* represent the same mappings. More formally, two maps m1 and
* m2 represent the same mappings iff
*
* m1.forEachPair(
* new IntDoubleProcedure() {
* public boolean apply(int key, double value) {
* return m2.containsKey(key) && m2.get(key) == value;
* }
* }
* )
* &&
* m2.forEachPair(
* new IntDoubleProcedure() {
* public boolean apply(int key, double value) {
* return m1.containsKey(key) && m1.get(key) == value;
* }
* }
* );
*
*
* This implementation first checks if the specified object is this map;
* if so it returns true. Then, it checks if the specified
* object is a map whose size is identical to the size of this set; if
* not, it it returns false. If so, it applies the iteration as described above.
*
* @param obj object to be compared for equality with this map.
* @return true if the specified object is equal to this map.
*/
public boolean equals(Object obj) {
if (obj == this) return true;
if (!(obj instanceof AbstractIntDoubleMap)) return false;
final AbstractIntDoubleMap other = (AbstractIntDoubleMap) obj;
if (other.size() != size()) return false;
return
forEachPair(
new IntDoubleProcedure() {
public boolean apply(int key, double value) {
return other.containsKey(key) && other.get(key) == value;
}
}
)
&&
other.forEachPair(
new IntDoubleProcedure() {
public boolean apply(int key, double value) {
return containsKey(key) && get(key) == value;
}
}
);
}
/**
* Applies a procedure to each key of the receiver, if any.
* Note: Iterates over the keys in no particular order.
* Subclasses can define a particular order, for example, "sorted by key".
* All methods which can be expressed in terms of this method (most methods can) must guarantee to use the same order defined by this method, even if it is no particular order.
* This is necessary so that, for example, methods keys and values will yield association pairs, not two uncorrelated lists.
*
* @param procedure the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues.
* @return false if the procedure stopped before all keys where iterated over, true otherwise.
*/
public abstract boolean forEachKey(IntProcedure procedure);
/**
* Applies a procedure to each (key,value) pair of the receiver, if any.
* Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* @param procedure the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues.
* @return false if the procedure stopped before all keys where iterated over, true otherwise.
*/
public boolean forEachPair(final IntDoubleProcedure procedure) {
return forEachKey(
new IntProcedure() {
public boolean apply(int key) {
return procedure.apply(key,get(key));
}
}
);
}
/**
* Returns the value associated with the specified key.
* It is often a good idea to first check with {@link #containsKey(int)} whether the given key has a value associated or not, i.e. whether there exists an association for the given key or not.
*
* @param key the key to be searched for.
* @return the value associated with the specified key; 0 if no such key is present.
*/
public abstract double get(int key);
/**
* Returns the first key the given value is associated with.
* It is often a good idea to first check with {@link #containsValue(double)} whether there exists an association from a key to this value.
* Search order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* @param value the value to search for.
* @return the first key for which holds get(key) == value;
* returns Integer.MIN_VALUE if no such key exists.
*/
public int keyOf(final double value) {
final int[] foundKey = new int[1];
boolean notFound = forEachPair(
new IntDoubleProcedure() {
public boolean apply(int iterKey, double iterValue) {
boolean found = value == iterValue;
if (found) foundKey[0] = iterKey;
return !found;
}
}
);
if (notFound) return Integer.MIN_VALUE;
return foundKey[0];
}
/**
* Returns a list filled with all keys contained in the receiver.
* The returned list has a size that equals this.size().
* Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* This method can be used to iterate over the keys of the receiver.
*
* @return the keys.
*/
public IntArrayList keys() {
IntArrayList list = new IntArrayList(size());
keys(list);
return list;
}
/**
* Fills all keys contained in the receiver into the specified list.
* Fills the list, starting at index 0.
* After this call returns the specified list has a new size that equals this.size().
* Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* This method can be used to iterate over the keys of the receiver.
*
* @param list the list to be filled, can have any size.
*/
public void keys(final IntArrayList list) {
list.clear();
forEachKey(
new IntProcedure() {
public boolean apply(int key) {
list.add(key);
return true;
}
}
);
}
/**
* Fills all keys sorted ascending by their associated value into the specified list.
* Fills into the list, starting at index 0.
* After this call returns the specified list has a new size that equals this.size().
* Primary sort criterium is "value", secondary sort criterium is "key".
* This means that if any two values are equal, the smaller key comes first.
*
* Example:
*
* keys = (8,7,6), values = (1,2,2) --> keyList = (8,6,7)
*
* @param keyList the list to be filled, can have any size.
*/
public void keysSortedByValue(final IntArrayList keyList) {
pairsSortedByValue(keyList, new DoubleArrayList(size()));
}
/**
Fills all pairs satisfying a given condition into the specified lists.
Fills into the lists, starting at index 0.
After this call returns the specified lists both have a new size, the number of pairs satisfying the condition.
Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
Example:
IntDoubleProcedure condition = new IntDoubleProcedure() { // match even keys only
public boolean apply(int key, double value) { return key%2==0; }
}
keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)
@param condition the condition to be matched. Takes the current key as first and the current value as second argument.
@param keyList the list to be filled with keys, can have any size.
@param valueList the list to be filled with values, can have any size.
*/
public void pairsMatching(final IntDoubleProcedure condition, final IntArrayList keyList, final DoubleArrayList valueList) {
keyList.clear();
valueList.clear();
forEachPair(
new IntDoubleProcedure() {
public boolean apply(int key, double value) {
if (condition.apply(key,value)) {
keyList.add(key);
valueList.add(value);
}
return true;
}
}
);
}
/**
* Fills all keys and values sorted ascending by key into the specified lists.
* Fills into the lists, starting at index 0.
* After this call returns the specified lists both have a new size that equals this.size().
*
* Example:
*
* keys = (8,7,6), values = (1,2,2) --> keyList = (6,7,8), valueList = (2,2,1)
*
* @param keyList the list to be filled with keys, can have any size.
* @param valueList the list to be filled with values, can have any size.
*/
public void pairsSortedByKey(final IntArrayList keyList, final DoubleArrayList valueList) {
keys(keyList);
keyList.sort();
valueList.setSize(keyList.size());
for (int i=keyList.size(); --i >= 0; ) {
valueList.setQuick(i,get(keyList.getQuick(i)));
}
}
/**
* Fills all keys and values sorted ascending by value into the specified lists.
* Fills into the lists, starting at index 0.
* After this call returns the specified lists both have a new size that equals this.size().
* Primary sort criterium is "value", secondary sort criterium is "key".
* This means that if any two values are equal, the smaller key comes first.
*
* Example:
*
* keys = (8,7,6), values = (1,2,2) --> keyList = (8,6,7), valueList = (1,2,2)
*
* @param keyList the list to be filled with keys, can have any size.
* @param valueList the list to be filled with values, can have any size.
*/
public void pairsSortedByValue(final IntArrayList keyList, final DoubleArrayList valueList) {
keys(keyList);
values(valueList);
final int[] k = keyList.elements();
final double[] v = valueList.elements();
cern.colt.Swapper swapper = new cern.colt.Swapper() {
public void swap(int a, int b) {
int t2; double t1;
t1 = v[a]; v[a] = v[b]; v[b] = t1;
t2 = k[a]; k[a] = k[b]; k[b] = t2;
}
};
cern.colt.function.IntComparator comp = new cern.colt.function.IntComparator() {
public int compare(int a, int b) {
return v[a]v[b] ? 1 : (k[a](key,someOtherValue) association, if existing.
*
* @param key the key the value shall be associated with.
* @param value the value to be associated.
* @return true if the receiver did not already contain such a key;
* false if the receiver did already contain such a key - the new value has now replaced the formerly associated value.
*/
public abstract boolean put(int key, double value);
/**
* Removes the given key with its associated element from the receiver, if present.
*
* @param key the key to be removed from the receiver.
* @return true if the receiver contained the specified key, false otherwise.
*/
public abstract boolean removeKey(int key);
/**
* Returns a string representation of the receiver, containing
* the String representation of each key-value pair, sorted ascending by key.
*/
public String toString() {
IntArrayList theKeys = keys();
String tmp = theKeys.toString() + "\n";
theKeys.sort();
StringBuffer buf = new StringBuffer(tmp);
//StringBuffer buf = new StringBuffer();
buf.append("[");
int maxIndex = theKeys.size() - 1;
for (int i = 0; i <= maxIndex; i++) {
int key = theKeys.get(i);
buf.append(String.valueOf(key));
buf.append("->");
buf.append(String.valueOf(get(key)));
if (i < maxIndex) buf.append(", ");
}
buf.append("]");
return buf.toString();
}
/**
* Returns a string representation of the receiver, containing
* the String representation of each key-value pair, sorted ascending by value.
*/
public String toStringByValue() {
IntArrayList theKeys = new IntArrayList();
keysSortedByValue(theKeys);
StringBuffer buf = new StringBuffer();
buf.append("[");
int maxIndex = theKeys.size() - 1;
for (int i = 0; i <= maxIndex; i++) {
int key = theKeys.get(i);
buf.append(String.valueOf(key));
buf.append("->");
buf.append(String.valueOf(get(key)));
if (i < maxIndex) buf.append(", ");
}
buf.append("]");
return buf.toString();
}
/**
* Returns a list filled with all values contained in the receiver.
* The returned list has a size that equals this.size().
* Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* This method can be used to iterate over the values of the receiver.
*
* @return the values.
*/
public DoubleArrayList values() {
DoubleArrayList list = new DoubleArrayList(size());
values(list);
return list;
}
/**
* Fills all values contained in the receiver into the specified list.
* Fills the list, starting at index 0.
* After this call returns the specified list has a new size that equals this.size().
* Iteration order is guaranteed to be identical to the order used by method {@link #forEachKey(IntProcedure)}.
*
* This method can be used to iterate over the values of the receiver.
*
* @param list the list to be filled, can have any size.
*/
public void values(final DoubleArrayList list) {
list.clear();
forEachKey(
new IntProcedure() {
public boolean apply(int key) {
list.add(get(key));
return true;
}
}
);
}
}