Int2LongFrequencyDistributionEntry (lintools-datatypes 1.1.1 API)

java.lang.Object
- tl.lin.data.fd.Int2LongFrequencyDistributionEntry

All Implemented Interfaces:

Iterable<PairOfIntLong>, org.apache.hadoop.io.Writable, Int2LongFrequencyDistribution, SortableEntries<PairOfIntLong>
```
public class Int2LongFrequencyDistributionEntry
extends Object
implements Int2LongFrequencyDistribution
```
Implementation of Int2LongFrequencyDistribution based on HMapIL.

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

Constructor Summary

Constructors
Constructor and Description

Int2LongFrequencyDistributionEntry()

Constructors
Constructor and Description
`Int2LongFrequencyDistributionEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all events.
`double`	`computeLogRelativeFrequency(int k)` Computes the log (base e) of the relative frequency of a particular event `key`.
`double`	`computeRelativeFrequency(int k)` Computes the relative frequency of a particular event `key`.
`boolean`	`contains(int key)` Returns `true` if `key` exists in this object.
`void`	`decrement(int key)` Decrements the count of an event `key`.
`void`	`decrement(int key, long cnt)` Decrements the count of a particular event `key` by `cnt`.
`long`	`get(int key)` Returns the count of a particular event `key`.
`List<PairOfIntLong>`	`getEntries(SortableEntries.Order ordering)`
`List<PairOfIntLong>`	`getEntries(SortableEntries.Order ordering, int n)`
`int`	`getNumberOfEvents()` Returns number of distinct events observed.
`long`	`getSumOfCounts()` Returns the sum of counts of all observed events.
`void`	`increment(int key)` Increments the count of an event `key`.
`void`	`increment(int key, long cnt)` Increments the count of an event `key` by `cnt`.
`Iterator<PairOfIntLong>`	`iterator()` Iterator returns the same object every time, just with a different payload.
`void`	`readFields(DataInput in)`
`long`	`remove(int k)` Removes the count of a particular event `key`.
`long`	`set(int k, long v)` Sets the count of a particular event `key` to `cnt`.
`void`	`write(DataOutput out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Int2LongFrequencyDistributionEntry
```
public Int2LongFrequencyDistributionEntry()
```
- Method Detail
  - increment
```
public void increment(int key)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Increments the count of an event key.
    
    Specified by:
    
    increment in interface Int2LongFrequencyDistribution
  - increment
```
public void increment(int key,
                      long cnt)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Increments the count of an event key by cnt.
    
    Specified by:
    
    increment in interface Int2LongFrequencyDistribution
  - decrement
```
public void decrement(int key)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Decrements the count of an event key.
    
    Specified by:
    
    decrement in interface Int2LongFrequencyDistribution
  - decrement
```
public void decrement(int key,
                      long cnt)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Decrements the count of a particular event key by cnt.
    
    Specified by:
    
    decrement in interface Int2LongFrequencyDistribution
  - contains
```
public boolean contains(int key)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Returns true if key exists in this object.
    
    Specified by:
    
    contains in interface Int2LongFrequencyDistribution
  - get
```
public long get(int key)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Returns the count of a particular event key.
    
    Specified by:
    
    get in interface Int2LongFrequencyDistribution
  - computeRelativeFrequency
```
public double computeRelativeFrequency(int k)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Computes the relative frequency of a particular event key. That is, f(key) / SUM_i f(key_i).
    
    Specified by:
    
    computeRelativeFrequency in interface Int2LongFrequencyDistribution
  - computeLogRelativeFrequency
```
public double computeLogRelativeFrequency(int k)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Computes the log (base e) of the relative frequency of a particular event key.
    
    Specified by:
    
    computeLogRelativeFrequency in interface Int2LongFrequencyDistribution
  - set
```
public long set(int k,
                long v)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Sets the count of a particular event key to cnt.
    
    Specified by:
    
    set in interface Int2LongFrequencyDistribution
  - remove
```
public long remove(int k)
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Removes the count of a particular event key.
    
    Specified by:
    
    remove in interface Int2LongFrequencyDistribution
  - clear
```
public void clear()
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Removes all events.
    
    Specified by:
    
    clear in interface Int2LongFrequencyDistribution
  - getNumberOfEvents
```
public int getNumberOfEvents()
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    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 Int2LongFrequencyDistribution
  - getSumOfCounts
```
public long getSumOfCounts()
```
    Description copied from interface: Int2LongFrequencyDistribution
    
    Returns the sum of counts of all observed events. That is, SUM_i f(key_i).
    
    Specified by:
    
    getSumOfCounts in interface Int2LongFrequencyDistribution
  - iterator
```
public Iterator<PairOfIntLong> iterator()
```
    Iterator returns the same object every time, just with a different payload.
    
    Specified by:
    
    iterator in interface Iterable<PairOfIntLong>
  - getEntries
```
public List<PairOfIntLong> getEntries(SortableEntries.Order ordering)
```
    Specified by:
    
    getEntries in interface SortableEntries<PairOfIntLong>
  - getEntries
```
public List<PairOfIntLong> getEntries(SortableEntries.Order ordering,
                                      int n)
```
    Specified by:
    
    getEntries in interface SortableEntries<PairOfIntLong>
  - readFields
```
public void readFields(DataInput in)
                throws IOException
```
    Specified by:
    
    readFields in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException
  - write
```
public void write(DataOutput out)
           throws IOException
```
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException

Class Int2LongFrequencyDistributionEntry

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Int2LongFrequencyDistributionEntry

Method Detail

increment

increment

decrement

decrement

contains

get

computeRelativeFrequency

computeLogRelativeFrequency

set

remove

clear

getNumberOfEvents

getSumOfCounts

iterator

getEntries

getEntries

readFields

write