You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by bi...@apache.org on 2010/01/15 13:30:58 UTC
svn commit: r899612 - in /lucene/mahout/trunk/math/src: main/
main/java-templates/org/apache/mahout/math/map/
test/java-templates/org/apache/mahout/math/map/
Author: bimargulies
Date: Fri Jan 15 12:30:58 2010
New Revision: 899612
URL: http://svn.apache.org/viewvc?rev=899612&view=rev
Log:
MAHOUT-248: hash maps from object to primitive
Added:
lucene/mahout/trunk/math/src/main/ObjectValueTypeProcedure.java.t
lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/AbstractObjectValueTypeMap.java.t
lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMap.java.t
lucene/mahout/trunk/math/src/test/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMapTest.java.t
Modified:
lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenKeyTypeObjectHashMap.java.t
Added: lucene/mahout/trunk/math/src/main/ObjectValueTypeProcedure.java.t
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/math/src/main/ObjectValueTypeProcedure.java.t?rev=899612&view=auto
==============================================================================
--- lucene/mahout/trunk/math/src/main/ObjectValueTypeProcedure.java.t (added)
+++ lucene/mahout/trunk/math/src/main/ObjectValueTypeProcedure.java.t Fri Jan 15 12:30:58 2010
@@ -0,0 +1,49 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.mahout.math.function;
+
+/*
+Copyright 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.
+*/
+
+/**
+ * Interface that represents a procedure object: a procedure that takes two arguments and does not return a value.
+ *
+ */
+public interface Object${valueTypeCap}Procedure<T> {
+
+ /**
+ * Applies a procedure to two arguments. Optionally can return a boolean flag to inform the object calling the
+ * procedure.
+ *
+ * <p>Example: forEach() methods often use procedure objects. To signal to a forEach() method whether iteration should
+ * continue normally or terminate (because for example a matching element has been found), a procedure can return
+ * <tt>false</tt> to indicate termination and <tt>true</tt> to indicate continuation.
+ *
+ * @param first first argument passed to the procedure.
+ * @param second second argument passed to the procedure.
+ * @return a flag to inform the object calling the procedure.
+ */
+ boolean apply(T first, ${valueType} second);
+}
Added: lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/AbstractObjectValueTypeMap.java.t
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/AbstractObjectValueTypeMap.java.t?rev=899612&view=auto
==============================================================================
--- lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/AbstractObjectValueTypeMap.java.t (added)
+++ lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/AbstractObjectValueTypeMap.java.t Fri Jan 15 12:30:58 2010
@@ -0,0 +1,478 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+Copyright � 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 org.apache.mahout.math.map;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.mahout.math.Sorting;
+import org.apache.mahout.math.Swapper;
+import org.apache.mahout.math.function.Object${valueTypeCap}Procedure;
+import org.apache.mahout.math.function.ObjectProcedure;
+import org.apache.mahout.math.list.${valueTypeCap}ArrayList;
+import org.apache.mahout.math.function.IntComparator;
+#if (${valueTypeFloating} == 'true')
+import org.apache.mahout.math.function.${valueTypeCap}Function;
+#end
+
+public abstract class AbstractObject${valueTypeCap}Map<T> extends AbstractMap {
+
+ /**
+ * Returns <tt>true</tt> if the receiver contains the specified key.
+ *
+ * @return <tt>true</tt> if the receiver contains the specified key.
+ */
+ public boolean containsKey(final T key) {
+ return !forEachKey(
+ new ObjectProcedure<T>() {
+ @Override
+ public boolean apply(T iterKey) {
+ return (key != iterKey);
+ }
+ }
+ );
+ }
+
+ /**
+ * Returns <tt>true</tt> if the receiver contains the specified value.
+ *
+ * @return <tt>true</tt> if the receiver contains the specified value.
+ */
+ public boolean containsValue(final ${valueType} value) {
+ return !forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T iterKey, ${valueType} iterValue) {
+ return (value != iterValue);
+ }
+ }
+ );
+ }
+
+ /**
+ * Returns a deep copy of the receiver; uses <code>clone()</code> and casts the result.
+ *
+ * @return a deep copy of the receiver.
+ */
+ @SuppressWarnings("unchecked") // seemingly unavoidable.
+ public AbstractObject${valueTypeCap}Map<T> copy() {
+ return (AbstractObject${valueTypeCap}Map<T>) clone();
+ }
+
+ /**
+ * Compares the specified object with this map for equality. Returns <tt>true</tt> if the given object is also a map
+ * and the two maps represent the same mappings. More formally, two maps <tt>m1</tt> and <tt>m2</tt> represent the
+ * same mappings iff
+ * <pre>
+ * m1.forEachPair(
+ * new Object${valueTypeCap}Procedure<T>() {
+ * public boolean apply(T key, ${valueType} value) {
+ * return m2.containsKey(key) && m2.get(key) == value;
+ * }
+ * }
+ * )
+ * &&
+ * m2.forEachPair(
+ * new Object${valueTypeCap}Procedure<T>() {
+ * public boolean apply(T key, ${valueType} value) {
+ * return m1.containsKey(key) && m1.get(key) == value;
+ * }
+ * }
+ * );
+ * </pre>
+ *
+ * This implementation first checks if the specified object is this map; if so it returns <tt>true</tt>. 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
+ * <tt>false</tt>. If so, it applies the iteration as described above.
+ *
+ * @param obj object to be compared for equality with this map.
+ * @return <tt>true</tt> if the specified object is equal to this map.
+ */
+ @SuppressWarnings("unchecked")
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+
+ if (!(obj instanceof AbstractObject${valueTypeCap}Map)) {
+ return false;
+ }
+ final AbstractObject${valueTypeCap}Map other = (AbstractObject${valueTypeCap}Map) obj;
+ if (other.size() != size()) {
+ return false;
+ }
+
+ return
+ forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T key, ${valueType} value) {
+ return other.containsKey(key) && other.get(key) == value;
+ }
+ }
+ )
+ &&
+ other.forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T key, ${valueType} 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 <i>can</i> be expressed
+ * in terms of this method (most methods can) <i>must guarantee</i> to use the <i>same</i> order defined by this
+ * method, even if it is no particular order. This is necessary so that, for example, methods <tt>keys</tt> and
+ * <tt>values</tt> will yield association pairs, not two uncorrelated lists.
+ *
+ * @param procedure the procedure to be applied. Stops iteration if the procedure returns <tt>false</tt>, otherwise
+ * continues.
+ * @return <tt>false</tt> if the procedure stopped before all keys where iterated over, <tt>true</tt> otherwise.
+ */
+ public abstract boolean forEachKey(ObjectProcedure<T> procedure);
+
+ /**
+ * Applies a procedure to each (key,value) pair of the receiver, if any. Iteration order is guaranteed to be
+ * <i>identical</i> to the order used by method {@link #forEachKey(IntProcedure)}.
+ *
+ * @param procedure the procedure to be applied. Stops iteration if the procedure returns <tt>false</tt>, otherwise
+ * continues.
+ * @return <tt>false</tt> if the procedure stopped before all keys where iterated over, <tt>true</tt> otherwise.
+ */
+ public boolean forEachPair(final Object${valueTypeCap}Procedure<T> procedure) {
+ return forEachKey(
+ new ObjectProcedure<T>() {
+ @Override
+ public boolean apply(T 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; <tt>0</tt> if no such key is present.
+ */
+ public abstract ${valueType} get(T key);
+
+ /**
+ * Returns a list filled with all keys contained in the receiver. The returned list has a size that equals
+ * <tt>this.size()</tt>. Iteration order is guaranteed to be <i>identical</i> to the order used by method {@link
+ * #forEachKey(IntProcedure)}. <p> This method can be used to iterate over the keys of the receiver.
+ *
+ * @return the keys.
+ */
+ public List<T> keys() {
+ List<T> list = new ArrayList<T>(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 <tt>this.size()</tt>. Iteration order is guaranteed to
+ * be <i>identical</i> to the order used by method {@link #forEachKey(IntProcedure)}. <p> 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 List<T> list) {
+ list.clear();
+ forEachKey(
+ new ObjectProcedure<T>() {
+ @Override
+ public boolean apply(T key) {
+ list.add(key);
+ return true;
+ }
+ }
+ );
+ }
+
+ /**
+ * Fills all keys <i>sorted ascending by their associated value</i> 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 <tt>this.size()</tt>.
+ * Primary sort criterium is "value", secondary sort criterium is "key". This means that if any two values are equal,
+ * the smaller key comes first. <p> <b>Example:</b> <br> <tt>keys = (8,7,6), values = (1,2,2) --> keyList =
+ * (8,6,7)</tt>
+ *
+ * @param keyList the list to be filled, can have any size.
+ */
+ public void keysSortedByValue(List<T> keyList) {
+ pairsSortedByValue(keyList, new ${valueTypeCap}ArrayList(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 <i>identical</i> to the order used by method {@link #forEachKey(IntProcedure)}.
+ * <p> <b>Example:</b> <br>
+ * <pre>
+ * IntIntProcedure condition = new IntIntProcedure() { // match even keys only
+ * public boolean apply(int key, int value) { return key%2==0; }
+ * }
+ * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt>
+ * </pre>
+ *
+ * @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 Object${valueTypeCap}Procedure<T> condition,
+ final List<T> keyList,
+ final ${valueTypeCap}ArrayList valueList) {
+ keyList.clear();
+ valueList.clear();
+
+ forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T key, ${valueType} value) {
+ if (condition.apply(key, value)) {
+ keyList.add(key);
+ valueList.add(value);
+ }
+ return true;
+ }
+ }
+ );
+ }
+
+ /**
+ * Fills all keys and values <i>sorted ascending by key</i> 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 <tt>this.size()</tt>. <p>
+ * <b>Example:</b> <br> <tt>keys = (8,7,6), values = (1,2,2) --> keyList = (6,7,8), valueList = (2,2,1)</tt>
+ *
+ * @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.
+ */
+ @SuppressWarnings("unchecked")
+ public void pairsSortedByKey(List<T> keyList, ${valueTypeCap}ArrayList valueList) {
+ keys(keyList);
+ if (keyList.size() == 0) {
+ return;
+ }
+ T k = keyList.get(0);
+ // some people would demand a more complex type hierarchy here ...
+ if (!(k instanceof Comparable)) {
+ throw new UnsupportedOperationException("The key type for this map does not implement comparable");
+ }
+ // go raw
+ List rawKeyList = keyList;
+ Collections.sort(rawKeyList);
+ valueList.setSize(keyList.size());
+ for (int i = keyList.size(); --i >= 0;) {
+ valueList.setQuick(i, get(keyList.get(i)));
+ }
+ }
+
+ /**
+ * Fills all keys and values <i>sorted ascending by value</i> 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 <tt>this.size()</tt>.
+ * Primary sort criterium is "value", secondary sort criterium is "key". This means that if any two values are equal,
+ * the smaller key comes first. <p> <b>Example:</b> <br> <tt>keys = (8,7,6), values = (1,2,2) --> keyList = (8,6,7),
+ * valueList = (1,2,2)</tt>
+ *
+ * @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 List<T> keyList, ${valueTypeCap}ArrayList valueList) {
+ keys(keyList);
+ values(valueList);
+
+ final ${valueType}[] v = valueList.elements();
+ Swapper swapper = new Swapper() {
+ @Override
+ public void swap(int a, int b) {
+ ${valueType} t1 = v[a];
+ v[a] = v[b];
+ v[b] = t1;
+ T t2 = keyList.get(a);
+ keyList.set(a, keyList.get(b));
+ keyList.set(b, t2);
+ }
+ };
+
+ IntComparator comp = new IntComparator() {
+ @Override
+ public int compare(int a, int b) {
+ return v[a] < v[b] ? -1 : v[a] > v[b] ? 1 : 0;
+ }
+ };
+
+ Sorting.quickSort(0, keyList.size(), comp, swapper);
+ }
+
+ /**
+ * Associates the given key with the given value. Replaces any old <tt>(key,someOtherValue)</tt> association, if
+ * existing.
+ *
+ * @param key the key the value shall be associated with.
+ * @param value the value to be associated.
+ * @return <tt>true</tt> if the receiver did not already contain such a key; <tt>false</tt> if the receiver did
+ * already contain such a key - the new value has now replaced the formerly associated value.
+ */
+ public abstract boolean put(T key, ${valueType} 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 <tt>true</tt> if the receiver contained the specified key, <tt>false</tt> otherwise.
+ */
+ public abstract boolean removeKey(T key);
+
+ /**
+ * Returns a string representation of the receiver, containing the String representation of each key-value pair,
+ * sorted ascending by key.
+ */
+ public String toString() {
+ List<T> theKeys = keys();
+
+ StringBuilder buf = new StringBuilder();
+ buf.append('[');
+ int maxIndex = theKeys.size() - 1;
+ for (int i = 0; i <= maxIndex; i++) {
+ T 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() {
+ List<T> theKeys = new ArrayList<T>();
+ keysSortedByValue(theKeys);
+
+ StringBuilder buf = new StringBuilder();
+ buf.append('[');
+ int maxIndex = theKeys.size() - 1;
+ for (int i = 0; i <= maxIndex; i++) {
+ T 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
+ * <tt>this.size()</tt>. Iteration order is guaranteed to be <i>identical</i> to the order used by method {@link
+ * #forEachKey(IntProcedure)}. <p> This method can be used to iterate over the values of the receiver.
+ *
+ * @return the values.
+ */
+ public ${valueTypeCap}ArrayList values() {
+ ${valueTypeCap}ArrayList list = new ${valueTypeCap}ArrayList(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 <tt>this.size()</tt>. Iteration order is guaranteed to
+ * be <i>identical</i> to the order used by method {@link #forEachKey(IntProcedure)}. <p> 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 ${valueTypeCap}ArrayList list) {
+ list.clear();
+ forEachKey(
+ new ObjectProcedure<T>() {
+ @Override
+ public boolean apply(T key) {
+ list.add(get(key));
+ return true;
+ }
+ }
+ );
+ }
+
+ #if (${valueTypeFloating} == 'true')
+ /**
+ * Assigns the result of a function to each value; <tt>v[i] = function(v[i])</tt>.
+ *
+ * @param function a function object taking as argument the current association's value.
+ */
+ public void assign(final ${valueTypeCap}Function function) {
+ copy().forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T key, ${valueType} value) {
+ put(key, function.apply(value));
+ return true;
+ }
+ }
+ );
+ }
+
+ /**
+ * Clears the receiver, then adds all (key,value) pairs of <tt>other</tt>values to it.
+ *
+ * @param other the other map to be copied into the receiver.
+ */
+ public void assign(AbstractObject${valueTypeCap}Map<T> other) {
+ clear();
+ other.forEachPair(
+ new Object${valueTypeCap}Procedure<T>() {
+ @Override
+ public boolean apply(T key, ${valueType} value) {
+ put(key, value);
+ return true;
+ }
+ }
+ );
+ }
+ #end
+}
Modified: lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenKeyTypeObjectHashMap.java.t
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenKeyTypeObjectHashMap.java.t?rev=899612&r1=899611&r2=899612&view=diff
==============================================================================
--- lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenKeyTypeObjectHashMap.java.t (original)
+++ lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenKeyTypeObjectHashMap.java.t Fri Jan 15 12:30:58 2010
@@ -529,8 +529,8 @@
/**
* 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 <tt>this.size()</tt>. Iteration order is guaranteed to
- * be <i>identical</i> to the order used by method {@link #forEachKey(${keyTypeCap}Procedure)}. <p> This method can be used to
+ * call returns the specified list has a new size that equals <tt>this.size()</tt>.
+ * <p> This method can be used to
* iterate over the values of the receiver.
*
* @param list the list to be filled, can have any size.
Added: lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMap.java.t
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMap.java.t?rev=899612&view=auto
==============================================================================
--- lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMap.java.t (added)
+++ lucene/mahout/trunk/math/src/main/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMap.java.t Fri Jan 15 12:30:58 2010
@@ -0,0 +1,580 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+Copyright � 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 org.apache.mahout.math.map;
+
+import java.util.Arrays;
+import java.util.List;
+
+import org.apache.mahout.math.function.Object${valueTypeCap}Procedure;
+import org.apache.mahout.math.function.ObjectProcedure;
+import org.apache.mahout.math.list.${valueTypeCap}ArrayList;
+
+/**
+ * Open hash map from Object keys to ${valueType} values.
+ **/
+public class OpenObject${valueTypeCap}HashMap<T> extends AbstractObject${valueTypeCap}Map<T> {
+ protected static final byte FREE = 0;
+ protected static final byte FULL = 1;
+ protected static final byte REMOVED = 2;
+ protected static final Object NO_KEY_VALUE = null;
+
+ /** The hash table keys. */
+ protected Object[] table;
+
+ /** The hash table values. */
+ protected ${valueType}[] values;
+
+ /** The state of each hash table entry (FREE, FULL, REMOVED). */
+ protected byte[] state;
+
+ /** The number of table entries in state==FREE. */
+ protected int freeEntries;
+
+
+ /** Constructs an empty map with default capacity and default load factors. */
+ public OpenObject${valueTypeCap}HashMap() {
+ this(defaultCapacity);
+ }
+
+ /**
+ * Constructs an empty map with the specified initial capacity and default load factors.
+ *
+ * @param initialCapacity the initial capacity of the map.
+ * @throws IllegalArgumentException if the initial capacity is less than zero.
+ */
+ public OpenObject${valueTypeCap}HashMap(int initialCapacity) {
+ this(initialCapacity, defaultMinLoadFactor, defaultMaxLoadFactor);
+ }
+
+ /**
+ * Constructs an empty map with the specified initial capacity and the specified minimum and maximum load factor.
+ *
+ * @param initialCapacity the initial capacity.
+ * @param minLoadFactor the minimum load factor.
+ * @param maxLoadFactor the maximum load factor.
+ * @throws IllegalArgumentException if <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) ||
+ * (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >=
+ * maxLoadFactor)</tt>.
+ */
+ public OpenObject${valueTypeCap}HashMap(int initialCapacity, double minLoadFactor, double maxLoadFactor) {
+ setUp(initialCapacity, minLoadFactor, maxLoadFactor);
+ }
+
+ /** Removes all (key,value) associations from the receiver. Implicitly calls <tt>trimToSize()</tt>. */
+ @Override
+ public void clear() {
+ Arrays.fill(this.state, 0, state.length - 1, FREE);
+ distinct = 0;
+ freeEntries = table.length; // delta
+ trimToSize();
+ }
+
+ /**
+ * Returns a deep copy of the receiver.
+ *
+ * @return a deep copy of the receiver.
+ */
+ @Override
+ @SuppressWarnings("unchecked")
+ public Object clone() {
+ OpenObject${valueTypeCap}HashMap copy = (OpenObject${valueTypeCap}HashMap) super.clone();
+ copy.table = copy.table.clone();
+ copy.values = copy.values.clone();
+ copy.state = copy.state.clone();
+ return copy;
+ }
+
+ /**
+ * Returns <tt>true</tt> if the receiver contains the specified key.
+ *
+ * @return <tt>true</tt> if the receiver contains the specified key.
+ */
+ @Override
+ public boolean containsKey(T key) {
+ return indexOfKey(key) >= 0;
+ }
+
+ /**
+ * Returns <tt>true</tt> if the receiver contains the specified value.
+ *
+ * @return <tt>true</tt> if the receiver contains the specified value.
+ */
+ @Override
+ public boolean containsValue(${valueType} value) {
+ return indexOfValue(value) >= 0;
+ }
+
+ /**
+ * Ensures that the receiver can hold at least the specified number of associations without needing to allocate new
+ * internal memory. If necessary, allocates new internal memory and increases the capacity of the receiver. <p> This
+ * method never need be called; it is for performance tuning only. Calling this method before <tt>put()</tt>ing a
+ * large number of associations boosts performance, because the receiver will grow only once instead of potentially
+ * many times and hash collisions get less probable.
+ *
+ * @param minCapacity the desired minimum capacity.
+ */
+ @Override
+ public void ensureCapacity(int minCapacity) {
+ if (table.length < minCapacity) {
+ int newCapacity = nextPrime(minCapacity);
+ rehash(newCapacity);
+ }
+ }
+
+ /**
+ * 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 <i>can</i> be expressed
+ * in terms of this method (most methods can) <i>must guarantee</i> to use the <i>same</i> order defined by this
+ * method, even if it is no particular order. This is necessary so that, for example, methods <tt>keys</tt> and
+ * <tt>values</tt> will yield association pairs, not two uncorrelated lists.
+ *
+ * @param procedure the procedure to be applied. Stops iteration if the procedure returns <tt>false</tt>, otherwise
+ * continues.
+ * @return <tt>false</tt> if the procedure stopped before all keys where iterated over, <tt>true</tt> otherwise.
+ */
+ @Override
+ @SuppressWarnings("unchecked")
+ public boolean forEachKey(ObjectProcedure<T> procedure) {
+ for (int i = table.length; i-- > 0;) {
+ if (state[i] == FULL) {
+ if (!procedure.apply((T)table[i])) {
+ return false;
+ }
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Applies a procedure to each (key,value) pair of the receiver, if any. Iteration order is guaranteed to be
+ * <i>identical</i> to the order used by method {@link #forEachKey(ObjectProcedure)}.
+ *
+ * @param procedure the procedure to be applied. Stops iteration if the procedure returns <tt>false</tt>, otherwise
+ * continues.
+ * @return <tt>false</tt> if the procedure stopped before all keys where iterated over, <tt>true</tt> otherwise.
+ */
+ @Override
+ @SuppressWarnings("unchecked")
+ public boolean forEachPair(Object${valueTypeCap}Procedure<T> procedure) {
+ for (int i = table.length; i-- > 0;) {
+ if (state[i] == FULL) {
+ if (!procedure.apply((T)table[i], values[i])) {
+ return false;
+ }
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Returns the value associated with the specified key. It is often a good idea to first check with {@link
+ * #containsKey(double)} 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; <tt>0</tt> if no such key is present.
+ */
+ @Override
+ public ${valueType} get(T key) {
+ int i = indexOfKey(key);
+ if (i < 0) {
+ return 0;
+ } //not contained
+ return values[i];
+ }
+
+ /**
+ * @param key the key to be added to the receiver.
+ * @return the index where the key would need to be inserted, if it is not already contained. Returns -index-1 if the
+ * key is already contained at slot index. Therefore, if the returned index < 0, then it is already contained
+ * at slot -index-1. If the returned index >= 0, then it is NOT already contained and should be inserted at
+ * slot index.
+ */
+ protected int indexOfInsertion(T key) {
+ Object[] tab = table;
+ byte[] stat = state;
+ int length = tab.length;
+
+ int hash = HashFunctions.hash(key) & 0x7FFFFFFF;
+ int i = hash % length;
+ int decrement = hash % (length - 2); // double hashing, see http://www.eece.unm.edu/faculty/heileman/hash/node4.html
+ //int decrement = (hash / length) % length;
+ if (decrement == 0) {
+ decrement = 1;
+ }
+
+ // stop if we find a removed or free slot, or if we find the key itself
+ // do NOT skip over removed slots (yes, open addressing is like that...)
+ while (stat[i] == FULL && tab[i] != key) {
+ i -= decrement;
+ //hashCollisions++;
+ if (i < 0) {
+ i += length;
+ }
+ }
+
+ if (stat[i] == REMOVED) {
+ // stop if we find a free slot, or if we find the key itself.
+ // do skip over removed slots (yes, open addressing is like that...)
+ // assertion: there is at least one FREE slot.
+ int j = i;
+ while (stat[i] != FREE && (stat[i] == REMOVED || tab[i] != key)) {
+ i -= decrement;
+ //hashCollisions++;
+ if (i < 0) {
+ i += length;
+ }
+ }
+ if (stat[i] == FREE) {
+ i = j;
+ }
+ }
+
+
+ if (stat[i] == FULL) {
+ // key already contained at slot i.
+ // return a negative number identifying the slot.
+ return -i - 1;
+ }
+ // not already contained, should be inserted at slot i.
+ // return a number >= 0 identifying the slot.
+ return i;
+ }
+
+ /**
+ * @param key the key to be searched in the receiver.
+ * @return the index where the key is contained in the receiver, returns -1 if the key was not found.
+ */
+ protected int indexOfKey(T key) {
+ Object[] tab = table;
+ byte[] stat = state;
+ int length = tab.length;
+
+ int hash = HashFunctions.hash(key) & 0x7FFFFFFF;
+ int i = hash % length;
+ int decrement = hash % (length - 2); // double hashing, see http://www.eece.unm.edu/faculty/heileman/hash/node4.html
+ //int decrement = (hash / length) % length;
+ if (decrement == 0) {
+ decrement = 1;
+ }
+
+ // stop if we find a free slot, or if we find the key itself.
+ // do skip over removed slots (yes, open addressing is like that...)
+ while (stat[i] != FREE && (stat[i] == REMOVED || tab[i] != key)) {
+ i -= decrement;
+ //hashCollisions++;
+ if (i < 0) {
+ i += length;
+ }
+ }
+
+ if (stat[i] == FREE) {
+ return -1;
+ } // not found
+ return i; //found, return index where key is contained
+ }
+
+ /**
+ * @param value the value to be searched in the receiver.
+ * @return the index where the value is contained in the receiver, returns -1 if the value was not found.
+ */
+ protected int indexOfValue(${valueType} value) {
+ ${valueType}[] val = values;
+ byte[] stat = state;
+
+ for (int i = stat.length; --i >= 0;) {
+ if (stat[i] == FULL && val[i] == value) {
+ return i;
+ }
+ }
+
+ return -1; // not found
+ }
+
+ /**
+ * 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 <tt>this.size()</tt>.
+ * This method can be used
+ * to iterate over the keys of the receiver.
+ *
+ * @param list the list to be filled, can have any size.
+ */
+ @Override
+ @SuppressWarnings("unchecked")
+ public void keys(List<T> list) {
+ list.clear();
+
+
+ Object [] tab = table;
+ byte[] stat = state;
+
+ for (int i = tab.length; i-- > 0;) {
+ if (stat[i] == FULL) {
+ list.add((T)tab[i]);
+ }
+ }
+ }
+
+ /**
+ * 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.
+ * <p> <b>Example:</b> <br>
+ * <pre>
+ * Object${valueTypeCap}Procedure<T> condition = new Object${valueTypeCap}Procedure<T>() { // match even values only
+ * public boolean apply(T key, ${valueType} value) { return value%2==0; }
+ * }
+ * keys = (8,7,6), values = (1,2,2) --> keyList = (6,8), valueList = (2,1)</tt>
+ * </pre>
+ *
+ * @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.
+ */
+ @Override
+ @SuppressWarnings("unchecked")
+ public void pairsMatching(Object${valueTypeCap}Procedure<T> condition,
+ List<T> keyList,
+ ${valueTypeCap}ArrayList valueList) {
+ keyList.clear();
+ valueList.clear();
+
+ for (int i = table.length; i-- > 0;) {
+ if (state[i] == FULL && condition.apply((T)table[i], values[i])) {
+ keyList.add((T)table[i]);
+ valueList.add(values[i]);
+ }
+ }
+ }
+
+ /**
+ * Associates the given key with the given value. Replaces any old <tt>(key,someOtherValue)</tt> association, if
+ * existing.
+ *
+ * @param key the key the value shall be associated with.
+ * @param value the value to be associated.
+ * @return <tt>true</tt> if the receiver did not already contain such a key; <tt>false</tt> if the receiver did
+ * already contain such a key - the new value has now replaced the formerly associated value.
+ */
+ @Override
+ public boolean put(T key, ${valueType} value) {
+ int i = indexOfInsertion(key);
+ if (i < 0) { //already contained
+ i = -i - 1;
+ this.values[i] = value;
+ return false;
+ }
+
+ if (this.distinct > this.highWaterMark) {
+ int newCapacity = chooseGrowCapacity(this.distinct + 1, this.minLoadFactor, this.maxLoadFactor);
+ /*
+ log.info("grow rehashing ");
+ log.info("at distinct="+distinct+", capacity="+table.length+" to newCapacity="+newCapacity+" ...");
+ */
+ rehash(newCapacity);
+ return put(key, value);
+ }
+
+ this.table[i] = key;
+ this.values[i] = value;
+ if (this.state[i] == FREE) {
+ this.freeEntries--;
+ }
+ this.state[i] = FULL;
+ this.distinct++;
+
+ if (this.freeEntries < 1) { //delta
+ int newCapacity = chooseGrowCapacity(this.distinct + 1, this.minLoadFactor, this.maxLoadFactor);
+ rehash(newCapacity);
+ }
+
+ return true;
+ }
+
+ /**
+ * Rehashes the contents of the receiver into a new table with a smaller or larger capacity. This method is called
+ * automatically when the number of keys in the receiver exceeds the high water mark or falls below the low water
+ * mark.
+ */
+ @SuppressWarnings("unchecked")
+ protected void rehash(int newCapacity) {
+ int oldCapacity = table.length;
+ //if (oldCapacity == newCapacity) return;
+
+ Object[] oldTable = table;
+ ${valueType}[] oldValues = values;
+ byte[] oldState = state;
+
+ Object[] newTable = new Object[newCapacity];
+ ${valueType}[] newValues = new ${valueType}[newCapacity];
+ byte[] newState = new byte[newCapacity];
+
+ this.lowWaterMark = chooseLowWaterMark(newCapacity, this.minLoadFactor);
+ this.highWaterMark = chooseHighWaterMark(newCapacity, this.maxLoadFactor);
+
+ this.table = newTable;
+ this.values = newValues;
+ this.state = newState;
+ this.freeEntries = newCapacity - this.distinct; // delta
+
+ for (int i = oldCapacity; i-- > 0;) {
+ if (oldState[i] == FULL) {
+ Object element = oldTable[i];
+ int index = indexOfInsertion((T)element);
+ newTable[index] = element;
+ newValues[index] = oldValues[i];
+ newState[index] = FULL;
+ }
+ }
+ }
+
+ /**
+ * Removes the given key with its associated element from the receiver, if present.
+ *
+ * @param key the key to be removed from the receiver.
+ * @return <tt>true</tt> if the receiver contained the specified key, <tt>false</tt> otherwise.
+ */
+ @Override
+ public boolean removeKey(T key) {
+ int i = indexOfKey(key);
+ if (i < 0) {
+ return false;
+ } // key not contained
+
+ this.state[i] = REMOVED;
+ //this.values[i]=0; // delta
+ this.distinct--;
+
+ if (this.distinct < this.lowWaterMark) {
+ int newCapacity = chooseShrinkCapacity(this.distinct, this.minLoadFactor, this.maxLoadFactor);
+ /*
+ if (table.length != newCapacity) {
+ log.info("shrink rehashing ");
+ log.info("at distinct="+distinct+", capacity="+table.length+" to newCapacity="+newCapacity+" ...");
+ }
+ */
+ rehash(newCapacity);
+ }
+
+ return true;
+ }
+
+ /**
+ * Initializes the receiver.
+ *
+ * @param initialCapacity the initial capacity of the receiver.
+ * @param minLoadFactor the minLoadFactor of the receiver.
+ * @param maxLoadFactor the maxLoadFactor of the receiver.
+ * @throws IllegalArgumentException if <tt>initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) ||
+ * (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >=
+ * maxLoadFactor)</tt>.
+ */
+ @Override
+ protected void setUp(int initialCapacity, double minLoadFactor, double maxLoadFactor) {
+ int capacity = initialCapacity;
+ super.setUp(capacity, minLoadFactor, maxLoadFactor);
+ capacity = nextPrime(capacity);
+ if (capacity == 0) {
+ capacity = 1;
+ } // open addressing needs at least one FREE slot at any time.
+
+ this.table = new Object[capacity];
+ this.values = new ${valueType}[capacity];
+ this.state = new byte[capacity];
+
+ // memory will be exhausted long before this pathological case happens, anyway.
+ this.minLoadFactor = minLoadFactor;
+ if (capacity == PrimeFinder.largestPrime) {
+ this.maxLoadFactor = 1.0;
+ } else {
+ this.maxLoadFactor = maxLoadFactor;
+ }
+
+ this.distinct = 0;
+ this.freeEntries = capacity; // delta
+
+ // lowWaterMark will be established upon first expansion.
+ // establishing it now (upon instance construction) would immediately make the table shrink upon first put(...).
+ // After all the idea of an "initialCapacity" implies violating lowWaterMarks when an object is young.
+ // See ensureCapacity(...)
+ this.lowWaterMark = 0;
+ this.highWaterMark = chooseHighWaterMark(capacity, this.maxLoadFactor);
+ }
+
+ /**
+ * Trims the capacity of the receiver to be the receiver's current size. Releases any superfluous internal memory. An
+ * application can use this operation to minimize the storage of the receiver.
+ */
+ @Override
+ public void trimToSize() {
+ // * 1.2 because open addressing's performance exponentially degrades beyond that point
+ // so that even rehashing the table can take very long
+ int newCapacity = nextPrime((int) (1 + 1.2 * size()));
+ if (table.length > newCapacity) {
+ rehash(newCapacity);
+ }
+ }
+
+ /**
+ * 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 <tt>this.size()</tt>.
+ * <p> This method can be used
+ * to iterate over the values of the receiver.
+ *
+ * @param list the list to be filled, can have any size.
+ */
+ @Override
+ public void values(${valueTypeCap}ArrayList list) {
+ list.setSize(distinct);
+ ${valueType}[] elements = list.elements();
+
+ ${valueType}[] val = values;
+ byte[] stat = state;
+
+ int j = 0;
+ for (int i = stat.length; i-- > 0;) {
+ if (stat[i] == FULL) {
+ elements[j++] = val[i];
+ }
+ }
+ }
+
+ /**
+ * Access for unit tests.
+ * @param capacity
+ * @param minLoadFactor
+ * @param maxLoadFactor
+ */
+ void getInternalFactors(int[] capacity,
+ double[] minLoadFactor,
+ double[] maxLoadFactor) {
+ capacity[0] = table.length;
+ minLoadFactor[0] = this.minLoadFactor;
+ maxLoadFactor[0] = this.maxLoadFactor;
+ }
+}
Added: lucene/mahout/trunk/math/src/test/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMapTest.java.t
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/math/src/test/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMapTest.java.t?rev=899612&view=auto
==============================================================================
--- lucene/mahout/trunk/math/src/test/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMapTest.java.t (added)
+++ lucene/mahout/trunk/math/src/test/java-templates/org/apache/mahout/math/map/OpenObjectValueTypeHashMapTest.java.t Fri Jan 15 12:30:58 2010
@@ -0,0 +1,426 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+#if (${valueTypeFloating} == 'true')
+#set ($valueEpsilon = ", (${valueType})0.000001")
+#else
+#set ($valueEpsilon = "")
+#end
+
+package org.apache.mahout.math.map;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.mahout.math.function.Object${valueTypeCap}Procedure;
+import org.apache.mahout.math.function.ObjectProcedure;
+import org.apache.mahout.math.list.${valueTypeCap}ArrayList;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class OpenObject${valueTypeCap}HashMapTest extends Assert {
+
+ private static class NotComparableKey {
+ protected int x;
+
+ public NotComparableKey(int x) {
+ this.x = x;
+ }
+
+ @Override
+ public String toString() {
+ return "[k " + x + " ]";
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + x;
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) return true;
+ if (obj == null) return false;
+ if (getClass() != obj.getClass()) return false;
+ NotComparableKey other = (NotComparableKey) obj;
+ if (x != other.x) return false;
+ return true;
+ }
+ }
+
+ private static class ComparableKey extends NotComparableKey
+ implements Comparable<ComparableKey> {
+ public ComparableKey(int x) {
+ super(x);
+ }
+
+ @Override
+ public String toString() {
+ return "[ck " + x + " ]";
+ }
+
+ @Override
+ public int compareTo(ComparableKey o) {
+
+ return (int)(x - o.x);
+ }
+ }
+
+ private NotComparableKey[] ncKeys = {
+ new NotComparableKey(101),
+ new NotComparableKey(99),
+ new NotComparableKey(2),
+ new NotComparableKey(3),
+ new NotComparableKey(4),
+ new NotComparableKey(5)
+ };
+
+ private ComparableKey[] cKeys = {
+ new ComparableKey(101),
+ new ComparableKey(99),
+ new ComparableKey(2),
+ new ComparableKey(3),
+ new ComparableKey(4),
+ new ComparableKey(5)
+ };
+
+
+ @Test
+ public void testConstructors() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ int[] capacity = new int[1];
+ double[] minLoadFactor = new double[1];
+ double[] maxLoadFactor = new double[1];
+
+ map.getInternalFactors(capacity, minLoadFactor, maxLoadFactor);
+ assertEquals(AbstractMap.defaultCapacity, capacity[0]);
+ assertEquals(AbstractMap.defaultMaxLoadFactor, maxLoadFactor[0], 0.001);
+ assertEquals(AbstractMap.defaultMinLoadFactor, minLoadFactor[0], 0.001);
+ int prime = PrimeFinder.nextPrime(907);
+ map = new OpenObject${valueTypeCap}HashMap<ComparableKey>(prime);
+
+ map.getInternalFactors(capacity, minLoadFactor, maxLoadFactor);
+ assertEquals(prime, capacity[0]);
+ assertEquals(AbstractMap.defaultMaxLoadFactor, maxLoadFactor[0], 0.001);
+ assertEquals(AbstractMap.defaultMinLoadFactor, minLoadFactor[0], 0.001);
+
+ map = new OpenObject${valueTypeCap}HashMap<ComparableKey>(prime, 0.4, 0.8);
+ map.getInternalFactors(capacity, minLoadFactor, maxLoadFactor);
+ assertEquals(prime, capacity[0]);
+ assertEquals(0.4, minLoadFactor[0], 0.001);
+ assertEquals(0.8, maxLoadFactor[0], 0.001);
+ }
+
+ @Test
+ public void testEnsureCapacity() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ int prime = PrimeFinder.nextPrime(907);
+
+ map.ensureCapacity(prime);
+ int[] capacity = new int[1];
+ double[] minLoadFactor = new double[1];
+ double[] maxLoadFactor = new double[1];
+
+ map.getInternalFactors(capacity, minLoadFactor, maxLoadFactor);
+ assertEquals(prime, capacity[0]);
+ }
+
+ @Test
+ public void testClear() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType})11);
+ assertEquals(1, map.size());
+ map.clear();
+ assertEquals(0, map.size());
+ }
+
+ @Test
+ @SuppressWarnings("unchecked")
+ public void testClone() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType})11);
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map2 = (OpenObject${valueTypeCap}HashMap<ComparableKey>) map.clone();
+ map.clear();
+ assertEquals(1, map2.size());
+ }
+
+ @Test
+ public void testContainsKey() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType})11);
+ assertTrue(map.containsKey(cKeys[0]));
+ assertFalse(map.containsKey(cKeys[1]));
+ }
+
+ @Test
+ public void testContainValue() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType})11);
+ assertTrue(map.containsValue((${valueType})11));
+ assertFalse(map.containsValue((${valueType})12));
+ }
+
+ @Test
+ public void testForEachKey() {
+ final List<ComparableKey> keys = new ArrayList<ComparableKey>();
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ map.forEachKey(new ObjectProcedure<ComparableKey>() {
+
+ @Override
+ public boolean apply(ComparableKey element) {
+ keys.add(element);
+ return true;
+ }
+ });
+
+ //2, 3, 1, 0
+ assertEquals(3, keys.size());
+ Collections.sort(keys);
+ assertSame(cKeys[3], keys.get(0));
+ assertSame(cKeys[1], keys.get(1));
+ assertSame(cKeys[0], keys.get(2));
+ }
+
+ private static class Pair implements Comparable<Pair> {
+ ${valueType} v;
+ ComparableKey k;
+
+ Pair(ComparableKey k, ${valueType} v) {
+ this.k = k;
+ this.v = v;
+ }
+
+ @Override
+ public int compareTo(Pair o) {
+ return k.compareTo(o.k);
+ }
+ }
+
+ @Test
+ public void testForEachPair() {
+ final List<Pair> pairs = new ArrayList<Pair>();
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ map.forEachPair(new Object${valueTypeCap}Procedure<ComparableKey>() {
+
+ @Override
+ public boolean apply(ComparableKey first, ${valueType} second) {
+ pairs.add(new Pair(first, second));
+ return true;
+ }
+ });
+
+ Collections.sort(pairs);
+ assertEquals(3, pairs.size());
+ assertEquals((${valueType})14, pairs.get(0).v ${valueEpsilon});
+ assertSame(cKeys[3], pairs.get(0).k);
+ assertEquals((${valueType}) 12, pairs.get(1).v ${valueEpsilon});
+ assertSame(cKeys[1], pairs.get(1).k);
+ assertEquals((${valueType}) 11, pairs.get(2).v ${valueEpsilon});
+ assertSame(cKeys[0], pairs.get(2).k);
+
+ pairs.clear();
+ map.forEachPair(new Object${valueTypeCap}Procedure<ComparableKey>() {
+ int count = 0;
+
+ @Override
+ public boolean apply(ComparableKey first, ${valueType} second) {
+ pairs.add(new Pair(first, second));
+ count++;
+ return count < 2;
+ }
+ });
+
+ assertEquals(2, pairs.size());
+ }
+
+ @Test
+ public void testGet() {
+ OpenObject${valueTypeCap}HashMap<NotComparableKey> map = new OpenObject${valueTypeCap}HashMap<NotComparableKey>();
+ map.put(ncKeys[0], (${valueType}) 11);
+ map.put(ncKeys[1], (${valueType}) 12);
+ assertEquals((${valueType})11, map.get(ncKeys[0]) ${valueEpsilon});
+ }
+
+ @Test
+ public void testKeys() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ List<ComparableKey> keys = new ArrayList<ComparableKey>();
+ map.keys(keys);
+ Collections.sort(keys);
+ assertSame(cKeys[1], keys.get(0));
+ assertSame(cKeys[0], keys.get(1));
+ List<ComparableKey> k2 = map.keys();
+ Collections.sort(k2);
+ assertEquals(keys, k2);
+ }
+
+ @Test
+ public void testPairsMatching() {
+ List<ComparableKey> keyList = new ArrayList<ComparableKey>();
+ ${valueTypeCap}ArrayList valueList = new ${valueTypeCap}ArrayList();
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ map.pairsMatching(new Object${valueTypeCap}Procedure<ComparableKey>() {
+
+ @Override
+ public boolean apply(ComparableKey first, ${valueType} second) {
+ return (second % 2) == 0;
+ }},
+ keyList, valueList);
+ Collections.sort(keyList);
+ valueList.sort();
+ assertEquals(2, keyList.size());
+ assertEquals(2, valueList.size());
+ assertSame(cKeys[3], keyList.get(0));
+ assertSame(cKeys[1], keyList.get(1));
+ assertEquals((${valueType})14, valueList.get(1) ${valueEpsilon});
+ assertEquals((${valueType})12, valueList.get(0) ${valueEpsilon});
+ }
+
+ @Test
+ public void testValues() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ ${valueTypeCap}ArrayList values = new ${valueTypeCap}ArrayList(100);
+ map.values(values);
+ assertEquals(3, values.size());
+ values.sort();
+ assertEquals(11, values.get(0) ${valueEpsilon});
+ assertEquals(12, values.get(1) ${valueEpsilon});
+ assertEquals(14, values.get(2) ${valueEpsilon});
+ }
+
+ // tests of the code in the abstract class
+
+ @Test
+ public void testCopy() {
+ OpenObject${valueTypeCap}HashMap<NotComparableKey> map = new OpenObject${valueTypeCap}HashMap<NotComparableKey>();
+ map.put(ncKeys[0], (${valueType})11);
+ OpenObject${valueTypeCap}HashMap<NotComparableKey> map2 = (OpenObject${valueTypeCap}HashMap<NotComparableKey>) map.copy();
+ map.clear();
+ assertEquals(1, map2.size());
+ }
+
+ @Test
+ public void testEquals() {
+ // since there are no other subclasses of
+ // Abstractxxx available, we have to just test the
+ // obvious.
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map2 = (OpenObject${valueTypeCap}HashMap<ComparableKey>) map.copy();
+ assertTrue(map.equals(map2));
+ assertTrue(map2.equals(map));
+ assertFalse("Hello Sailor".equals(map));
+ assertFalse(map.equals("hello sailor"));
+ map2.removeKey(cKeys[0]);
+ assertFalse(map.equals(map2));
+ assertFalse(map2.equals(map));
+ }
+
+ // keys() tested in testKeys
+
+ @Test
+ public void testKeysSortedByValue() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+ map.removeKey(cKeys[2]);
+ List<ComparableKey> keys = new ArrayList<ComparableKey>();
+ map.keysSortedByValue(keys);
+ ComparableKey[] keysArray = keys.toArray(new ComparableKey[keys.size()]);
+ assertArrayEquals(new ComparableKey[] {cKeys[0], cKeys[1], cKeys[3]},
+ keysArray);
+ }
+
+ @Test
+ public void testPairsSortedByKey() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+
+ ${valueTypeCap}ArrayList values = new ${valueTypeCap}ArrayList();
+ List<ComparableKey> keys = new ArrayList<ComparableKey>();
+ map.pairsSortedByKey(keys, values);
+
+ assertEquals(4, keys.size());
+ assertEquals(4, values.size());
+ assertEquals((${valueType}) 13, values.get(0) ${valueEpsilon});
+ assertSame(cKeys[2], keys.get(0));
+ assertEquals((${valueType}) 14, values.get(1) ${valueEpsilon});
+ assertSame(cKeys[3], keys.get(1));
+ assertEquals((${valueType}) 12, values.get(2) ${valueEpsilon});
+ assertSame(cKeys[1], keys.get(2));
+ assertEquals((${valueType}) 11, values.get(3) ${valueEpsilon});
+ assertSame(cKeys[0], keys.get(3));
+ }
+
+ @Test
+ public void testPairsSortedByValue() {
+ OpenObject${valueTypeCap}HashMap<ComparableKey> map = new OpenObject${valueTypeCap}HashMap<ComparableKey>();
+ map.put(cKeys[0], (${valueType}) 11);
+ map.put(cKeys[1], (${valueType}) 12);
+ map.put(cKeys[2], (${valueType}) 13);
+ map.put(cKeys[3], (${valueType}) 14);
+
+ List<ComparableKey> keys = new ArrayList<ComparableKey>();
+ ${valueTypeCap}ArrayList values = new ${valueTypeCap}ArrayList();
+ map.pairsSortedByValue(keys, values);
+ assertEquals((${valueType}) 11, values.get(0) ${valueEpsilon});
+ assertEquals(cKeys[0], keys.get(0));
+ assertEquals((${valueType}) 12, values.get(1) ${valueEpsilon});
+ assertEquals(cKeys[1], keys.get(1));
+ assertEquals((${valueType}) 13, values.get(2) ${valueEpsilon});
+ assertEquals(cKeys[2], keys.get(2));
+ assertEquals((${valueType}) 14, values.get(3) ${valueEpsilon});
+ assertEquals(cKeys[3], keys.get(3));
+ }
+
+ }