FreqDist (DKPro Core - Master Aggregator 1.7.0 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.util.FreqDist<T>

Type Parameters:
T - The type of element which is counted.

All Implemented Interfaces:

Serializable
```
public class FreqDist<T>
extends Object
implements Serializable
```
An object that counts objects. Inspired by NLTKs FreqDist-class.

Author:

Mateusz Parzonka

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

FreqDist()
Creates an empty FreqDist.

FreqDist(Collection<T> collection)
Instantiate a FreqDist and count the given collection.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`count(Collection<T> collection)` Increment the counts for all elements contained in the collection.
`void`	`count(T element)` Increment the count for the given element.
`void`	`count(T element, int number)` Increment the count by number for the given element.
`int`	`getCount(T element)` Returns the count of the given element
`Map<T,Double>`	`getProbabilities()` Returns a mapping of elements to probabilities of their occurrence.
`int`	`getTotalCount()` Returns the accumulated count of all elements.

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

- Constructor Detail
  - FreqDist
```
public FreqDist(Collection<T> collection)
```
    Instantiate a FreqDist and count the given collection.
  - FreqDist
```
public FreqDist()
```
    Creates an empty FreqDist.
- Method Detail
  - getProbabilities
```
public Map<T,Double> getProbabilities()
```
    Returns a mapping of elements to probabilities of their occurrence.
    
    Returns:
    probabilities of occurrence for every element
  - getCount
```
public int getCount(T element)
```
    Returns the count of the given element
    
    Returns:
    the count
  - count
```
public void count(T element)
```
    Increment the count for the given element.
    
    Parameters:
    element - the element to be counted
  - count
```
public void count(T element,
         int number)
```
    Increment the count by number for the given element.
    
    Parameters:
    element - the element to be counted
  - count
```
public void count(Collection<T> collection)
```
    Increment the counts for all elements contained in the collection. When elements are contained multiple times, they are counted multiple times as well.
    
    Parameters:
    collection - a collection of elements
  - getTotalCount
```
public int getTotalCount()
```
    Returns the accumulated count of all elements.
    
    Returns:
    the total count

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2011–2015. All rights reserved.