blob: 57ccda5c34a6e9538e2191c532b0f313121fa20b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface opennlp.tools.ml.maxent.quasinewton.Function (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="use: package: opennlp.tools.ml.maxent.quasinewton, interface: Function">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">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><a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Interface opennlp.tools.ml.maxent.quasinewton.Function" class="title">Uses of Interface<br>opennlp.tools.ml.maxent.quasinewton.Function</h1>
</div>
<div class="caption"><span>Packages that use <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#opennlp.tools.ml.maxent.quasinewton">opennlp.tools.ml.maxent.quasinewton</a></div>
<div class="col-last even-row-color">
<div class="block">Package related to ML by means of the Quasi Newton (QN) algorithm.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="opennlp.tools.ml.maxent.quasinewton">
<h2>Uses of <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a> in <a href="../package-summary.html">opennlp.tools.ml.maxent.quasinewton</a></h2>
<div class="caption"><span>Classes in <a href="../package-summary.html">opennlp.tools.ml.maxent.quasinewton</a> that implement <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a></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>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../NegLogLikelihood.html" class="type-name-link" title="class in opennlp.tools.ml.maxent.quasinewton">NegLogLikelihood</a></code></div>
<div class="col-last even-row-color">
<div class="block">Evaluate negative log-likelihood and its gradient from <a href="../../../model/DataIndexer.html" title="interface in opennlp.tools.ml.model"><code>DataIndexer</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../ParallelNegLogLikelihood.html" class="type-name-link" title="class in opennlp.tools.ml.maxent.quasinewton">ParallelNegLogLikelihood</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Evaluate negative log-likelihood and its gradient in parallel</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../QNMinimizer.L2RegFunction.html" class="type-name-link" title="class in opennlp.tools.ml.maxent.quasinewton">QNMinimizer.L2RegFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">L2-regularized objective <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton"><code>Function</code></a>.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">opennlp.tools.ml.maxent.quasinewton</a> with parameters of type <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LineSearch.</span><code><a href="../LineSearch.html#doConstrainedLineSearch(opennlp.tools.ml.maxent.quasinewton.Function,double%5B%5D,opennlp.tools.ml.maxent.quasinewton.LineSearch.LineSearchResult,double,double)" class="member-name-link">doConstrainedLineSearch</a><wbr>(<a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a>&nbsp;function,
double[]&nbsp;direction,
<a href="../LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a>&nbsp;lsr,
double&nbsp;l1Cost,
double&nbsp;initialStepSize)</code></div>
<div class="col-last even-row-color">
<div class="block">Conducts a constrained line search (see section 3.2 in the paper "Scalable Training
of L1-Regularized Log-Linear Models", Andrew et al. 2007)</div>
</div>
<div class="col-first odd-row-color"><code>static void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LineSearch.</span><code><a href="../LineSearch.html#doLineSearch(opennlp.tools.ml.maxent.quasinewton.Function,double%5B%5D,opennlp.tools.ml.maxent.quasinewton.LineSearch.LineSearchResult,double)" class="member-name-link">doLineSearch</a><wbr>(<a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a>&nbsp;function,
double[]&nbsp;direction,
<a href="../LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a>&nbsp;lsr,
double&nbsp;initialStepSize)</code></div>
<div class="col-last odd-row-color">
<div class="block">Conducts a backtracking line search (see Nocedal &amp; Wright 2006, Numerical Optimization, p. 37).</div>
</div>
<div class="col-first even-row-color"><code>double[]</code></div>
<div class="col-second even-row-color"><span class="type-name-label">QNMinimizer.</span><code><a href="../QNMinimizer.html#minimize(opennlp.tools.ml.maxent.quasinewton.Function)" class="member-name-link">minimize</a><wbr>(<a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a>&nbsp;function)</code></div>
<div class="col-last even-row-color">
<div class="block">Finds the parameters that minimize the objective function.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">opennlp.tools.ml.maxent.quasinewton</a> with parameters of type <a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../QNMinimizer.L2RegFunction.html#%3Cinit%3E(opennlp.tools.ml.maxent.quasinewton.Function,double)" class="member-name-link">L2RegFunction</a><wbr>(<a href="../Function.html" title="interface in opennlp.tools.ml.maxent.quasinewton">Function</a>&nbsp;f,
double&nbsp;l2Cost)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</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>