com.optimaize.langdetect.profiles

Class LanguageProfileImpl

java.lang.Object

com.optimaize.langdetect.profiles.LanguageProfileImpl

All Implemented Interfaces:

LanguageProfile

public final class LanguageProfileImpl
extends Object
implements LanguageProfile

This class is immutable.

Author:

Fabian Kessler

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getFrequency(String gram)
List<Integer>	getGramLengths() Tells what the n in n-grams are used here.
LdLocale	getLocale()
long	getMaxGramCount(int gramLength) Tells how often the n-gram with the highest amount of occurrences used in this profile occurred.
long	getMinGramCount(int gramLength) Tells how often the n-gram with the lowest amount of occurrences used in this profile occurred.
long	getNumGramOccurrences(int gramLength) Tells how often all n-grams of a certain length occurred, combined.
int	getNumGrams() Tells how many n-grams there are for all n-gram sizes combined.
int	getNumGrams(int gramLength) Tells how many different n-grams there are for a certain n-gram size.
int	hashCode()
Iterable<Map.Entry<String,Integer>>	iterateGrams() Iterates all ngram strings with frequency.
Iterable<Map.Entry<String,Integer>>	iterateGrams(int gramLength) Iterates all gramLength-gram strings with frequency.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLocale

@NotNull
public LdLocale getLocale()

Specified by:

getLocale in interface LanguageProfile

getGramLengths

@NotNull
public List<Integer> getGramLengths()

Description copied from interface: LanguageProfile

Tells what the n in n-grams are used here. Example: [1,2,3]

Specified by:

getGramLengths in interface LanguageProfile

Returns:

Sorted from smaller to larger.

getFrequency

public int getFrequency(String gram)

Specified by:

getFrequency in interface LanguageProfile

Parameters:

gram - for example "a" or "foo".

Returns:

0-n, also zero if this profile does not use n-grams of that length (for example if no 4-grams are made).

getNumGrams

public int getNumGrams(int gramLength)

Description copied from interface: LanguageProfile

Tells how many different n-grams there are for a certain n-gram size. For example the English language has about 57 different 1-grams, whereas Chinese in Hani has thousands.

Specified by:

getNumGrams in interface LanguageProfile

Parameters:

gramLength - 1-n

Returns:

0-n, returns zero if no such n-grams were made (for example if no 4-grams were made), or if all the training text did not contain such long words.

getNumGrams

public int getNumGrams()

Description copied from interface: LanguageProfile

Tells how many n-grams there are for all n-gram sizes combined.

Specified by:

getNumGrams in interface LanguageProfile

Returns:

0-n (0 only on an empty profile...)

getNumGramOccurrences

public long getNumGramOccurrences(int gramLength)

Description copied from interface: LanguageProfile

Tells how often all n-grams of a certain length occurred, combined. This returns a much larger number than LanguageProfile.getNumGrams(int).

Specified by:

getNumGramOccurrences in interface LanguageProfile

Parameters:

gramLength - 1-n

Returns:

0-n, returns zero if no such n-grams were made (for example if no 4-grams were made), or if all the training text did not contain such long words.

getMinGramCount

public long getMinGramCount(int gramLength)

Description copied from interface: LanguageProfile

Tells how often the n-gram with the lowest amount of occurrences used in this profile occurred. Most likely there were n-grams with less (unless the returned number is 1), but they were eliminated in order to keep the profile reasonably small. This is the opposite of getMaxGramCount().

Specified by:

getMinGramCount in interface LanguageProfile

Parameters:

gramLength - 1-n

Returns:

0-n, returns zero if no such n-grams were made or existed.

getMaxGramCount

public long getMaxGramCount(int gramLength)

Description copied from interface: LanguageProfile

Tells how often the n-gram with the highest amount of occurrences used in this profile occurred. This is the opposite of getMinGramCount().

Specified by:

getMaxGramCount in interface LanguageProfile

Parameters:

gramLength - 1-n

Returns:

0-n, returns zero if no such n-grams were made or existed.

iterateGrams

@NotNull
public Iterable<Map.Entry<String,Integer>> iterateGrams()

Description copied from interface: LanguageProfile

Iterates all ngram strings with frequency.

Specified by:

iterateGrams in interface LanguageProfile

iterateGrams

@NotNull
public Iterable<Map.Entry<String,Integer>> iterateGrams(int gramLength)

Description copied from interface: LanguageProfile

Iterates all gramLength-gram strings with frequency.

Specified by:

iterateGrams in interface LanguageProfile

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object