edu.stanford.nlp.stats
Class IntCounter<E>

java.lang.Object
  edu.stanford.nlp.stats.IntCounter<E>

All Implemented Interfaces:

GenericCounter<E>, Serializable

public class IntCounter<E>
extends Object
implements Serializable, GenericCounter<E>

A specialized kind of hash table (or map) for storing numeric counts for objects. It works like a Map, but with different methods for easily getting/setting/incrementing counts for objects and computing various functions with the counts. The Counter constructor and addAll method can be used to copy another Counter's contents over. This class also provides access to Comparators that can be used to sort the keys or entries of this Counter by the counts, in either ascending or descending order.

Author:

Dan Klein (klein@cs.stanford.edu), Joseph Smarr (jsmarr@stanford.edu), Teg Grenager (grenager@stanford.edu), Galen Andrew, Christopher Manning

See Also:

Serialized Form

Constructor Summary

IntCounter()
Constructs a new (empty) Counter.

IntCounter(IntCounter<E> c)
Constructs a new Counter with the contents of the given Counter.

IntCounter(MapFactory mapFactory)
Pass in a MapFactory and the map it vends will back your counter.

Method Summary

void	addAll(IntCounter<E> counter) Adds the counts in the given Counter to the counts in this Counter.
Object	argmax() Finds and returns the key in this Counter with the largest count.
Object	argmax(Comparator tieBreaker) Finds and returns the key in this Counter with the largest count.
Object	argmin() Finds and returns the key in this Counter with the smallest count.
Object	argmin(Comparator tieBreaker) Finds and returns the key in this Counter with the smallest count.
double	averageCount() Returns the mean of all the counts (totalCount/size).
void	clear() Removes all counts from this Counter.
Object	clone()
Comparator	comparator() Comparator that sorts objects by (increasing) count.
Comparator	comparator(boolean ascending) Returns a comparator suitable for sorting this Counter's keys or entries by their respective counts.
Comparator	comparator(boolean ascending, boolean useMagnitude) Returns a comparator suitable for sorting this Counter's keys or entries by their respective value or magnitude (unsigned value).
boolean	containsKey(E key)
void	decrementCount(E key) Subtracts 1 from the count for the given key.
void	decrementCount(E key, int count) Subtracts the given count from the current count for the given key.
void	decrementCounts(Collection<E> keys) Subtracts 1 from the counts of each of the given keys.
void	decrementCounts(Collection<E> keys, int count) Subtracts the given count from the current counts for each of the given keys.
double	doubleMax() Returns the value of the maximum entry in this counter, as a double.
boolean	equals(Object o)
double	getCount(E key) Returns the current count for the given key, which is 0 if it hasn't been seen before.
String	getCountAsString(E key) Returns the count for this key as a String.
int	getIntCount(Object key) Returns the current count for the given key, which is 0 if it hasn't been seen before.
MapFactory	getMapFactory() Returns the MapFactory used by this counter.
double	getNormalizedCount(E key) This has been de-deprecated in order to reduce compilation warnings, but really you should create a Distribution instead of using this method.
int	hashCode()
void	incrementCount(E key) Adds 1 to the count for the given key.
void	incrementCount(E key, int count) Adds the given count to the current count for the given key.
void	incrementCounts(Collection<E> keys) Adds 1 to the counts for each of the given keys.
void	incrementCounts(Collection<E> keys, int count) Adds the given count to the current counts for each of the given keys.
boolean	isEmpty()
Set	keysAbove(int countThreshold) Returns the set of keys whose counts are at or above the given threshold.
Set	keysAt(int count) Returns the set of keys that have exactly the given count.
Set	keysBelow(int countThreshold) Returns the set of keys whose counts are at or below the given threshold.
Set<E>	keySet() Returns the Set of keys in this counter.
int	max() Finds and returns the largest count in this Counter.
int	min() Finds and returns the smallest count in this Counter.
Object	remove(E key) Removes the given key from this Counter.
void	removeAll(Collection<E> c) Removes all the given keys from this Counter.
void	removeZeroCounts() Removes all keys whose count is 0.
void	setCount(E key, int count) Sets the current count for the given key.
void	setCount(E key, String s) Sets the count for this key to be the number encoded in the given String.
void	setCounts(Collection<E> keys, int count) Sets the current count for each of the given keys.
int	size() Returns the number of entries in this counter.
void	subtractAll(IntCounter<E> counter) Subtracts the counts in the given Counter from the counts in this Counter.
String	toString()
String	toString(NumberFormat nf)
String	toString(NumberFormat nf, String preAppend, String postAppend, String keyValSeparator, String itemSeparator)
int	totalCount() Returns the current total count for all objects in this Counter.
int	totalCount(Filter filter) Returns the total count for all objects in this Counter that pass the given Filter.
double	totalDoubleCount() Computes the total of all counts in this counter, and returns it as a double.
double	totalDoubleCount(Filter filter)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntCounter

public IntCounter()

Constructs a new (empty) Counter.

IntCounter

public IntCounter(MapFactory mapFactory)

Pass in a MapFactory and the map it vends will back your counter.

IntCounter

public IntCounter(IntCounter<E> c)

Constructs a new Counter with the contents of the given Counter.

Method Detail

getMapFactory

public MapFactory getMapFactory()

Description copied from interface: GenericCounter

Returns the MapFactory used by this counter.

Specified by:

getMapFactory in interface GenericCounter<E>

totalCount

public int totalCount()

Returns the current total count for all objects in this Counter. All counts are summed each time, so cache it if you need it repeatedly.

totalDoubleCount

public double totalDoubleCount()

Description copied from interface: GenericCounter

Computes the total of all counts in this counter, and returns it as a double.

Specified by:

totalDoubleCount in interface GenericCounter<E>

totalCount

public int totalCount(Filter filter)

Returns the total count for all objects in this Counter that pass the given Filter. Passing in a filter that always returns true is equivalent to calling totalCount().

totalDoubleCount

public double totalDoubleCount(Filter filter)

averageCount

public double averageCount()

Returns the mean of all the counts (totalCount/size).

getCount

public double getCount(E key)

Returns the current count for the given key, which is 0 if it hasn't been seen before. This is a convenient version of get that casts and extracts the primitive value.

Specified by:

getCount in interface GenericCounter<E>

getCountAsString

public String getCountAsString(E key)

Description copied from interface: GenericCounter

Returns the count for this key as a String.

Specified by:

getCountAsString in interface GenericCounter<E>

getIntCount

public int getIntCount(Object key)

Returns the current count for the given key, which is 0 if it hasn't been seen before. This is a convenient version of get that casts and extracts the primitive value.

getNormalizedCount

public double getNormalizedCount(E key)

This has been de-deprecated in order to reduce compilation warnings, but really you should create a Distribution instead of using this method.

setCount

public void setCount(E key,
                     int count)

Sets the current count for the given key. This will wipe out any existing count for that key.

To add to a count instead of replacing it, use incrementCount(Object,int).

setCount

public void setCount(E key,
                     String s)

Description copied from interface: GenericCounter

Sets the count for this key to be the number encoded in the given String.

Specified by:

setCount in interface GenericCounter<E>

setCounts

public void setCounts(Collection<E> keys,
                      int count)

Sets the current count for each of the given keys. This will wipe out any existing counts for these keys.

To add to the counts of a collection of objects instead of replacing them, use incrementCounts(Collection,int).

incrementCount

public void incrementCount(E key,
                           int count)

Adds the given count to the current count for the given key. If the key hasn't been seen before, it is assumed to have count 0, and thus this method will set its count to the given amount. Negative increments are equivalent to calling decrementCount.

To more conviently increment the count by 1, use incrementCount(Object).

To set a count to a specifc value instead of incrementing it, use setCount(Object,int).

incrementCount

public void incrementCount(E key)

Adds 1 to the count for the given key. If the key hasn't been seen before, it is assumed to have count 0, and thus this method will set its count to 1.

To increment the count by a value other than 1, use incrementCount(Object,int).

To set a count to a specifc value instead of incrementing it, use setCount(Object,int).

incrementCounts

public void incrementCounts(Collection<E> keys,
                            int count)

Adds the given count to the current counts for each of the given keys. If any of the keys haven't been seen before, they are assumed to have count 0, and thus this method will set their counts to the given amount. Negative increments are equivalent to calling decrementCounts.

To more conviniently increment the counts of a collection of objects by 1, use incrementCounts(Collection).

To set the counts of a collection of objects to a specific value instead of incrementing them, use setCounts(Collection,int).

incrementCounts

public void incrementCounts(Collection<E> keys)

Adds 1 to the counts for each of the given keys. If any of the keys haven't been seen before, they are assumed to have count 0, and thus this method will set their counts to 1.

To increment the counts of a collection of object by a value other than 1, use incrementCounts(Collection,int).

To set the counts of a collection of objects to a specific value instead of incrementing them, use setCounts(Collection,int).

decrementCount

public void decrementCount(E key,
                           int count)

Subtracts the given count from the current count for the given key. If the key hasn't been seen before, it is assumed to have count 0, and thus this method will set its count to the negative of the given amount. Negative increments are equivalent to calling incrementCount.

To more conviently decrement the count by 1, use decrementCount(Object).

To set a count to a specifc value instead of decrementing it, use setCount(Object,int).

decrementCount

public void decrementCount(E key)

Subtracts 1 from the count for the given key. If the key hasn't been seen before, it is assumed to have count 0, and thus this method will set its count to -1.

To decrement the count by a value other than 1, use decrementCount(Object,int).

To set a count to a specifc value instead of decrementing it, use setCount(Object,int).

decrementCounts

public void decrementCounts(Collection<E> keys,
                            int count)

Subtracts the given count from the current counts for each of the given keys. If any of the keys haven't been seen before, they are assumed to have count 0, and thus this method will set their counts to the negative of the given amount. Negative increments are equivalent to calling incrementCount.

To more conviniently decrement the counts of a collection of objects by 1, use decrementCounts(Collection).

To set the counts of a collection of objects to a specific value instead of decrementing them, use setCounts(Collection,int).

decrementCounts

public void decrementCounts(Collection<E> keys)

Subtracts 1 from the counts of each of the given keys. If any of the keys haven't been seen before, they are assumed to have count 0, and thus this method will set their counts to -1.

To decrement the counts of a collection of object by a value other than 1, use decrementCounts(Collection,int).

To set the counts of a collection of objects to a specifc value instead of decrementing them, use setCounts(Collection,int).

addAll

public void addAll(IntCounter<E> counter)

Adds the counts in the given Counter to the counts in this Counter.

To copy the values from another Counter rather than adding them, use

subtractAll

public void subtractAll(IntCounter<E> counter)

Subtracts the counts in the given Counter from the counts in this Counter.

To copy the values from another Counter rather than subtracting them, use

containsKey

public boolean containsKey(E key)

remove

public Object remove(E key)

Removes the given key from this Counter. Its count will now be 0 and it will no longer be considered previously seen.

removeAll

public void removeAll(Collection<E> c)

Removes all the given keys from this Counter.

clear

public void clear()

Removes all counts from this Counter.

size

public int size()

Description copied from interface: GenericCounter

Returns the number of entries in this counter.

Specified by:

size in interface GenericCounter<E>

isEmpty

public boolean isEmpty()

keySet

public Set<E> keySet()

Description copied from interface: GenericCounter

Returns the Set of keys in this counter.

Specified by:

keySet in interface GenericCounter<E>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(NumberFormat nf,
                       String preAppend,
                       String postAppend,
                       String keyValSeparator,
                       String itemSeparator)

toString

public String toString(NumberFormat nf)

clone

public Object clone()

Overrides:

clone in class Object

removeZeroCounts

public void removeZeroCounts()

Removes all keys whose count is 0. After incrementing and decrementing counts or adding and subtracting Counters, there may be keys left whose count is 0, though normally this is undesirable. This method cleans up the map.

Maybe in the future we should try to do this more on-the-fly, though it's not clear whether a distinction should be made between "never seen" (i.e. null count) and "seen with 0 count". Certainly there's no distinction in getCount() but there is in containsKey().

max

public int max()

Finds and returns the largest count in this Counter.

doubleMax

public double doubleMax()

Description copied from interface: GenericCounter

Returns the value of the maximum entry in this counter, as a double.

Specified by:

doubleMax in interface GenericCounter<E>

min

public int min()

Finds and returns the smallest count in this Counter.

argmax

public Object argmax(Comparator tieBreaker)

Finds and returns the key in this Counter with the largest count. Ties are broken by comparing the objects using the given tie breaking Comparator, favoring Objects that are sorted to the front. This is useful if the keys are numeric and there is a bias to prefer smaller or larger values, and can be useful in other circumstances where random tie-breaking is not desirable. Returns null if this Counter is empty.

argmax

public Object argmax()

Finds and returns the key in this Counter with the largest count. Ties are broken according to the natural ordering of the objects. This will prefer smaller numeric keys and lexicographically earlier String keys. To use a different tie-breaking Comparator, use argmax(Comparator). Returns null if this Counter is empty.

argmin

public Object argmin(Comparator tieBreaker)

Finds and returns the key in this Counter with the smallest count. Ties are broken by comparing the objects using the given tie breaking Comparator, favoring Objects that are sorted to the front. This is useful if the keys are numeric and there is a bias to prefer smaller or larger values, and can be useful in other circumstances where random tie-breaking is not desirable. Returns null if this Counter is empty.

argmin

public Object argmin()

Finds and returns the key in this Counter with the smallest count. Ties are broken according to the natural ordering of the objects. This will prefer smaller numeric keys and lexicographically earlier String keys. To use a different tie-breaking Comparator, use argmin(Comparator). Returns null if this Counter is empty.

keysAbove

public Set keysAbove(int countThreshold)

Returns the set of keys whose counts are at or above the given threshold. This set may have 0 elements but will not be null.

keysBelow

public Set keysBelow(int countThreshold)

Returns the set of keys whose counts are at or below the given threshold. This set may have 0 elements but will not be null.

keysAt

public Set keysAt(int count)

Returns the set of keys that have exactly the given count. This set may have 0 elements but will not be null.

comparator

public Comparator comparator(boolean ascending)

Returns a comparator suitable for sorting this Counter's keys or entries by their respective counts. If ascending is true, lower counts will be returned first, otherwise higher counts will be returned first.

Sample usage:

 Counter c = new Counter();
 // add to the counter...
 List biggestKeys = new ArrayList(c.keySet());
 Collections.sort(biggestKeys, c.comparator(false));
 List smallestEntries = new ArrayList(c.entrySet());
 Collections.sort(smallestEntries, c.comparator(true))
 

comparator

public Comparator comparator(boolean ascending,
                             boolean useMagnitude)

Returns a comparator suitable for sorting this Counter's keys or entries by their respective value or magnitude (unsigned value). If ascending is true, smaller magnitudes will be returned first, otherwise higher magnitudes will be returned first.

Sample usage:

 Counter c = new Counter();
 // add to the counter...
 List biggestKeys = new ArrayList(c.keySet());
 Collections.sort(biggestKeys, c.comparator(false, true));
 List smallestEntries = new ArrayList(c.entrySet());
 Collections.sort(smallestEntries, c.comparator(true))
 

comparator

public Comparator comparator()

Comparator that sorts objects by (increasing) count. Shortcut for calling comparator(true).