## Uses of Class
opennlp.tools.util.StringList

- Packages that use StringList
  Package | Description
  --- | ---
  opennlp.tools.cmdline.namefind |
  opennlp.tools.dictionary | Package related to parsing and storing dictionaries.
  opennlp.tools.dictionary.serializer |
  opennlp.tools.formats | Experimental package related to converting various corpora to OpenNLP Format.
  opennlp.tools.languagemodel | Package related to language models
  opennlp.tools.ngram | Package related to computing and storing n-gram frequencies.
  opennlp.tools.util | Package containing utility data structures and algorithms used by multiple other packages.

- - ### Uses of StringList in opennlp.tools.cmdline.namefind

    Method parameters in opennlp.tools.cmdline.namefind with type arguments of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Dictionary` | CensusDictionaryCreatorTool.`createDictionary​(ObjectStream<StringList> sampleStream)` | Creates a dictionary.

  - ### Uses of StringList in opennlp.tools.dictionary

    Methods in opennlp.tools.dictionary that return types with arguments of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `Iterator<StringList>` | Dictionary.`iterator()` |

    Methods in opennlp.tools.dictionary with parameters of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | Dictionary.`contains​(StringList tokens)` | Checks if this dictionary has the given entry.
    `void` | Dictionary.`put​(StringList tokens)` | Adds the tokens to the dictionary as one new entry.
    `void` | Dictionary.`remove​(StringList tokens)` | Removes the given tokens form the current instance.

    Constructor parameters in opennlp.tools.dictionary with type arguments of type StringList
    Constructor | Description
    --- | ---
    `Index​(Iterator<StringList> tokenLists)` | Initializes an `Index` with the given `Iterator` over `StringList` elements.

  - ### Uses of StringList in opennlp.tools.dictionary.serializer

    Methods in opennlp.tools.dictionary.serializer that return StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `StringList` | Entry.`getTokens()` |

    Constructors in opennlp.tools.dictionary.serializer with parameters of type StringList
    Constructor | Description
    --- | ---
    `Entry​(StringList tokens, Attributes attributes)` | Initializes an `Entry`.

  - ### Uses of StringList in opennlp.tools.formats

    Methods in opennlp.tools.formats that return StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `StringList` | NameFinderCensus90NameStream.`read()` |

  - ### Uses of StringList in opennlp.tools.languagemodel

    Methods in opennlp.tools.languagemodel that return StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `StringList` | LanguageModel.`predictNextTokens​(StringList tokens)` | Deprecated. use `LanguageModel.predictNextTokens(String...)`
    `StringList` | NGramLanguageModel.`predictNextTokens​(StringList tokens)` | Deprecated.

    Methods in opennlp.tools.languagemodel with parameters of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `StringList` | LanguageModel.`predictNextTokens​(StringList tokens)` | Deprecated. use `LanguageModel.predictNextTokens(String...)`
    `StringList` | NGramLanguageModel.`predictNextTokens​(StringList tokens)` | Deprecated.

  - ### Uses of StringList in opennlp.tools.ngram

    Methods in opennlp.tools.ngram that return StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `static StringList` | NGramUtils.`getNMinusOneTokenFirst​(StringList ngram)` | get the (n-1)th ngram of a given ngram, that is the same ngram except the last word in the ngram
    `static StringList` | NGramUtils.`getNMinusOneTokenLast​(StringList ngram)` | get the (n-1)th ngram of a given ngram, that is the same ngram except the first word in the ngram

    Methods in opennlp.tools.ngram that return types with arguments of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Collection<StringList>` | NGramUtils.`getNGrams​(StringList sequence, int size)` | Get the ngrams of dimension n of a certain input sequence of tokens.
    `Iterator<StringList>` | NGramModel.`iterator()` | Retrieves an `Iterator` over all `StringList` entries.

    Methods in opennlp.tools.ngram with parameters of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | NGramModel.`add​(StringList ngram)` | Adds one NGram, if it already exists the count increase by one.
    `void` | NGramModel.`add​(StringList ngram, int minLength, int maxLength)` | Adds NGrams up to the specified length to the current instance.
    `static double` | NGramUtils.`calculateLaplaceSmoothingProbability​(StringList ngram, Iterable<StringList> set, Double k)` | calculate the probability of a ngram in a vocabulary using Laplace smoothing algorithm
    `static double` | NGramUtils.`calculateMissingNgramProbabilityMass​(StringList ngram, double discount, Iterable<StringList> set)` | calculate the probability of a ngram in a vocabulary using the missing probability mass algorithm
    `static double` | NGramUtils.`calculateNgramMLProbability​(StringList ngram, Iterable<StringList> set)` | calculate the probability of a ngram in a vocabulary using maximum likelihood estimation
    `boolean` | NGramModel.`contains​(StringList tokens)` | Checks fit he given tokens are contained by the current instance.
    `int` | NGramModel.`getCount​(StringList ngram)` | Retrieves the count of the given ngram.
    `static Collection<StringList>` | NGramUtils.`getNGrams​(StringList sequence, int size)` | Get the ngrams of dimension n of a certain input sequence of tokens.
    `static StringList` | NGramUtils.`getNMinusOneTokenFirst​(StringList ngram)` | get the (n-1)th ngram of a given ngram, that is the same ngram except the last word in the ngram
    `static StringList` | NGramUtils.`getNMinusOneTokenLast​(StringList ngram)` | get the (n-1)th ngram of a given ngram, that is the same ngram except the first word in the ngram
    `void` | NGramModel.`remove​(StringList tokens)` | Removes the specified tokens form the NGram model, they are just dropped.
    `void` | NGramModel.`setCount​(StringList ngram, int count)` | Sets the count of an existing ngram.

    Method parameters in opennlp.tools.ngram with type arguments of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `static double` | NGramUtils.`calculateBigramMLProbability​(String x0, String x1, Collection<StringList> set)` | calculate the probability of a bigram in a vocabulary using maximum likelihood estimation
    `static double` | NGramUtils.`calculateBigramPriorSmoothingProbability​(String x0, String x1, Collection<StringList> set, Double k)` | calculate the probability of a bigram in a vocabulary using prior Laplace smoothing algorithm
    `static double` | NGramUtils.`calculateLaplaceSmoothingProbability​(StringList ngram, Iterable<StringList> set, Double k)` | calculate the probability of a ngram in a vocabulary using Laplace smoothing algorithm
    `static double` | NGramUtils.`calculateMissingNgramProbabilityMass​(StringList ngram, double discount, Iterable<StringList> set)` | calculate the probability of a ngram in a vocabulary using the missing probability mass algorithm
    `static double` | NGramUtils.`calculateNgramMLProbability​(StringList ngram, Iterable<StringList> set)` | calculate the probability of a ngram in a vocabulary using maximum likelihood estimation
    `static double` | NGramUtils.`calculateTrigramLinearInterpolationProbability​(String x0, String x1, String x2, Collection<StringList> set, Double lambda1, Double lambda2, Double lambda3)` | calculate the probability of a trigram in a vocabulary using a linear interpolation algorithm
    `static double` | NGramUtils.`calculateTrigramMLProbability​(String x0, String x1, String x2, Iterable<StringList> set)` | calculate the probability of a trigram in a vocabulary using maximum likelihood estimation
    `static double` | NGramUtils.`calculateUnigramMLProbability​(String word, Collection<StringList> set)` | calculate the probability of a unigram in a vocabulary using maximum likelihood estimation

  - ### Uses of StringList in opennlp.tools.util

    Methods in opennlp.tools.util with parameters of type StringList
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | StringList.`compareToIgnoreCase​(StringList tokens)` | Compares to `token list` and ignores the case of the tokens.