blob: 91b33880a10d26c3fe91602346ae660dc221126b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>LineSearch.LineSearchResult (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.maxent.quasinewton, class: LineSearch, class: LineSearchResult">
<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><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.maxent.quasinewton</a></div>
<h1 title="Class LineSearch.LineSearchResult" class="title">Class LineSearch.LineSearchResult</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.maxent.quasinewton.LineSearch.LineSearchResult</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="LineSearch.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">LineSearch.LineSearchResult</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">Represents a LineSearch result.</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(double,double,double,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int)" class="member-name-link">LineSearchResult</a><wbr>(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;pseudoGradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
double[]&nbsp;signVector,
int&nbsp;fctEvalCount)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor with sign vector</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double,double,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int)" class="member-name-link">LineSearchResult</a><wbr>(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
int&nbsp;fctEvalCount)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructor</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>double[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrPoint()" class="member-name-link">getCurrPoint</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>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFctEvalCount()" class="member-name-link">getFctEvalCount</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>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFuncChangeRate()" class="member-name-link">getFuncChangeRate</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>double[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGradAtCurr()" class="member-name-link">getGradAtCurr</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>double[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGradAtNext()" class="member-name-link">getGradAtNext</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-tab1 method-summary-table-tab4"><code>static <a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInitialObject(double,double%5B%5D,double%5B%5D)" class="member-name-link">getInitialObject</a><wbr>(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;x)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Initial linear search object.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInitialObject(double,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int)" class="member-name-link">getInitialObject</a><wbr>(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;pseudoGradAtX,
double[]&nbsp;x,
double[]&nbsp;signX,
int&nbsp;fctEvalCount)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInitialObjectForL1(double,double%5B%5D,double%5B%5D,double%5B%5D)" class="member-name-link">getInitialObjectForL1</a><wbr>(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;pseudoGradAtX,
double[]&nbsp;x)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Initial linear search object for L1-regularization.</div>
</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="#getNextPoint()" class="member-name-link">getNextPoint</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>double[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPseudoGradAtNext()" class="member-name-link">getPseudoGradAtNext</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>double[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSignVector()" class="member-name-link">getSignVector</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>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStepSize()" class="member-name-link">getStepSize</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>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueAtCurr()" class="member-name-link">getValueAtCurr</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>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueAtNext()" class="member-name-link">getValueAtNext</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAll(double,double,double,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int)" class="member-name-link">setAll</a><wbr>(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;pseudoGradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
double[]&nbsp;signVector,
int&nbsp;fctEvalCount)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Update line search elements</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="#setAll(double,double,double,double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int)" class="member-name-link">setAll</a><wbr>(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
int&nbsp;fctEvalCount)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Update line search elements</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="#setCurrPoint(double%5B%5D)" class="member-name-link">setCurrPoint</a><wbr>(double[]&nbsp;currPoint)</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>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFctEvalCount(int)" class="member-name-link">setFctEvalCount</a><wbr>(int&nbsp;fctEvalCount)</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGradAtCurr(double%5B%5D)" class="member-name-link">setGradAtCurr</a><wbr>(double[]&nbsp;gradAtCurr)</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>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGradAtNext(double%5B%5D)" class="member-name-link">setGradAtNext</a><wbr>(double[]&nbsp;gradAtNext)</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNextPoint(double%5B%5D)" class="member-name-link">setNextPoint</a><wbr>(double[]&nbsp;nextPoint)</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>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPseudoGradAtNext(double%5B%5D)" class="member-name-link">setPseudoGradAtNext</a><wbr>(double[]&nbsp;pseudoGradAtNext)</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSignVector(double%5B%5D)" class="member-name-link">setSignVector</a><wbr>(double[]&nbsp;signVector)</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>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStepSize(double)" class="member-name-link">setStepSize</a><wbr>(double&nbsp;stepSize)</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueAtCurr(double)" class="member-name-link">setValueAtCurr</a><wbr>(double&nbsp;valueAtCurr)</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>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueAtNext(double)" class="member-name-link">setValueAtNext</a><wbr>(double&nbsp;valueAtNext)</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">
<!-- ========= 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;(double,double,double,double[],double[],double[],double[],int)">
<h3>LineSearchResult</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LineSearchResult</span><wbr><span class="parameters">(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
int&nbsp;fctEvalCount)</span></div>
<div class="block">Constructor</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(double,double,double,double[],double[],double[],double[],double[],double[],int)">
<h3>LineSearchResult</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LineSearchResult</span><wbr><span class="parameters">(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;pseudoGradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
double[]&nbsp;signVector,
int&nbsp;fctEvalCount)</span></div>
<div class="block">Constructor with sign vector</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="setAll(double,double,double,double[],double[],double[],double[],int)">
<h3>setAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAll</span><wbr><span class="parameters">(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
int&nbsp;fctEvalCount)</span></div>
<div class="block">Update line search elements</div>
</section>
</li>
<li>
<section class="detail" id="setAll(double,double,double,double[],double[],double[],double[],double[],double[],int)">
<h3>setAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAll</span><wbr><span class="parameters">(double&nbsp;stepSize,
double&nbsp;valueAtCurr,
double&nbsp;valueAtNext,
double[]&nbsp;gradAtCurr,
double[]&nbsp;gradAtNext,
double[]&nbsp;pseudoGradAtNext,
double[]&nbsp;currPoint,
double[]&nbsp;nextPoint,
double[]&nbsp;signVector,
int&nbsp;fctEvalCount)</span></div>
<div class="block">Update line search elements</div>
</section>
</li>
<li>
<section class="detail" id="getFuncChangeRate()">
<h3>getFuncChangeRate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getFuncChangeRate</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getStepSize()">
<h3>getStepSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getStepSize</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setStepSize(double)">
<h3>setStepSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStepSize</span><wbr><span class="parameters">(double&nbsp;stepSize)</span></div>
</section>
</li>
<li>
<section class="detail" id="getValueAtCurr()">
<h3>getValueAtCurr</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getValueAtCurr</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setValueAtCurr(double)">
<h3>setValueAtCurr</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setValueAtCurr</span><wbr><span class="parameters">(double&nbsp;valueAtCurr)</span></div>
</section>
</li>
<li>
<section class="detail" id="getValueAtNext()">
<h3>getValueAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getValueAtNext</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setValueAtNext(double)">
<h3>setValueAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setValueAtNext</span><wbr><span class="parameters">(double&nbsp;valueAtNext)</span></div>
</section>
</li>
<li>
<section class="detail" id="getGradAtCurr()">
<h3>getGradAtCurr</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getGradAtCurr</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setGradAtCurr(double[])">
<h3>setGradAtCurr</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setGradAtCurr</span><wbr><span class="parameters">(double[]&nbsp;gradAtCurr)</span></div>
</section>
</li>
<li>
<section class="detail" id="getGradAtNext()">
<h3>getGradAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getGradAtNext</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setGradAtNext(double[])">
<h3>setGradAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setGradAtNext</span><wbr><span class="parameters">(double[]&nbsp;gradAtNext)</span></div>
</section>
</li>
<li>
<section class="detail" id="getPseudoGradAtNext()">
<h3>getPseudoGradAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getPseudoGradAtNext</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setPseudoGradAtNext(double[])">
<h3>setPseudoGradAtNext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setPseudoGradAtNext</span><wbr><span class="parameters">(double[]&nbsp;pseudoGradAtNext)</span></div>
</section>
</li>
<li>
<section class="detail" id="getCurrPoint()">
<h3>getCurrPoint</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getCurrPoint</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setCurrPoint(double[])">
<h3>setCurrPoint</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCurrPoint</span><wbr><span class="parameters">(double[]&nbsp;currPoint)</span></div>
</section>
</li>
<li>
<section class="detail" id="getNextPoint()">
<h3>getNextPoint</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getNextPoint</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setNextPoint(double[])">
<h3>setNextPoint</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setNextPoint</span><wbr><span class="parameters">(double[]&nbsp;nextPoint)</span></div>
</section>
</li>
<li>
<section class="detail" id="getSignVector()">
<h3>getSignVector</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">getSignVector</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setSignVector(double[])">
<h3>setSignVector</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSignVector</span><wbr><span class="parameters">(double[]&nbsp;signVector)</span></div>
</section>
</li>
<li>
<section class="detail" id="getFctEvalCount()">
<h3>getFctEvalCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getFctEvalCount</span>()</div>
</section>
</li>
<li>
<section class="detail" id="setFctEvalCount(int)">
<h3>setFctEvalCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFctEvalCount</span><wbr><span class="parameters">(int&nbsp;fctEvalCount)</span></div>
</section>
</li>
<li>
<section class="detail" id="getInitialObject(double,double[],double[])">
<h3>getInitialObject</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></span>&nbsp;<span class="element-name">getInitialObject</span><wbr><span class="parameters">(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;x)</span></div>
<div class="block">Initial linear search object.</div>
</section>
</li>
<li>
<section class="detail" id="getInitialObjectForL1(double,double[],double[],double[])">
<h3>getInitialObjectForL1</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></span>&nbsp;<span class="element-name">getInitialObjectForL1</span><wbr><span class="parameters">(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;pseudoGradAtX,
double[]&nbsp;x)</span></div>
<div class="block">Initial linear search object for L1-regularization.</div>
</section>
</li>
<li>
<section class="detail" id="getInitialObject(double,double[],double[],double[],double[],int)">
<h3>getInitialObject</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="LineSearch.LineSearchResult.html" title="class in opennlp.tools.ml.maxent.quasinewton">LineSearch.LineSearchResult</a></span>&nbsp;<span class="element-name">getInitialObject</span><wbr><span class="parameters">(double&nbsp;valueAtX,
double[]&nbsp;gradAtX,
double[]&nbsp;pseudoGradAtX,
double[]&nbsp;x,
double[]&nbsp;signX,
int&nbsp;fctEvalCount)</span></div>
</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>