Collections Data Structure Java

     * This method never need be called; it is for performance tuning only.
     * Calling this method before put()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.
     */
    public void ensureCapacity(int minCapacity) {
        if (table.length < minCapacity) {
            int newCapacity = nextPrime(minCapacity);
            rehash(newCapacity);
        }
    }
    /**
     * 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; null if
     *         no such key is present.
     */
    public Object get(int key) {
        int i = indexOfKey(key);
        if (i < 0)
            return null; // 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(int key) {
        final int tab[] = table;
        final byte stat[] = state;
        final int length = tab.length;
        final int hash = key & 0x7FFFFFFF;
        int i = hash % length;
        // double hashing, see http://www.eece.unm.edu/faculty/heileman/hash/node4.html
        int decrement = hash % (length - 2);
        // 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(int key) {
        final int tab[] = table;
        final byte stat[] = state;
        final int length = tab.length;
        final int hash = key & 0x7FFFFFFF;
        int i = hash % length;
        // double hashing, see http://www.eece.unm.edu/faculty/heileman/hash/node4.html
        int decrement = hash % (length - 2);
        // 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(Object value) {
        final Object val[] = values;
        final byte stat[] = state;
        for (int i = stat.length; --i >= 0;) {
            if (stat[i] == FULL && val[i] == value)
                return i;
        }
        return -1; // not found
    }
    /**
     * Returns the first key the given value is associated with. It is often a
     * good idea to first check with {@link #containsValue(Object)} whether
     * there exists an association from a key to this value.
     * 
     * @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(Object value) {
        // returns the first key found; there may be more matching keys,
        // however.
        int i = indexOfValue(value);
        if (i < 0)
            return Integer.MIN_VALUE;
        return table[i];
    }
    /**
     * 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().
     * 

     * This method can be used to iterate over the keys of the receiver.
     * 
     * @param list
     *            the list to be filled 
     */
    public int keys(int[] list) {
        int[] tab = table;
        byte[] stat = state;
        if ( list.length < distinct )
            return -1;
        
        int j = 0;
        for (int i = tab.length; i-- > 0;) {
            if (stat[i] == FULL)
                list[j++] = tab[i];
        }
        return distinct;
    }
    /**
     * Associates the given key with the given value. Replaces any old
     * (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 boolean put(int key, Object 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);
            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.
     */
    protected void rehash(int newCapacity) {
        int oldCapacity = table.length;
        // if (oldCapacity == newCapacity) return;
        int oldTable[] = table;
        Object oldValues[] = values;
        byte oldState[] = state;
        int newTable[] = new int[newCapacity];
        Object newValues[] = new Object[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) {
                int element = oldTable[i];
                int index = indexOfInsertion(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 true if the receiver contained the specified key,
     *         false otherwise.
     */
    public boolean removeKey(int key) {
        int i = indexOfKey(key);
        if (i < 0)
            return false; // key not contained
        this.state[i] = REMOVED;
        this.values[i] = null; // delta
        this.distinct--;
        if (this.distinct < this.lowWaterMark) {
            int newCapacity = chooseShrinkCapacity(this.distinct,
                    this.minLoadFactor, this.maxLoadFactor);
            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
     *             initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor).
     */
    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 int[capacity];
        this.values = new Object[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.
     */
    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
     * this.size().
     * 

     * 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(ArrayList list) {
        Object[] val = values;
        byte[] stat = state;
        for (int i = stat.length; i-- > 0;) {
            if (stat[i] == FULL)
                list.add(val[i]);
        }
    }
    
} // end of class IntObjectHashMap
/*
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.
*/
/**
* Abstract base class for hash maps holding objects or primitive data types
* such as int, float, etc. as keys and/or
* values. First see the package summary and
* javadoc tree view to get the broad picture.
* 

* Note that implementations are not synchronized.
* 
* @author wolfgang.hoschek@cern.ch
* @version 1.0, 09/24/99
* @see java.util.HashMap
*/
abstract class AbstractHashMap {
   /**
    * The number of distinct associations in the map; its "size()".
    */
   protected int distinct;
   /**
    * The table capacity c=table.length always satisfies the invariant
    * c * minLoadFactor <= s <= c * maxLoadFactor, where s=size()
    * is the number of associations currently contained. The term "c *
    * minLoadFactor" is called the "lowWaterMark", "c * maxLoadFactor" is
    * called the "highWaterMark". In other words, the table capacity (and
    * proportionally the memory used by this class) oscillates within these
    * constraints. The terms are precomputed and cached to avoid recalculating
    * them each time put(..) or removeKey(...) is called.
    */
   protected int lowWaterMark;
   protected int highWaterMark;
   /**
    * The minimum load factor for the hashtable.
    */
   protected double minLoadFactor;
   /**
    * The maximum load factor for the hashtable.
    */
   protected double maxLoadFactor;
   protected static final int defaultCapacity = 277;
   protected static final double defaultMinLoadFactor = 0.2;
   protected static final double defaultMaxLoadFactor = 0.5;
   /**
    * Makes this class non instantiable, but still let's others inherit from
    * it.
    */
   protected AbstractHashMap() {
   }
   /**
    * Chooses a new prime table capacity optimized for growing that
    * (approximately) satisfies the invariant
    * c * minLoadFactor <= size <= c * maxLoadFactor and has at
    * least one FREE slot for the given size.
    */
   protected int chooseGrowCapacity(int size, double minLoad, double maxLoad) {
       return nextPrime(Math.max(size + 1,
               (int) ((4 * size / (3 * minLoad + maxLoad)))));
   }
   /**
    * Returns new high water mark threshold based on current capacity and
    * maxLoadFactor.
    * 
    * @return int the new threshold.
    */
   protected int chooseHighWaterMark(int capacity, double maxLoad) {
       return Math.min(capacity - 2, (int) (capacity * maxLoad)); // makes
                                                                   // sure
                                                                   // there is
                                                                   // always at
                                                                   // least one
                                                                   // FREE slot
   }
   /**
    * Returns new low water mark threshold based on current capacity and
    * minLoadFactor.
    * 
    * @return int the new threshold.
    */
   protected int chooseLowWaterMark(int capacity, double minLoad) {
       return (int) (capacity * minLoad);
   }
   /**
    * Chooses a new prime table capacity neither favoring shrinking nor
    * growing, that (approximately) satisfies the invariant
    * c * minLoadFactor <= size <= c * maxLoadFactor and has at
    * least one FREE slot for the given size.
    */
   protected int chooseMeanCapacity(int size, double minLoad, double maxLoad) {
       return nextPrime(Math.max(size + 1,
               (int) ((2 * size / (minLoad + maxLoad)))));
   }
   /**
    * Chooses a new prime table capacity optimized for shrinking that
    * (approximately) satisfies the invariant
    * c * minLoadFactor <= size <= c * maxLoadFactor and has at
    * least one FREE slot for the given size.
    */
   protected int chooseShrinkCapacity(int size, double minLoad, double maxLoad) {
       return nextPrime(Math.max(size + 1,
               (int) ((4 * size / (minLoad + 3 * maxLoad)))));
   }
   /**
    * Removes all (key,value) associations from the receiver.
    */
   public abstract void clear();
   /**
    * Ensures that the receiver can hold at least the specified number of
    * elements without needing to allocate new internal memory. If necessary,
    * allocates new internal memory and increases the capacity of the receiver.
    * 

    * This method never need be called; it is for performance tuning only.
    * Calling this method before put()ing a large number of
    * associations boosts performance, because the receiver will grow only once
    * instead of potentially many times.
    * 

    * This default implementation does nothing. Override this method if
    * necessary.
    * 
    * @param minCapacity
    *            the desired minimum capacity.
    */
   public void ensureCapacity(int minCapacity) {
   }
   /**
    * Returns true if the receiver contains no (key,value)
    * associations.
    * 
    * @return true if the receiver contains no (key,value)
    *         associations.
    */
   public boolean isEmpty() {
       return distinct == 0;
   }
   /**
    * Returns a prime number which is >= desiredCapacity and
    * very close to desiredCapacity (within 11% if
    * desiredCapacity >= 1000).
    * 
    * @param desiredCapacity
    *            the capacity desired by the user.
    * @return the capacity which should be used for a hashtable.
    */
   protected int nextPrime(int desiredCapacity) {
       return PrimeFinder.nextPrime(desiredCapacity);
   }
   /**
    * Initializes the receiver. You will almost certainly need to override this
    * method in subclasses to initialize the hash table.
    * 
    * @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
    *             initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor).
    */
   protected void setUp(int initialCapacity, double minLoadFactor,
           double maxLoadFactor) {
       if (initialCapacity < 0)
           throw new IllegalArgumentException(
                   "Initial Capacity must not be less than zero: "
                           + initialCapacity);
       if (minLoadFactor < 0.0 || minLoadFactor >= 1.0)
           throw new IllegalArgumentException("Illegal minLoadFactor: "
                   + minLoadFactor);
       if (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0)
           throw new IllegalArgumentException("Illegal maxLoadFactor: "
                   + maxLoadFactor);
       if (minLoadFactor >= maxLoadFactor)
           throw new IllegalArgumentException("Illegal minLoadFactor: "
                   + minLoadFactor + " and maxLoadFactor: " + maxLoadFactor);
   }
   /**
    * Returns the number of (key,value) associations currently contained.
    *
    * @return the number of (key,value) associations currently contained.
    */
   public int size() {
       return distinct;
   }
   /**
    * 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.
    * 

    * This default implementation does nothing. Override this method if necessary.
    */
   public void trimToSize() {
   }
   
} // end of class AbstractHashMap
/**
 * Not of interest for users; only for implementors of hashtables. Used to keep
 * hash table capacities prime numbers.
 * 
 * 

 * Choosing prime numbers as hash table capacities is a good idea to keep them
 * working fast, particularly under hash table expansions.
 * 

 * However, JDK 1.2, JGL 3.1 and many other toolkits do nothing to keep
 * capacities prime. This class provides efficient means to choose prime
 * capacities.
 * 

 * Choosing a prime is O(log 300) (binary search in a list of 300
 * int's). Memory requirements: 1 KB static memory.
 *