Object2LongFrequencyDistribution (lintools-datatypes 1.0.0 API)

All Superinterfaces:

Iterable<PairOfObjectLong<K>>, SortableEntries<PairOfObjectLong<K>>

All Known Implementing Classes:

Object2LongFrequencyDistributionEntry
```
public interface Object2LongFrequencyDistribution<K extends Comparable<K>>
extends SortableEntries<PairOfObjectLong<K>>
```
A frequency distribution where events are arbitrary objects and counts are ints.

Nested Class Summary
- Nested classes/interfaces inherited from interface tl.lin.data.fd.SortableEntries
  SortableEntries.Order

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all events.
`double`	`computeLogRelativeFrequency(K key)` Computes the log (base e) of the relative frequency of a particular event `key`.
`double`	`computeRelativeFrequency(K key)` Computes the relative frequency of a particular event `key`.
`boolean`	`contains(K key)` Returns `true` if `key` exists in this object.
`void`	`decrement(K key)` Decrements the count of an event `key`.
`void`	`decrement(K key, long cnt)` Decrements the count of a particular event `key` by `cnt`.
`long`	`get(K 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(K key)` Increments the count of an event `key`.
`void`	`increment(K key, long cnt)` Increments the count of an event `key` by `cnt`.
`Set<K>`	`keySet()` Returns the set of keys.
`long`	`remove(K k)` Removes the count of a particular event `key`.
`long`	`set(K key, long cnt)` Sets the count of a particular event `key` to `cnt`.

Methods inherited from interface tl.lin.data.fd.SortableEntries
getEntries, getEntries

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - increment
```
void increment(K key)
```
    Increments the count of an event key.
  - increment
```
void increment(K key,
             long cnt)
```
    Increments the count of an event key by cnt.
  - decrement
```
void decrement(K key)
```
    Decrements the count of an event key.
  - decrement
```
void decrement(K key,
             long cnt)
```
    Decrements the count 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 count of a particular event key.
  - computeRelativeFrequency
```
double computeRelativeFrequency(K key)
```
    Computes the relative frequency of a particular event key. That is, f(key) / SUM_i f(key_i).
  - computeLogRelativeFrequency
```
double computeLogRelativeFrequency(K key)
```
    Computes the log (base e) of the relative frequency of a particular event key.
  - set
```
long set(K key,
       long cnt)
```
    Sets the count 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.
  - 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. That is, SUM_i f(key_i).
  - keySet
```
Set<K> keySet()
```
    Returns the set of keys.

Interface Object2LongFrequencyDistribution<K extends Comparable<K>>

Nested Class Summary

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

Method Summary

Methods inherited from interface tl.lin.data.fd.SortableEntries

Methods inherited from interface java.lang.Iterable

Method Detail

increment

increment

decrement

decrement

contains

get

computeRelativeFrequency

computeLogRelativeFrequency

set

remove

clear

getNumberOfEvents

getSumOfCounts

keySet