| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Probabilities (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.naivebayes, class: Probabilities"> |
| <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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">opennlp.tools.ml.naivebayes</a></div> |
| <h1 title="Class Probabilities" class="title">Class Probabilities<T></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.naivebayes.Probabilities<T></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The label (category) class.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="LogProbabilities.html" title="class in opennlp.tools.ml.naivebayes">LogProbabilities</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Probabilities<T></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">Class implementing the probability distribution over labels returned by a classifier.</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">Probabilities</a>()</code></div> |
| <div class="col-last even-row-color"> </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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addIn(T,double,int)" class="member-name-link">addIn</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability, |
| int count)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compounds the existing probability mass on the label <code>t</code> |
| with the new probability passed in to the method.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#discardCountsBelow(double)" class="member-name-link">discardCountsBelow</a><wbr>(double i)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-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/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(T)" class="member-name-link">get</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>,<wbr><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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAll()" class="member-name-link">getAll</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfidence()" class="member-name-link">getConfidence</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKeys()" class="member-name-link">getKeys</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-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/Double.html" title="class or interface in java.lang" class="external-link">Double</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLog(T)" class="member-name-link">getLog</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Probabilities.html" title="type parameter in Probabilities">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMax()" class="member-name-link">getMax</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxValue()" class="member-name-link">getMaxValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(T,double)" class="member-name-link">set</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(T,opennlp.tools.ml.naivebayes.Probability)" class="member-name-link">set</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| <a href="Probability.html" title="class in opennlp.tools.ml.naivebayes">Probability</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>> probability)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfidence(double)" class="member-name-link">setConfidence</a><wbr>(double confidence)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the best confidence with which this set of probabilities has been calculated.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIfLarger(T,double)" class="member-name-link">setIfLarger</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability, |
| if the new probability is greater than the old one.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLog(T,double)" class="member-name-link">setLog</a><wbr>(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns a log probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| </div> |
| <div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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#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="<init>()"> |
| <h3>Probabilities</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Probabilities</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="set(T,double)"> |
| <h3 id="set(java.lang.Object,double)">set</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</span></div> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label to which the probability is being assigned.</dd> |
| <dd><code>probability</code> - The probability to assign.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(T,opennlp.tools.ml.naivebayes.Probability)"> |
| <h3 id="set(java.lang.Object,opennlp.tools.ml.naivebayes.Probability)">set</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| <a href="Probability.html" title="class in opennlp.tools.ml.naivebayes">Probability</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>> probability)</span></div> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label to which the probability is being assigned.</dd> |
| <dd><code>probability</code> - The probability to assign.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIfLarger(T,double)"> |
| <h3 id="setIfLarger(java.lang.Object,double)">setIfLarger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIfLarger</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</span></div> |
| <div class="block">Assigns a probability to a label <code>t</code>, |
| discarding any previously assigned probability, |
| if the new probability is greater than the old one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label to which the probability is being assigned.</dd> |
| <dd><code>probability</code> - The probability to assign.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLog(T,double)"> |
| <h3 id="setLog(java.lang.Object,double)">setLog</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLog</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability)</span></div> |
| <div class="block">Assigns a log probability to a label <code>t</code>, |
| discarding any previously assigned probability.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label to which the log probability is being assigned.</dd> |
| <dd><code>probability</code> - The log probability to assign.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addIn(T,double,int)"> |
| <h3 id="addIn(java.lang.Object,double,int)">addIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addIn</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t, |
| double probability, |
| int count)</span></div> |
| <div class="block">Compounds the existing probability mass on the label <code>t</code> |
| with the new probability passed in to the method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label whose probability mass is being updated.</dd> |
| <dd><code>probability</code> - The probability weight to add.</dd> |
| <dd><code>count</code> - The amplifying factor for the probability compounding.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(T)"> |
| <h3 id="get(java.lang.Object)">get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label whose probability needs to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>Retrieves the probability associated with the label.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLog(T)"> |
| <h3 id="getLog(java.lang.Object)">getLog</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getLog</span><wbr><span class="parameters">(<a href="Probabilities.html" title="type parameter in Probabilities">T</a> t)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - The label whose log probability should be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>Retrieves the log probability associated with the label</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKeys()"> |
| <h3>getKeys</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>></span> <span class="element-name">getKeys</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the probabilities associated with all labels</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAll()"> |
| <h3>getAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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">Map</a><<a href="Probabilities.html" title="type parameter in Probabilities">T</a>,<wbr><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>></span> <span class="element-name">getAll</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves a <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> of labels and their probabilities</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMax()"> |
| <h3>getMax</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Probabilities.html" title="type parameter in Probabilities">T</a></span> <span class="element-name">getMax</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the label that has the highest associated probability.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxValue()"> |
| <h3>getMaxValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMaxValue</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the probability of the most likely label</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="discardCountsBelow(double)"> |
| <h3>discardCountsBelow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">discardCountsBelow</span><wbr><span class="parameters">(double i)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfidence()"> |
| <h3>getConfidence</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getConfidence</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Retrieves the best confidence with which this set of probabilities has been calculated. |
| This is a function of the amount of data that supports the assertion. |
| It is also a measure of the accuracy of the estimator of the probability.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConfidence(double)"> |
| <h3>setConfidence</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConfidence</span><wbr><span class="parameters">(double confidence)</span></div> |
| <div class="block">Sets the best confidence with which this set of probabilities has been calculated. |
| This is a function of the amount of data that supports the assertion. |
| It is also a measure of the accuracy of the estimator of the probability.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>confidence</code> - The confidence in the probabilities.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">toString</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#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |