Google Git
Sign in
apache / opennlp-site / 176e3979407c843c86ef619262b2a3ac476de972 / . / docs / 2.3.3 / apidocs / opennlp-tools / opennlp / tools / ml / model / AbstractModel.html
blob: 4356e1a0a9540b07a02c0cd04d5c233e99a09b27 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>AbstractModel (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.model, class: AbstractModel">
<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><a href="#nested-class-summary">Nested</a>&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.ml.model</a></div>
<h1 title="Class AbstractModel" class="title">Class AbstractModel</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.model.AbstractModel</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../maxent/GISModel.html" title="class in opennlp.tools.ml.maxent">GISModel</a></code>, <code><a href="../naivebayes/NaiveBayesModel.html" title="class in opennlp.tools.ml.naivebayes">NaiveBayesModel</a></code>, <code><a href="../perceptron/PerceptronModel.html" title="class in opennlp.tools.ml.perceptron">PerceptronModel</a></code>, <code><a href="../maxent/quasinewton/QNModel.html" title="class in opennlp.tools.ml.maxent.quasinewton">QNModel</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractModel</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="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></span></div>
<div class="block">A basic <a href="MaxentModel.html" title="interface in opennlp.tools.ml.model"><code>MaxentModel</code></a> implementation.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="AbstractModel.ModelType.html" class="type-name-link" title="enum class in opennlp.tools.ml.model">AbstractModel.ModelType</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(opennlp.tools.ml.model.Context%5B%5D,java.lang.String%5B%5D,java.lang.String%5B%5D)" class="member-name-link">AbstractModel</a><wbr>(<a href="Context.html" title="class in opennlp.tools.ml.model">Context</a>[]&nbsp;params,
<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;predLabels,
<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;outcomeNames)</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes an <a href="AbstractModel.html" title="class in opennlp.tools.ml.model"><code>AbstractModel</code></a>.</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>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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;obj)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllOutcomes(double%5B%5D)" class="member-name-link">getAllOutcomes</a><wbr>(double[]&nbsp;ocs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Retrieves a string matching all the outcome names with all the
probabilities produced by the <a href="MaxentModel.html#eval(java.lang.String%5B%5D)"><code>MaxentModel.eval(String[])</code></a> method.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBestOutcome(double%5B%5D)" class="member-name-link">getBestOutcome</a><wbr>(double[]&nbsp;ocs)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the name of the outcome corresponding to the highest likelihood
in the parameter ocs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataStructures()" class="member-name-link">getDataStructures</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Provides the fundamental data structures which encode the maxent model
information.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIndex(java.lang.String)" class="member-name-link">getIndex</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;outcome)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Retrieves the index associated with the String name of the given
outcome.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractModel.ModelType.html" title="enum class in opennlp.tools.ml.model">AbstractModel.ModelType</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModelType()" class="member-name-link">getModelType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumOutcomes()" class="member-name-link">getNumOutcomes</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOutcome(int)" class="member-name-link">getOutcome</a><wbr>(int&nbsp;i)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Retrieves the String name of the outcome associated with the index <code>i</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-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#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#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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.ml.model.MaxentModel">Methods inherited from interface&nbsp;opennlp.tools.ml.model.<a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></h3>
<code><a href="MaxentModel.html#eval(java.lang.String%5B%5D)">eval</a>, <a href="MaxentModel.html#eval(java.lang.String%5B%5D,double%5B%5D)">eval</a>, <a href="MaxentModel.html#eval(java.lang.String%5B%5D,float%5B%5D)">eval</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;(opennlp.tools.ml.model.Context[],java.lang.String[],java.lang.String[])">
<h3>AbstractModel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AbstractModel</span><wbr><span class="parameters">(<a href="Context.html" title="class in opennlp.tools.ml.model">Context</a>[]&nbsp;params,
<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;predLabels,
<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;outcomeNames)</span></div>
<div class="block">Initializes an <a href="AbstractModel.html" title="class in opennlp.tools.ml.model"><code>AbstractModel</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>params</code> - The <a href="Context.html" title="class in opennlp.tools.ml.model"><code>parameters</code></a> to set.</dd>
<dd><code>predLabels</code> - The predicted labels.</dd>
<dd><code>outcomeNames</code> - The names of the outcomes.</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="getBestOutcome(double[])">
<h3>getBestOutcome</h3>
<div class="member-signature"><span class="modifiers">public 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">getBestOutcome</span><wbr><span class="parameters">(double[]&nbsp;ocs)</span></div>
<div class="block">Return the name of the outcome corresponding to the highest likelihood
in the parameter ocs.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="MaxentModel.html#getBestOutcome(double%5B%5D)">getBestOutcome</a></code>&nbsp;in interface&nbsp;<code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
<dt>Parameters:</dt>
<dd><code>ocs</code> - A double[] as returned by the eval(String[] context)
method.</dd>
<dt>Returns:</dt>
<dd>The name of the most likely outcome.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getModelType()">
<h3>getModelType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AbstractModel.ModelType.html" title="enum class in opennlp.tools.ml.model">AbstractModel.ModelType</a></span>&nbsp;<span class="element-name">getModelType</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Retrieves the <a href="AbstractModel.ModelType.html" title="enum class in opennlp.tools.ml.model"><code>AbstractModel.ModelType</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAllOutcomes(double[])">
<h3>getAllOutcomes</h3>
<div class="member-signature"><span class="modifiers">public 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">getAllOutcomes</span><wbr><span class="parameters">(double[]&nbsp;ocs)</span></div>
<div class="block">Retrieves a string matching all the outcome names with all the
probabilities produced by the <a href="MaxentModel.html#eval(java.lang.String%5B%5D)"><code>MaxentModel.eval(String[])</code></a> method.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="MaxentModel.html#getAllOutcomes(double%5B%5D)">getAllOutcomes</a></code>&nbsp;in interface&nbsp;<code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
<dt>Parameters:</dt>
<dd><code>ocs</code> - A <code>double[]</code> as returned by the
<a href="MaxentModel.html#eval(java.lang.String%5B%5D)"><code>MaxentModel.eval(String[])</code></a> method.</dd>
<dt>Returns:</dt>
<dd>String containing outcome names paired with the normalized
probability (contained in the <code>double[] ocs</code>)
for each one.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOutcome(int)">
<h3>getOutcome</h3>
<div class="member-signature"><span class="modifiers">public 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">getOutcome</span><wbr><span class="parameters">(int&nbsp;i)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="MaxentModel.html#getOutcome(int)">MaxentModel</a></code></span></div>
<div class="block">Retrieves the String name of the outcome associated with the index <code>i</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="MaxentModel.html#getOutcome(int)">getOutcome</a></code>&nbsp;in interface&nbsp;<code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
<dt>Parameters:</dt>
<dd><code>i</code> - An outcome id.</dd>
<dt>Returns:</dt>
<dd>Retrieves the name of the outcome associated with that id.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIndex(java.lang.String)">
<h3>getIndex</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getIndex</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;outcome)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="MaxentModel.html#getIndex(java.lang.String)">MaxentModel</a></code></span></div>
<div class="block">Retrieves the index associated with the String name of the given
outcome.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="MaxentModel.html#getIndex(java.lang.String)">getIndex</a></code>&nbsp;in interface&nbsp;<code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
<dt>Parameters:</dt>
<dd><code>outcome</code> - The String name of the outcome for which the index is desired.</dd>
<dt>Returns:</dt>
<dd>Retrieves the index if the given <code>outcome</code> label exists for this
model, <code>-1</code> if it does not.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNumOutcomes()">
<h3>getNumOutcomes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getNumOutcomes</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="MaxentModel.html#getNumOutcomes()">getNumOutcomes</a></code>&nbsp;in interface&nbsp;<code><a href="MaxentModel.html" title="interface in opennlp.tools.ml.model">MaxentModel</a></code></dd>
<dt>Returns:</dt>
<dd>Retrieves the number of outcomes for this model.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDataStructures()">
<h3>getDataStructures</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><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>&nbsp;<span class="element-name">getDataStructures</span>()</div>
<div class="block">Provides the fundamental data structures which encode the maxent model
information. Note: This method will usually only be needed by
<a href="../maxent/io/GISModelWriter.html" title="class in opennlp.tools.ml.maxent.io"><code>GIS model writers</code></a>.
<p>
The following values are held in the Object array which is returned by this method:
<ul>
<li>index 0: <a href="Context.html" title="class in opennlp.tools.ml.model"><code>Context</code></a> array containing the model parameters.</li>
<li>index 1: <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link"><code>Map</code></a> containing the mapping of model predicates
to unique integers.</li>
<li>index 2: <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"><code>String</code></a> array containing the names of the outcomes,
stored in the index of the array which represents their
unique ids in the model.</li>
</ul></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>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> array with the values as described above.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<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;obj)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><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></code>&nbsp;in class&nbsp;<code><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></code></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>