edu.umd.cloud9.util.count
Class OpenInt2IntFrequencyDistribution

java.lang.Object
  edu.umd.cloud9.util.count.OpenInt2IntFrequencyDistribution

All Implemented Interfaces:

Int2IntFrequencyDistribution, Iterable<PairOfInts>

public class OpenInt2IntFrequencyDistribution
extends Object
implements Int2IntFrequencyDistribution

Implementation of Int2IntFrequencyDistribution based on Int2IntOpenHashMap.

Author:

Jimmy Lin

Constructor Summary

OpenInt2IntFrequencyDistribution()

Method Summary

void	clear() Removes all events.
boolean	contains(int key) Returns true if key exists in this object.
void	decrement(int key) Decrements the frequency of an event key.
void	decrement(int key, int cnt) Decrements the frequency of an event key by cnt.
Int2IntMap.FastEntrySet	entrySet() Exposes efficient method for accessing mappings in this map.
int	get(int key) Returns the frequency of a particular event key.
List<PairOfInts>	getFrequencySortedEvents() Returns events sorted by frequency of occurrence.
List<PairOfInts>	getFrequencySortedEvents(int n) Returns top n events sorted by frequency of occurrence.
int	getNumberOfEvents() Returns number of distinct events observed.
List<PairOfInts>	getSortedEvents() Returns events in sorted order.
List<PairOfInts>	getSortedEvents(int n) Returns top n events in sorted order.
long	getSumOfFrequencies() Returns the sum of frequencies of all observed events.
void	increment(int key) Increments the frequency of an event key.
void	increment(int key, int cnt) Increments the frequency of an event key by cnt.
Iterator<PairOfInts>	iterator() Iterator returns the same object every time, just with a different payload.
IntSet	keySet() Exposes efficient method for accessing keys in this map.
int	remove(int key) Removes the count of a particular event key.
int	set(int key, int cnt) Sets the frequency of a particular event key to cnt.
IntCollection	values() Exposes efficient method for accessing values in this map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenInt2IntFrequencyDistribution

public OpenInt2IntFrequencyDistribution()

Method Detail

increment

public void increment(int key)

Description copied from interface: Int2IntFrequencyDistribution

Increments the frequency of an event key.

Specified by:

increment in interface Int2IntFrequencyDistribution

increment

public void increment(int key,
                      int cnt)

Description copied from interface: Int2IntFrequencyDistribution

Increments the frequency of an event key by cnt.

Specified by:

increment in interface Int2IntFrequencyDistribution

decrement

public void decrement(int key)

Description copied from interface: Int2IntFrequencyDistribution

Decrements the frequency of an event key.

Specified by:

decrement in interface Int2IntFrequencyDistribution

decrement

public void decrement(int key,
                      int cnt)

Description copied from interface: Int2IntFrequencyDistribution

Decrements the frequency of an event key by cnt.

Specified by:

decrement in interface Int2IntFrequencyDistribution

contains

public boolean contains(int key)

Description copied from interface: Int2IntFrequencyDistribution

Returns true if key exists in this object.

Specified by:

contains in interface Int2IntFrequencyDistribution

get

public int get(int key)

Description copied from interface: Int2IntFrequencyDistribution

Returns the frequency of a particular event key.

Specified by:

get in interface Int2IntFrequencyDistribution

set

public int set(int key,
               int cnt)

Description copied from interface: Int2IntFrequencyDistribution

Sets the frequency of a particular event key to cnt.

Specified by:

set in interface Int2IntFrequencyDistribution

remove

public int remove(int key)

Description copied from interface: Int2IntFrequencyDistribution

Removes the count of a particular event key.

Specified by:

remove in interface Int2IntFrequencyDistribution

clear

public void clear()

Description copied from interface: Int2IntFrequencyDistribution

Removes all events.

Specified by:

clear in interface Int2IntFrequencyDistribution

keySet

public IntSet keySet()

Exposes efficient method for accessing keys in this map.

values

public IntCollection values()

Exposes efficient method for accessing values in this map.

entrySet

public Int2IntMap.FastEntrySet entrySet()

Exposes efficient method for accessing mappings in this map.

getFrequencySortedEvents

public List<PairOfInts> getFrequencySortedEvents()

Description copied from interface: Int2IntFrequencyDistribution

Returns events sorted by frequency of occurrence.

Specified by:

getFrequencySortedEvents in interface Int2IntFrequencyDistribution

getFrequencySortedEvents

public List<PairOfInts> getFrequencySortedEvents(int n)

Description copied from interface: Int2IntFrequencyDistribution

Returns top n events sorted by frequency of occurrence.

Specified by:

getFrequencySortedEvents in interface Int2IntFrequencyDistribution

getSortedEvents

public List<PairOfInts> getSortedEvents()

Description copied from interface: Int2IntFrequencyDistribution

Returns events in sorted order.

Specified by:

getSortedEvents in interface Int2IntFrequencyDistribution

getSortedEvents

public List<PairOfInts> getSortedEvents(int n)

Description copied from interface: Int2IntFrequencyDistribution

Returns top n events in sorted order.

Specified by:

getSortedEvents in interface Int2IntFrequencyDistribution

getNumberOfEvents

public int getNumberOfEvents()

Description copied from interface: Int2IntFrequencyDistribution

Returns number of distinct events observed. Note that if an event is observed and then its count subsequently removed, the event will not be included in this count.

Specified by:

getNumberOfEvents in interface Int2IntFrequencyDistribution

getSumOfFrequencies

public long getSumOfFrequencies()

Description copied from interface: Int2IntFrequencyDistribution

Returns the sum of frequencies of all observed events.

Specified by:

getSumOfFrequencies in interface Int2IntFrequencyDistribution

iterator

public Iterator<PairOfInts> iterator()

Iterator returns the same object every time, just with a different payload.

Specified by:

iterator in interface Iterable<PairOfInts>