blob: 531c34e1fabdc8a9562eb055a3c2bccc0654aa25 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Prior (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, interface: Prior">
<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>Constr&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>Constr&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="Interface Prior" class="title">Interface Prior</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="UniformPrior.html" title="class in opennlp.tools.ml.model">UniformPrior</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Prior</span></div>
<div class="block">This interface allows one to implement a prior distribution for use in
maximum entropy model training.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#logPrior(double%5B%5D,int%5B%5D)" class="member-name-link">logPrior</a><wbr>(double[]&nbsp;dist,
int[]&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Populates the specified array with the log of the distribution for the specified context.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#logPrior(double%5B%5D,int%5B%5D,float%5B%5D)" class="member-name-link">logPrior</a><wbr>(double[]&nbsp;dist,
int[]&nbsp;context,
float[]&nbsp;values)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Populates the specified array with the log of the distribution for the specified context.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#logPrior(double%5B%5D,opennlp.tools.ml.model.Context%5B%5D,float%5B%5D)" class="member-name-link">logPrior</a><wbr>(double[]&nbsp;dist,
<a href="Context.html" title="class in opennlp.tools.ml.model">Context</a>[]&nbsp;context,
float[]&nbsp;values)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Populates the specified array with the log of the distribution for the specified context.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLabels(java.lang.String%5B%5D,java.lang.String%5B%5D)" class="member-name-link">setLabels</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;outcomeLabels,
<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;contextLabels)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Method to specify the label for the outcomes and contexts.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="logPrior(double[],int[])">
<h3>logPrior</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">logPrior</span><wbr><span class="parameters">(double[]&nbsp;dist,
int[]&nbsp;context)</span></div>
<div class="block">Populates the specified array with the log of the distribution for the specified context.
The returned array will be overwritten and needs to be re-initialized with every call to this method.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dist</code> - An array to be populated with the log of the prior distribution.</dd>
<dd><code>context</code> - The indices of the contextual predicates for an event.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="logPrior(double[],int[],float[])">
<h3>logPrior</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">logPrior</span><wbr><span class="parameters">(double[]&nbsp;dist,
int[]&nbsp;context,
float[]&nbsp;values)</span></div>
<div class="block">Populates the specified array with the log of the distribution for the specified context.
The returned array will be overwritten and needs to be re-initialized with every call to this method.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dist</code> - An array to be populated with the log of the prior distribution.</dd>
<dd><code>context</code> - The indices of the contextual predicates for an event.</dd>
<dd><code>values</code> - The values associated with the context.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="logPrior(double[],opennlp.tools.ml.model.Context[],float[])">
<h3>logPrior</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">logPrior</span><wbr><span class="parameters">(double[]&nbsp;dist,
<a href="Context.html" title="class in opennlp.tools.ml.model">Context</a>[]&nbsp;context,
float[]&nbsp;values)</span></div>
<div class="block">Populates the specified array with the log of the distribution for the specified context.
The returned array will be overwritten and needs to be re-initialized with every call to this method.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dist</code> - An array to be populated with the log of the prior distribution.</dd>
<dd><code>context</code> - The indices of the contextual predicates for an event.</dd>
<dd><code>values</code> - The values associated with the context.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLabels(java.lang.String[],java.lang.String[])">
<h3>setLabels</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setLabels</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;outcomeLabels,
<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;contextLabels)</span></div>
<div class="block">Method to specify the label for the outcomes and contexts. This is used to map
integer outcomes and contexts to their string values. This method is called prior
to any call to <a href="#logPrior(double%5B%5D,int%5B%5D)"><code>logPrior(double[], int[])</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>outcomeLabels</code> - An array of each outcome label.</dd>
<dd><code>contextLabels</code> - An array of each context label.</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>