Files
ortools-clone/docs/cpp/trust__region_8cc.html
Mizux Seiha 3b81c981c2 Update doc
2022-03-04 00:19:15 +01:00

248 lines
17 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: trust_region.cc File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trust__region_8cc.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">trust_region.cc File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="trust__region_8cc_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1pdlp_1_1_diagonal_trust_region_problem.html">DiagonalTrustRegionProblem</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1pdlp_1_1_diagonal_trust_region_problem_from_qp.html">DiagonalTrustRegionProblemFromQp</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html">operations_research</a></td></tr>
<tr class="memdesc:namespaceoperations__research"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collection of objects used to extend the <a class="el" href="classoperations__research_1_1_constraint.html" title="A constraint is the main modeling object.">Constraint</a> <a class="el" href="classoperations__research_1_1_solver.html" title="Solver Class.">Solver</a> library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceoperations__research_1_1pdlp"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html">operations_research::pdlp</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8da80544adc685ee442522ede0e095a9"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a8da80544adc685ee442522ede0e095a9">SolveTrustRegion</a> (const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ac824522e23b1d307c272d07493af3a65">objective_vector</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a16346c4c462dec8f0cf38493c5e0358c">variable_lower_bounds</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a868af74445e29f368ccf4a9e053f9267">variable_upper_bounds</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a2cc94fcc3b7abf4cdc59197b0c10cefe">center_point</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad31783425c63eac33cc6aade41a6537d">norm_weights</a>, const double target_radius, const Sharder &amp;sharder)</td></tr>
<tr class="separator:a8da80544adc685ee442522ede0e095a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accb6df46237b5d870b93c6566cadd722"><td class="memTemplParams" colspan="2">template&lt;typename DiagonalTrustRegionProblem &gt; </td></tr>
<tr class="memitem:accb6df46237b5d870b93c6566cadd722"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#accb6df46237b5d870b93c6566cadd722">ProjectedValueOfScaledDifference</a> (const DiagonalTrustRegionProblem &amp;problem, const int64_t <a class="el" href="routing__search_8cc.html#aa9d6bcc39dc199c2a2671a88ecf3630e">index</a>, const double scaling_factor)</td></tr>
<tr class="separator:accb6df46237b5d870b93c6566cadd722"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c71f00da2c898c481414c3e92f12f0d"><td class="memTemplParams" colspan="2">template&lt;typename DiagonalTrustRegionProblem &gt; </td></tr>
<tr class="memitem:a3c71f00da2c898c481414c3e92f12f0d"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a3c71f00da2c898c481414c3e92f12f0d">NormOfDeltaProjection</a> (const DiagonalTrustRegionProblem &amp;problem, const Sharder &amp;sharder, const double scaling_factor)</td></tr>
<tr class="separator:a3c71f00da2c898c481414c3e92f12f0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bd16384c5572b001a57e9987bf5b0e9"><td class="memTemplParams" colspan="2">template&lt;typename DiagonalTrustRegionProblem &gt; </td></tr>
<tr class="memitem:a7bd16384c5572b001a57e9987bf5b0e9"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a7bd16384c5572b001a57e9987bf5b0e9">FindScalingFactor</a> (const DiagonalTrustRegionProblem &amp;problem, const Sharder &amp;sharder, const double target_radius, const double solve_tol)</td></tr>
<tr class="separator:a7bd16384c5572b001a57e9987bf5b0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39db3ccea12adec49816af128a288223"><td class="memTemplParams" colspan="2">template&lt;typename DiagonalTrustRegionProblem &gt; </td></tr>
<tr class="memitem:a39db3ccea12adec49816af128a288223"><td class="memTemplItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a39db3ccea12adec49816af128a288223">SolveDiagonalTrustRegionProblem</a> (const DiagonalTrustRegionProblem &amp;problem, const Sharder &amp;sharder, const double target_radius, const double solve_tol)</td></tr>
<tr class="separator:a39db3ccea12adec49816af128a288223"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f128477eac14f0eda4b73fdfb3e24d4"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a5f128477eac14f0eda4b73fdfb3e24d4">SolveDiagonalTrustRegion</a> (const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ac824522e23b1d307c272d07493af3a65">objective_vector</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad8dc72e7835d167fffffac5769c55076">objective_matrix_diagonal</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a16346c4c462dec8f0cf38493c5e0358c">variable_lower_bounds</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a868af74445e29f368ccf4a9e053f9267">variable_upper_bounds</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a2cc94fcc3b7abf4cdc59197b0c10cefe">center_point</a>, const VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad31783425c63eac33cc6aade41a6537d">norm_weights</a>, const double target_radius, const Sharder &amp;sharder, const double solve_tolerance)</td></tr>
<tr class="separator:a5f128477eac14f0eda4b73fdfb3e24d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64c21ba4bf7d15e5dd1f8396074a9dfa"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a64c21ba4bf7d15e5dd1f8396074a9dfa">SolveDiagonalQpTrustRegion</a> (const ShardedQuadraticProgram &amp;sharded_qp, const VectorXd &amp;primal_solution, const VectorXd &amp;dual_solution, const VectorXd &amp;primal_gradient, const VectorXd &amp;dual_gradient, const double primal_weight, double target_radius, const double solve_tolerance)</td></tr>
<tr class="separator:a64c21ba4bf7d15e5dd1f8396074a9dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb77e7cede2fecf6bccfa93226b49c0b"><td class="memItemLeft" align="right" valign="top">LocalizedLagrangianBounds&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#adb77e7cede2fecf6bccfa93226b49c0b">ComputeLocalizedLagrangianBounds</a> (const ShardedQuadraticProgram &amp;sharded_qp, const VectorXd &amp;primal_solution, const VectorXd &amp;dual_solution, const PrimalDualNorm primal_dual_norm, const double primal_weight, const double radius, const VectorXd *primal_product, const VectorXd *dual_product, const bool use_diagonal_qp_trust_region_solver, const double diagonal_qp_trust_region_solver_tolerance)</td></tr>
<tr class="separator:adb77e7cede2fecf6bccfa93226b49c0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a69703b8569462134ad4e22ab0133e418" name="a69703b8569462134ad4e22ab0133e418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69703b8569462134ad4e22ab0133e418">&#9670;&nbsp;</a></span>objective_value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double objective_value</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00167">167</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
<a id="a59572487cff4d7cb15cdabbffd9685b2" name="a59572487cff4d7cb15cdabbffd9685b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59572487cff4d7cb15cdabbffd9685b2">&#9670;&nbsp;</a></span>part_of_lagrangian_value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double part_of_lagrangian_value = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00786">786</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
<a id="a9f97b60109cf3b1650acf7fa8b5dd307" name="a9f97b60109cf3b1650acf7fa8b5dd307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f97b60109cf3b1650acf7fa8b5dd307">&#9670;&nbsp;</a></span>radius_coefficient_of_decided_components</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double radius_coefficient_of_decided_components</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00206">206</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
<a id="a879215ecd0117ade78436fc4590747e0" name="a879215ecd0117ade78436fc4590747e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a879215ecd0117ade78436fc4590747e0">&#9670;&nbsp;</a></span>solution_step_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double solution_step_size</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00165">165</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
<a id="a35a93e273ed07f347699c3f4b4b5f581" name="a35a93e273ed07f347699c3f4b4b5f581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35a93e273ed07f347699c3f4b4b5f581">&#9670;&nbsp;</a></span>trust_region_objective_delta</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double trust_region_objective_delta = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00795">795</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
<a id="a8537e4c5ab72a497c1f81fad8c3b1db6" name="a8537e4c5ab72a497c1f81fad8c3b1db6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8537e4c5ab72a497c1f81fad8c3b1db6">&#9670;&nbsp;</a></span>undecided_components_by_shard</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::vector&lt;int64_t&gt; &gt; undecided_components_by_shard</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="trust__region_8cc_source.html#l00205">205</a> of file <a class="el" href="trust__region_8cc_source.html">trust_region.cc</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_7cc48880791e3dd695dbfc2349101d28.html">pdlp</a></li><li class="navelem"><a class="el" href="trust__region_8cc.html">trust_region.cc</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
</html>