ObjectIntHashMap.java

/**
 * Copyright 2014, Emory University
 * 
 * Licensed 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 edu.emory.clir.clearnlp.collection.map;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Set;

import com.carrotsearch.hppc.cursors.ObjectIntCursor;

import edu.emory.clir.clearnlp.collection.pair.ObjectIntPair;

/**
 * @since 3.0.0
 * @author Jinho D. Choi ({@code jinho.choi@emory.edu})
 */
public class ObjectIntHashMap<T> implements Serializable, Iterable<ObjectIntPair<T>>
{
	private static final long serialVersionUID = -869739556140492570L;
	private com.carrotsearch.hppc.ObjectIntHashMap<T> g_map;
	
	public ObjectIntHashMap()
	{
		g_map = new com.carrotsearch.hppc.ObjectIntHashMap<T>();
	}
	
	public ObjectIntHashMap(int initialCapacity)
	{
		g_map = new com.carrotsearch.hppc.ObjectIntHashMap<T>(initialCapacity);
	}
	
	@SuppressWarnings("unchecked")
	private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
	{
		List<ObjectIntPair<T>> list = (List<ObjectIntPair<T>>)in.readObject();
		g_map = new com.carrotsearch.hppc.ObjectIntHashMap<T>(list.size());
		put(list);
	}

	private void writeObject(ObjectOutputStream o) throws IOException
	{
		o.writeObject(toList());
	}
	
	/** @return a list of (key, value) pairs. */
	public List<ObjectIntPair<T>> toList()
	{
		List<ObjectIntPair<T>> list = new ArrayList<>();
		
		for (ObjectIntPair<T> p : this)
			list.add(p);
		
		return list;
	}
	
	/** @return a set of keys whose values are greater than the specific cutoff. */
	public Set<T> keySet(int cutoff)
	{
		Set<T> set = new HashSet<>();
		
		for (ObjectIntPair<T> p : this)
		{
			if (p.i > cutoff)
				set.add(p.o);
		}
		
		return set;
	}
	
	/** Puts a the list of (key, value) pairs to this map. */
	public void put(List<ObjectIntPair<T>> list)
	{
		for (ObjectIntPair<T> p : list)
			put((T)p.o, p.i);
	}
	
	public int add(T key, int inc)
	{
		int value = get(key) + inc;
		put(key, value);
		return value;
	}
	
	public int add(T key)
	{
		return add(key, 1);
	}
	
	public void addAll(Collection<T> col)
	{
		for (T o : col)
			add(o);	
	}
	
	public void put(T key, int value)
	{
		g_map.put(key, value);
	}
	
	public int get(T key)
	{
		return g_map.get(key);
	}
	
	public int remove(T key)
	{
		return g_map.remove(key);
	}
	
	public boolean containsKey(T key)
	{
		return g_map.containsKey(key);
	}
	
	public boolean isEmpty()
	{
		return g_map.isEmpty();
	}
	
	public int size()
	{
		return g_map.size();
	}
	
	@Override
	public String toString()
	{
		return g_map.toString();
	}
	
	@Override
	public Iterator<ObjectIntPair<T>> iterator()
	{
		Iterator<ObjectIntPair<T>> it = new Iterator<ObjectIntPair<T>>()
		{
			private final Iterator<ObjectIntCursor<T>> g_iter = g_map.iterator();
			
			@Override
			public boolean hasNext()
			{
				return g_iter.hasNext();
			}
			
			@Override
			public ObjectIntPair<T> next()
			{
				ObjectIntPair<T> p = null;
				try {
					ObjectIntCursor<T> cursor = g_iter.next();
					p = new ObjectIntPair<T>(cursor.key, cursor.value);
				}
				catch (NoSuchElementException e)
				{
					
				}
				return p;
			}
			
			@Override
			public void remove() {}
		};
				
		return it;
	}
}