docs/2.3.3/apidocs/opennlp-tools/opennlp/tools/ml/BeamSearch.html - opennlp-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>BeamSearch (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.ml, class: BeamSearch">
 <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><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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.ml</a></div>
 <h1 title="Class BeamSearch" class="title">Class BeamSearch&lt;T&gt;</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.ml.BeamSearch&lt;T&gt;</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;T&gt;</code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BeamSearch&lt;T&gt;</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>
 implements <a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;T&gt;</span></div>
 <div class="block">Performs k-best search over a sequence.
  <p>
  This is based on the description in Ratnaparkhi (1998),
  PhD diss, Univ. of Pennsylvania.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a></li>
 <li><a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a></li>
 <li><a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>BeamSearchContextGenerator</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <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></code></div>
 <div class="col-second even-row-color"><code><a href="#BEAM_SIZE_PARAMETER" class="member-name-link">BEAM_SIZE_PARAMETER</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ======== 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(int,opennlp.tools.ml.model.MaxentModel)" class="member-name-link">BeamSearch</a><wbr>(int&nbsp;size,
  <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a>&nbsp;model)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Initializes a <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> instance.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,opennlp.tools.ml.model.MaxentModel,int)" class="member-name-link">BeamSearch</a><wbr>(int&nbsp;size,
  <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a>&nbsp;model,
  int&nbsp;cacheSize)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Initializes a <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> instance.</div>
 </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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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-tab2 method-summary-table-tab4"><code><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bestSequence(T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequence</a><wbr>(<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequences</a><wbr>(int&nbsp;numSequences,
  <a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  double&nbsp;minSequenceScore,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)" class="member-name-link">bestSequences</a><wbr>(int&nbsp;numSequences,
  <a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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>[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOutcomes()" class="member-name-link">getOutcomes</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="BEAM_SIZE_PARAMETER">
 <h3>BEAM_SIZE_PARAMETER</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">BEAM_SIZE_PARAMETER</span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../constant-values.html#opennlp.tools.ml.BeamSearch.BEAM_SIZE_PARAMETER">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= 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;(int,opennlp.tools.ml.model.MaxentModel)">
 <h3>BeamSearch</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BeamSearch</span><wbr><span class="parameters">(int&nbsp;size,
  <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a>&nbsp;model)</span></div>
 <div class="block">Initializes a <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> instance.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>size</code> - The size of the beam (k).</dd>
 <dd><code>model</code> - The <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a> for assigning probabilities to the sequence outcomes.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(int,opennlp.tools.ml.model.MaxentModel,int)">
 <h3>BeamSearch</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BeamSearch</span><wbr><span class="parameters">(int&nbsp;size,
  <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a>&nbsp;model,
  int&nbsp;cacheSize)</span></div>
 <div class="block">Initializes a <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> instance.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>size</code> - The size of the beam (k).</dd>
 <dd><code>model</code> - The <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a> for assigning probabilities to the sequence outcomes.</dd>
 <dd><code>cacheSize</code> - The capacity of the <a href="../util/Cache.html" title="class in opennlp.tools.util"><code>Cache</code></a> to use.</dd>
 </dl>
 </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="bestSequences(int,T[],java.lang.Object[],double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
 <h3 id="bestSequences(int,java.lang.Object[],java.lang.Object[],double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</span>&nbsp;<span class="element-name">bestSequences</span><wbr><span class="parameters">(int&nbsp;numSequences,
  <a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  double&nbsp;minSequenceScore,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</span></div>
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="model/SequenceClassificationModel.html#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,double,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</a></code>&nbsp;in interface&nbsp;<code><a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>numSequences</code> - The number of sequences.</dd>
 <dd><code>sequence</code> - The input <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> sequence.</dd>
 <dd><code>additionalContext</code> - An <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"><code>Object</code></a> of additional context.
      This is passed to the context generator blindly with the
      assumption that the context are appropriate.</dd>
 <dd><code>minSequenceScore</code> - The minimum sequence score to use.</dd>
 <dd><code>cg</code> - The <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>context generator</code></a> to use.</dd>
 <dd><code>validator</code> - The <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate sequences.</dd>
 <dt>Returns:</dt>
 <dd>The top ranked <a href="../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> of outcomes or <code>null</code>
          if no sequence could be found.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="bestSequences(int,T[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
 <h3 id="bestSequences(int,java.lang.Object[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a>[]</span>&nbsp;<span class="element-name">bestSequences</span><wbr><span class="parameters">(int&nbsp;numSequences,
  <a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</span></div>
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="model/SequenceClassificationModel.html#bestSequences(int,T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequences</a></code>&nbsp;in interface&nbsp;<code><a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>numSequences</code> - The number of sequences.</dd>
 <dd><code>sequence</code> - The input <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> sequence.</dd>
 <dd><code>additionalContext</code> - An <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"><code>Object</code></a> of additional context.
      This is passed to the context generator blindly with the
      assumption that the context are appropriate.</dd>
 <dd><code>cg</code> - The <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>context generator</code></a> to use.</dd>
 <dd><code>validator</code> - The <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate sequences.</dd>
 <dt>Returns:</dt>
 <dd>The top ranked <a href="../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> of outcomes or <code>null</code>
          if no sequence could be found.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="bestSequence(T[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">
 <h3 id="bestSequence(java.lang.Object[],java.lang.Object[],opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequence</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Sequence.html" title="class in opennlp.tools.util">Sequence</a></span>&nbsp;<span class="element-name">bestSequence</span><wbr><span class="parameters">(<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>[]&nbsp;sequence,
  <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>[]&nbsp;additionalContext,
  <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;cg,
  <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;&nbsp;validator)</span></div>
 <div class="block">Computes the best sequence of outcomes based on the <a href="model/MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="model/SequenceClassificationModel.html#bestSequence(T%5B%5D,java.lang.Object%5B%5D,opennlp.tools.util.BeamSearchContextGenerator,opennlp.tools.util.SequenceValidator)">bestSequence</a></code>&nbsp;in interface&nbsp;<code><a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>sequence</code> - The input <a href="BeamSearch.html" title="class in opennlp.tools.ml"><code>BeamSearch</code></a> sequence.</dd>
 <dd><code>additionalContext</code> - An <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"><code>Object</code></a> of additional context.
      This is passed to the context generator blindly with the
      assumption that the context are appropriate.</dd>
 <dd><code>cg</code> - The <a href="../util/BeamSearchContextGenerator.html" title="interface in opennlp.tools.util"><code>context generator</code></a> to use.</dd>
 <dd><code>validator</code> - The <a href="../util/SequenceValidator.html" title="interface in opennlp.tools.util"><code>SequenceValidator</code></a> to validate sequences.</dd>
 <dt>Returns:</dt>
 <dd>The top ranked <a href="../util/Sequence.html" title="class in opennlp.tools.util"><code>Sequence</code></a> of outcomes or <code>null</code>
          if no sequence could be found.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getOutcomes()">
 <h3>getOutcomes</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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>[]</span>&nbsp;<span class="element-name">getOutcomes</span>()</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="model/SequenceClassificationModel.html#getOutcomes()">getOutcomes</a></code>&nbsp;in interface&nbsp;<code><a href="model/SequenceClassificationModel.html" title="interface in opennlp.tools.ml.model">SequenceClassificationModel</a>&lt;<a href="BeamSearch.html" title="type parameter in BeamSearch">T</a>&gt;</code></dd>
 <dt>Returns:</dt>
 <dd>Retrieves all possible outcomes.</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>