tl.lin.data.fd
Interface Long2LongFrequencyDistribution

All Superinterfaces:

Iterable<PairOfLongs>, SortableEntries<PairOfLongs>

public interface Long2LongFrequencyDistribution
extends SortableEntries<PairOfLongs>

A frequency distribution where events are longs and counts are longs.

Nested Class Summary

Nested classes/interfaces inherited from interface tl.lin.data.SortableEntries

SortableEntries.Order

Method Summary

void	clear() Removes all events.
double	computeLogRelativeFrequency(long key) Computes the log (base e) of the relative frequency of a particular event key.
double	computeRelativeFrequency(long key) Computes the relative frequency of a particular event key.
boolean	contains(long key) Returns true if key exists in this object.
void	decrement(long key) Decrements the count of an event key.
void	decrement(long key, long cnt) Decrements the count of an event key by cnt.
long	get(long key) Returns the count of a particular event key.
int	getNumberOfEvents() Returns number of distinct events observed.
long	getSumOfCounts() Returns the sum of counts of all observed events.
void	increment(long key) Increments the count of an event key.
void	increment(long key, long cnt) Increments the count of an event key by cnt.
long	remove(long key) Removes the count of a particular event key.
long	set(long key, long cnt) Sets the count of a particular event key to cnt.

Methods inherited from interface tl.lin.data.SortableEntries

getEntries, getEntries

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

increment

void increment(long key)

Increments the count of an event key.

increment

void increment(long key,
               long cnt)

Increments the count of an event key by cnt.

decrement

void decrement(long key)

Decrements the count of an event key.

decrement

void decrement(long key,
               long cnt)

Decrements the count of an event key by cnt.

contains

boolean contains(long key)

Returns true if key exists in this object.

get

long get(long key)

Returns the count of a particular event key.

computeRelativeFrequency

double computeRelativeFrequency(long key)

Computes the relative frequency of a particular event key. That is, f(key) / SUM_i f(key_i).

computeLogRelativeFrequency

double computeLogRelativeFrequency(long key)

Computes the log (base e) of the relative frequency of a particular event key.

set

long set(long key,
         long cnt)

Sets the count of a particular event key to cnt.

remove

long remove(long key)

Removes the count of a particular event key.

clear

void clear()

Removes all events.

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.

getSumOfCounts

long getSumOfCounts()

Returns the sum of counts of all observed events.