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

Class TestFrequencyCountProvider

java.lang.Object

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

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

All Implemented Interfaces:

FrequencyCountProvider

public class TestFrequencyCountProvider
extends FrequencyCountProviderBase

Frequency provider to be used in unit tests. The returned frequency is based on the number of characters.

Constructor Summary

Constructors

Constructor and Description
TestFrequencyCountProvider()

Method Summary

Modifier and Type	Method and Description
protected long	getFrequencyFromProvider(String phrase)
String	getID() Returns an ID that identifies the frequency provider
String	getLanguage() Returns the language for which the frequencies are provided.
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()

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.frequency.provider.FrequencyCountProviderBase

getFrequency, getLogLikelihood, getLogProbability, getProbability, getScaleDownFactor, setScaleDownFactor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestFrequencyCountProvider

public TestFrequencyCountProvider()

Method Detail

getFrequencyFromProvider

protected long getFrequencyFromProvider(String phrase)
                                 throws IllegalArgumentException

Specified by:

getFrequencyFromProvider in class FrequencyCountProviderBase

Throws:

IllegalArgumentException

getNrOfNgrams

public long getNrOfNgrams(int n)

Description copied from interface: FrequencyCountProvider

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

Parameters:

n - the ngram size.

Returns:

the number of ngrams.

getNrOfDistinctNgrams

public long getNrOfDistinctNgrams(int n)
                           throws IllegalArgumentException

Description copied from interface: FrequencyCountProvider

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

Parameters:

n - the ngram size.

Returns:

the number of ngrams.

Throws:

IllegalArgumentException

getNrOfTokens

public long getNrOfTokens()

Returns:

The number of tokens in the corpus.

getNgramIterator

public Iterator<String> getNgramIterator(int n)
                                  throws IllegalArgumentException

Description copied from interface: FrequencyCountProvider

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:

IllegalArgumentException

getLanguage

public String getLanguage()
                   throws IllegalArgumentException

Description copied from interface: FrequencyCountProvider

Returns the language for which the frequencies are provided.

Returns:

the language.

Throws:

IllegalArgumentException

getID

public String getID()
             throws IllegalArgumentException

Description copied from interface: FrequencyCountProvider

Returns an ID that identifies the frequency provider

Specified by:

getID in interface FrequencyCountProvider

Overrides:

getID in class FrequencyCountProviderBase

Returns:

the ID.

Throws:

IllegalArgumentException