de.tudarmstadt.ukp.dkpro.core.api.frequency.provider

Interface FrequencyCountProvider

All Known Implementing Classes:

BerkeleyLmFrequencyCountProvider, BerkeleyLmProvider, FrequencyCountProviderBase, FrequencyCountResourceBase, TestFrequencyCountProvider, TestFrequencyCountResource, Web1TFileAccessProvider, Web1TFrequencyCountResource, Web1TInMemoryFrequencyCountResource, Web1TInMemoryProvider, Web1TProviderBase

public interface FrequencyCountProvider

Method Summary

Modifier and Type	Method and Description
long	getFrequency(String phrase) Get frequency for a phrase
String	getID() Returns an ID that identifies the frequency provider
String	getLanguage() Returns the language for which the frequencies are provided.
double	getLogProbability(String phrase) Get the log probability for a phrase
Iterator<String>	getNgramIterator(int n) Returns an iterator over all ngrams of a given size in the corpus.
long	getNrOfDistinctNgrams(int n) Returns the number of distinct ngrams of a given size in the corpus.
long	getNrOfNgrams(int n) Returns the number of ngrams of a given size in the corpus.
long	getNrOfTokens()
double	getProbability(String phrase) Get the probability (=normalized frequency) for a phrase. The frequency count is normalized by the number of phrases in the corpus.

Method Detail

getFrequency

long getFrequency(String phrase)
           throws IOException

Get frequency for a phrase

Parameters:

phrase - phrase to search

Returns:

frequency of the phrase. Returns 0 if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getProbability

double getProbability(String phrase)
               throws IOException

Get the probability (=normalized frequency) for a phrase.
The frequency count is normalized by the number of phrases in the corpus.

Parameters:

phrase - phrase to search

Returns:

probability (=normalized frequency) of the phrase. Returns null if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getLogProbability

double getLogProbability(String phrase)
                  throws IOException

Get the log probability for a phrase

Parameters:

phrase - phrase to search

Returns:

The log probability of the. Returns 0 if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getNrOfTokens

long getNrOfTokens()
            throws IOException

Returns:

The number of tokens in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getNrOfNgrams

long getNrOfNgrams(int n)
            throws IOException

Returns the number of ngrams of a given size in the corpus.

Parameters:

n - the ngram size.

Returns:

the number of ngrams.

Throws:

IOException - if the information cannot be retrieved.

getNrOfDistinctNgrams

long getNrOfDistinctNgrams(int n)
                    throws IOException

Returns the number of distinct ngrams of a given size in the corpus.

Parameters:

n - the ngram size.

Returns:

the number of ngrams.

Throws:

IOException - if the information cannot be retrieved.

getNgramIterator

Iterator<String> getNgramIterator(int n)
                           throws IOException

Returns an iterator over all ngrams of a given size in the corpus.

Parameters:

n - the ngram size.

Returns:

an iterator over the ngrams.

Throws:

IOException - if the information cannot be retrieved.

getLanguage

String getLanguage()
            throws IOException

Returns the language for which the frequencies are provided.

Returns:

the language.

Throws:

IOException - if the information cannot be retrieved.

getID

String getID()

Returns an ID that identifies the frequency provider

Returns:

the ID.