edu.umd.cloud9.util.count
Interface Object2LongFrequencyDistribution<K extends Comparable<K>>

All Superinterfaces:

Iterable<PairOfObjectLong<K>>

All Known Implementing Classes:

OpenObject2LongFrequencyDistribution

public interface Object2LongFrequencyDistribution<K extends Comparable<K>>
extends Iterable<PairOfObjectLong<K>>

A frequency distribution where events are arbitrary objects and counts are ints.

Author:

Jimmy Lin

Method Summary

void	clear() Removes all events.
boolean	contains(K key) Returns true if key exists in this object.
void	decrement(K key) Decrements the frequency of an event key.
void	decrement(K key, long cnt) Decrements the frequency of a particular event key by cnt.
long	get(K key) Returns the frequency of a particular event key.
List<PairOfObjectLong<K>>	getFrequencySortedEvents() Returns events sorted by frequency of occurrence.
List<PairOfObjectLong<K>>	getFrequencySortedEvents(int n) Returns top n events sorted by frequency of occurrence.
int	getNumberOfEvents() Returns number of distinct events observed.
List<PairOfObjectLong<K>>	getSortedEvents() Returns events in sorted order.
List<PairOfObjectLong<K>>	getSortedEvents(int n) Returns top n events in sorted order.
long	getSumOfFrequencies() Returns the sum of frequencies of all observed events.
void	increment(K key) Increments the frequency of an event key.
void	increment(K key, long cnt) Increments the frequency of an event key by cnt.
long	remove(K k) Removes the count of a particular event key.
long	set(K key, long cnt) Sets the frequency of a particular event key to cnt.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

increment

void increment(K key)

Increments the frequency of an event key.

increment

void increment(K key,
               long cnt)

Increments the frequency of an event key by cnt.

decrement

void decrement(K key)

Decrements the frequency of an event key.

decrement

void decrement(K key,
               long cnt)

Decrements the frequency of a particular event key by cnt.

contains

boolean contains(K key)

Returns true if key exists in this object.

get

long get(K key)

Returns the frequency of a particular event key.

set

long set(K key,
         long cnt)

Sets the frequency of a particular event key to cnt.

remove

long remove(K k)

Removes the count of a particular event key.

clear

void clear()

Removes all events.

getFrequencySortedEvents

List<PairOfObjectLong<K>> getFrequencySortedEvents()

Returns events sorted by frequency of occurrence.

getFrequencySortedEvents

List<PairOfObjectLong<K>> getFrequencySortedEvents(int n)

Returns top n events sorted by frequency of occurrence.

getSortedEvents

List<PairOfObjectLong<K>> getSortedEvents()

Returns events in sorted order.

getSortedEvents

List<PairOfObjectLong<K>> getSortedEvents(int n)

Returns top n events in sorted order.

getNumberOfEvents

int getNumberOfEvents()

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.

getSumOfFrequencies

long getSumOfFrequencies()

Returns the sum of frequencies of all observed events.