com.optimaize.langdetect

Class NgramFrequencyData

java.lang.Object

com.optimaize.langdetect.NgramFrequencyData

public final class NgramFrequencyData
extends java.lang.Object

Contains frequency information for ngram strings and the languages.

Immutable by definition (can't make Arrays unmodifiable).

Field Summary

Fields

Modifier and Type	Field and Description
private @NotNull java.util.List<LdLocale>	langlist All the loaded languages, order is important.
private @NotNull java.util.Map<java.lang.String,double[]>	wordLangProbMap Key=ngram Value = array with probabilities per loaded language, in the same order as langlist.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	NgramFrequencyData(@NotNull java.util.Map<java.lang.String,double[]> wordLangProbMap, @NotNull java.util.List<LdLocale> langlist)

Method Summary

Modifier and Type	Method and Description
static @NotNull NgramFrequencyData	create(@NotNull java.util.Collection<LanguageProfile> languageProfiles, @NotNull java.util.Collection<java.lang.Integer> gramLengths)
@NotNull LdLocale	getLanguage(int pos)
@NotNull java.util.List<LdLocale>	getLanguageList()
@Nullable double[]	getProbabilities(java.lang.String ngram) Don't modify this data structure! (Can't make array immutable...)

Methods inherited from class java.lang.Object

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

Field Detail

wordLangProbMap

@NotNull
private final @NotNull java.util.Map<java.lang.String,double[]> wordLangProbMap

Key=ngram Value = array with probabilities per loaded language, in the same order as langlist.

langlist

@NotNull
private final @NotNull java.util.List<LdLocale> langlist

All the loaded languages, order is important.

Constructor Detail

NgramFrequencyData

private NgramFrequencyData(@NotNull
                           @NotNull java.util.Map<java.lang.String,double[]> wordLangProbMap,
                           @NotNull
                           @NotNull java.util.List<LdLocale> langlist)

Method Detail

create

@NotNull
public static @NotNull NgramFrequencyData create(@NotNull
                                                          @NotNull java.util.Collection<LanguageProfile> languageProfiles,
                                                          @NotNull
                                                          @NotNull java.util.Collection<java.lang.Integer> gramLengths)
                                                   throws java.lang.IllegalArgumentException

Parameters:

gramLengths - for example [1,2,3]

Throws:

java.lang.IllegalArgumentException - if languageProfiles or gramLengths is empty, or if one of the languageProfiles does not have the grams of the required sizes.

getLanguageList

@NotNull
public @NotNull java.util.List<LdLocale> getLanguageList()

getLanguage

@NotNull
public @NotNull LdLocale getLanguage(int pos)

getProbabilities

@Nullable
public @Nullable double[] getProbabilities(java.lang.String ngram)

Don't modify this data structure! (Can't make array immutable...)

Returns:

null if no language profile knows that ngram. entries are 0 for languages that don't know that ngram at all. The array is in the order of the getLanguageList() language list, and has exactly that size. impl note: this way the caller can handle it more efficient than returning an empty array.