docs/2.3.3/apidocs/opennlp-tools/opennlp/tools/ngram/NGramUtils.html - opennlp-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>NGramUtils (Apache OpenNLP Tools 2.3.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: opennlp.tools.ngram, class: NGramUtils">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 <script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">opennlp.tools.ngram</a></div>
 <h1 title="Class NGramUtils" class="title">Class NGramUtils</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">opennlp.tools.ngram.NGramUtils</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">NGramUtils</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Utility class for ngrams.
  Some methods apply specifically to certain 'n' values, for e.g. tri/bi/uni-grams.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">NGramUtils</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateBigramMLProbability(java.lang.String,java.lang.String,java.util.Collection)" class="member-name-link">calculateBigramMLProbability</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a bigram in a vocabulary using maximum likelihood estimation</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateBigramPriorSmoothingProbability(java.lang.String,java.lang.String,java.util.Collection,java.lang.Double)" class="member-name-link">calculateBigramPriorSmoothingProbability</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;k)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a bigram in a vocabulary using prior Laplace smoothing algorithm</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateLaplaceSmoothingProbability(opennlp.tools.util.StringList,java.lang.Iterable,java.lang.Double)" class="member-name-link">calculateLaplaceSmoothingProbability</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;k)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a ngram in a vocabulary using Laplace smoothing algorithm</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMissingNgramProbabilityMass(opennlp.tools.util.StringList,double,java.lang.Iterable)" class="member-name-link">calculateMissingNgramProbabilityMass</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  double&nbsp;discount,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a ngram in a vocabulary using the missing probability mass algorithm</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateNgramMLProbability(opennlp.tools.util.StringList,java.lang.Iterable)" class="member-name-link">calculateNgramMLProbability</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a ngram in a vocabulary using maximum likelihood estimation</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateTrigramLinearInterpolationProbability(java.lang.String,java.lang.String,java.lang.String,java.util.Collection,java.lang.Double,java.lang.Double,java.lang.Double)" class="member-name-link">calculateTrigramLinearInterpolationProbability</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda3)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a trigram in a vocabulary using a linear interpolation algorithm</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateTrigramMLProbability(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable)" class="member-name-link">calculateTrigramMLProbability</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a trigram in a vocabulary using maximum likelihood estimation</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateUnigramMLProbability(java.lang.String,java.util.Collection)" class="member-name-link">calculateUnigramMLProbability</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;word,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">calculate the probability of a unigram in a vocabulary using maximum likelihood estimation</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNGrams(java.lang.String%5B%5D,int)" class="member-name-link">getNGrams</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;sequence,
  int&nbsp;size)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Get the ngrams of dimension n of a certain input sequence of tokens.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNGrams(opennlp.tools.util.StringList,int)" class="member-name-link">getNGrams</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;sequence,
  int&nbsp;size)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Get the ngrams of dimension n of a certain input sequence of tokens.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNMinusOneTokenFirst(opennlp.tools.util.StringList)" class="member-name-link">getNMinusOneTokenFirst</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">get the (n-1)th ngram of a given ngram, that is the same ngram except the last word in the ngram</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNMinusOneTokenLast(opennlp.tools.util.StringList)" class="member-name-link">getNMinusOneTokenLast</a><wbr>(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">get the (n-1)th ngram of a given ngram, that is the same ngram except the first word in the ngram</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>NGramUtils</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">NGramUtils</span>()</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="calculateLaplaceSmoothingProbability(opennlp.tools.util.StringList,java.lang.Iterable,java.lang.Double)">
 <h3>calculateLaplaceSmoothingProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateLaplaceSmoothingProbability</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;k)</span></div>
 <div class="block">calculate the probability of a ngram in a vocabulary using Laplace smoothing algorithm</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ngram</code> - the ngram to get the probability for</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dd><code>k</code> - the smoothing factor</dd>
 <dt>Returns:</dt>
 <dd>the Laplace smoothing probability</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="https://en.wikipedia.org/wiki/Additive_smoothing">Additive Smoothing</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateUnigramMLProbability(java.lang.String,java.util.Collection)">
 <h3>calculateUnigramMLProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateUnigramMLProbability</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;word,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</span></div>
 <div class="block">calculate the probability of a unigram in a vocabulary using maximum likelihood estimation</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>word</code> - the only word in the unigram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dt>Returns:</dt>
 <dd>the maximum likelihood probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateBigramMLProbability(java.lang.String,java.lang.String,java.util.Collection)">
 <h3>calculateBigramMLProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateBigramMLProbability</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</span></div>
 <div class="block">calculate the probability of a bigram in a vocabulary using maximum likelihood estimation</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>x0</code> - first word in the bigram</dd>
 <dd><code>x1</code> - second word in the bigram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dt>Returns:</dt>
 <dd>the maximum likelihood probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateTrigramMLProbability(java.lang.String,java.lang.String,java.lang.String,java.lang.Iterable)">
 <h3>calculateTrigramMLProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateTrigramMLProbability</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</span></div>
 <div class="block">calculate the probability of a trigram in a vocabulary using maximum likelihood estimation</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>x0</code> - first word in the trigram</dd>
 <dd><code>x1</code> - second word in the trigram</dd>
 <dd><code>x2</code> - third word in the trigram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dt>Returns:</dt>
 <dd>the maximum likelihood probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateNgramMLProbability(opennlp.tools.util.StringList,java.lang.Iterable)">
 <h3>calculateNgramMLProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateNgramMLProbability</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</span></div>
 <div class="block">calculate the probability of a ngram in a vocabulary using maximum likelihood estimation</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ngram</code> - a ngram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dt>Returns:</dt>
 <dd>the maximum likelihood probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateBigramPriorSmoothingProbability(java.lang.String,java.lang.String,java.util.Collection,java.lang.Double)">
 <h3>calculateBigramPriorSmoothingProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateBigramPriorSmoothingProbability</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;k)</span></div>
 <div class="block">calculate the probability of a bigram in a vocabulary using prior Laplace smoothing algorithm</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>x0</code> - the first word in the bigram</dd>
 <dd><code>x1</code> - the second word in the bigram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dd><code>k</code> - the smoothing factor</dd>
 <dt>Returns:</dt>
 <dd>the prior Laplace smoothing probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateTrigramLinearInterpolationProbability(java.lang.String,java.lang.String,java.lang.String,java.util.Collection,java.lang.Double,java.lang.Double,java.lang.Double)">
 <h3>calculateTrigramLinearInterpolationProbability</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateTrigramLinearInterpolationProbability</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x0,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;x2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda1,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda2,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&nbsp;lambda3)</span></div>
 <div class="block">calculate the probability of a trigram in a vocabulary using a linear interpolation algorithm</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>x0</code> - the first word in the trigram</dd>
 <dd><code>x1</code> - the second word in the trigram</dd>
 <dd><code>x2</code> - the third word in the trigram</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dd><code>lambda1</code> - trigram interpolation factor</dd>
 <dd><code>lambda2</code> - bigram interpolation factor</dd>
 <dd><code>lambda3</code> - unigram interpolation factor</dd>
 <dt>Returns:</dt>
 <dd>the linear interpolation probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="calculateMissingNgramProbabilityMass(opennlp.tools.util.StringList,double,java.lang.Iterable)">
 <h3>calculateMissingNgramProbabilityMass</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calculateMissingNgramProbabilityMass</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram,
  double&nbsp;discount,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;&nbsp;set)</span></div>
 <div class="block">calculate the probability of a ngram in a vocabulary using the missing probability mass algorithm</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ngram</code> - the ngram</dd>
 <dd><code>discount</code> - discount factor</dd>
 <dd><code>set</code> - the vocabulary</dd>
 <dt>Returns:</dt>
 <dd>the probability</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getNMinusOneTokenFirst(opennlp.tools.util.StringList)">
 <h3>getNMinusOneTokenFirst</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a></span>&nbsp;<span class="element-name">getNMinusOneTokenFirst</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram)</span></div>
 <div class="block">get the (n-1)th ngram of a given ngram, that is the same ngram except the last word in the ngram</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ngram</code> - a ngram</dd>
 <dt>Returns:</dt>
 <dd>a ngram</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getNMinusOneTokenLast(opennlp.tools.util.StringList)">
 <h3>getNMinusOneTokenLast</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a></span>&nbsp;<span class="element-name">getNMinusOneTokenLast</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;ngram)</span></div>
 <div class="block">get the (n-1)th ngram of a given ngram, that is the same ngram except the first word in the ngram</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ngram</code> - a ngram</dd>
 <dt>Returns:</dt>
 <dd>a ngram</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getNGrams(opennlp.tools.util.StringList,int)">
 <h3>getNGrams</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&gt;</span>&nbsp;<span class="element-name">getNGrams</span><wbr><span class="parameters">(<a href="../util/StringList.html" title="class in opennlp.tools.util">StringList</a>&nbsp;sequence,
  int&nbsp;size)</span></div>
 <div class="block">Get the ngrams of dimension n of a certain input sequence of tokens.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>sequence</code> - a sequence of tokens</dd>
 <dd><code>size</code> - the size of the resulting ngrmams</dd>
 <dt>Returns:</dt>
 <dd>all the possible ngrams of the given size derivable from the input sequence</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getNGrams(java.lang.String[],int)">
 <h3>getNGrams</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&gt;</span>&nbsp;<span class="element-name">getNGrams</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;sequence,
  int&nbsp;size)</span></div>
 <div class="block">Get the ngrams of dimension n of a certain input sequence of tokens.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>sequence</code> - a sequence of tokens</dd>
 <dd><code>size</code> - the size of the resulting ngrmams</dd>
 <dt>Returns:</dt>
 <dd>all the possible ngrams of the given size derivable from the input sequence</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>