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

179 lines
18 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.h 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_8h.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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">trust_region.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="trust__region_8h_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1pdlp_1_1_trust_region_result.html">TrustRegionResult</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1pdlp_1_1_localized_lagrangian_bounds.html">LocalizedLagrangianBounds</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_1internal_1_1_primal_trust_region_problem.html">PrimalTrustRegionProblem</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_1internal_1_1_dual_trust_region_problem.html">DualTrustRegionProblem</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>
<tr class="memitem:namespaceoperations__research_1_1pdlp_1_1internal"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html">operations_research::pdlp::internal</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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a39f9a12aa1bd94ddb3a56816d4d25eb0"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a39f9a12aa1bd94ddb3a56816d4d25eb0">PrimalDualNorm</a> { <a class="el" href="namespaceoperations__research_1_1pdlp.html#a39f9a12aa1bd94ddb3a56816d4d25eb0a974f1270f89b99d15b58a4d35c26aedc">kMaxNorm</a>
, <a class="el" href="namespaceoperations__research_1_1pdlp.html#a39f9a12aa1bd94ddb3a56816d4d25eb0aaafbdb17e2f1da89be62331fa0cf5503">kEuclideanNorm</a>
}</td></tr>
<tr class="separator:a39f9a12aa1bd94ddb3a56816d4d25eb0"><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:a90dd3b503fb3d2bb8bd51729584d6bad"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a90dd3b503fb3d2bb8bd51729584d6bad">SolveTrustRegion</a> (const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ac824522e23b1d307c272d07493af3a65">objective_vector</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a16346c4c462dec8f0cf38493c5e0358c">variable_lower_bounds</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a868af74445e29f368ccf4a9e053f9267">variable_upper_bounds</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a2cc94fcc3b7abf4cdc59197b0c10cefe">center_point</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad31783425c63eac33cc6aade41a6537d">norm_weights</a>, double target_radius, const Sharder &amp;sharder)</td></tr>
<tr class="separator:a90dd3b503fb3d2bb8bd51729584d6bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad87e72f6888d8bd27a4d74f35c3a118d"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#ad87e72f6888d8bd27a4d74f35c3a118d">SolveDiagonalTrustRegion</a> (const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ac824522e23b1d307c272d07493af3a65">objective_vector</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad8dc72e7835d167fffffac5769c55076">objective_matrix_diagonal</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a16346c4c462dec8f0cf38493c5e0358c">variable_lower_bounds</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a868af74445e29f368ccf4a9e053f9267">variable_upper_bounds</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#a2cc94fcc3b7abf4cdc59197b0c10cefe">center_point</a>, const Eigen::VectorXd &amp;<a class="el" href="trust__region__test_8cc.html#ad31783425c63eac33cc6aade41a6537d">norm_weights</a>, double target_radius, const Sharder &amp;sharder, double solve_tolerance)</td></tr>
<tr class="separator:ad87e72f6888d8bd27a4d74f35c3a118d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f4054cb0abdfaacfebe5bf1b67eb9c9"><td class="memItemLeft" align="right" valign="top">TrustRegionResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a2f4054cb0abdfaacfebe5bf1b67eb9c9">SolveDiagonalQpTrustRegion</a> (const ShardedQuadraticProgram &amp;sharded_qp, const Eigen::VectorXd &amp;primal_solution, const Eigen::VectorXd &amp;dual_solution, const Eigen::VectorXd &amp;primal_gradient, const Eigen::VectorXd &amp;dual_gradient, const double primal_weight, double target_radius, double solve_tolerance)</td></tr>
<tr class="separator:a2f4054cb0abdfaacfebe5bf1b67eb9c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdd1506c32f697aeb13c4b9a9f05ba03"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#afdd1506c32f697aeb13c4b9a9f05ba03">BoundGap</a> (const LocalizedLagrangianBounds &amp;<a class="el" href="cp__model__solver_8cc.html#a06dad0852d85b0686e01c084207c03a7">bounds</a>)</td></tr>
<tr class="separator:afdd1506c32f697aeb13c4b9a9f05ba03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca670cd122efdc372993d4b49568ec4f"><td class="memItemLeft" align="right" valign="top">LocalizedLagrangianBounds&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#aca670cd122efdc372993d4b49568ec4f">ComputeLocalizedLagrangianBounds</a> (const ShardedQuadraticProgram &amp;sharded_qp, const Eigen::VectorXd &amp;primal_solution, const Eigen::VectorXd &amp;dual_solution, PrimalDualNorm primal_dual_norm, double primal_weight, double radius, const Eigen::VectorXd *primal_product, const Eigen::VectorXd *dual_product, bool use_diagonal_qp_trust_region_solver, double diagonal_qp_trust_region_solver_tolerance)</td></tr>
<tr class="separator:aca670cd122efdc372993d4b49568ec4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89e736fe381fad1600024fa36345650b"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:a89e736fe381fad1600024fa36345650b"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#a89e736fe381fad1600024fa36345650b">DistanceAtCriticalStepSize</a> (const TrustRegionProblem &amp;problem, const int64_t <a class="el" href="routing__search_8cc.html#aa9d6bcc39dc199c2a2671a88ecf3630e">index</a>)</td></tr>
<tr class="separator:a89e736fe381fad1600024fa36345650b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cbe1743f36aed0a68c446f0392ec93c"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:a8cbe1743f36aed0a68c446f0392ec93c"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#a8cbe1743f36aed0a68c446f0392ec93c">CriticalStepSize</a> (const TrustRegionProblem &amp;problem, const int64_t <a class="el" href="routing__search_8cc.html#aa9d6bcc39dc199c2a2671a88ecf3630e">index</a>)</td></tr>
<tr class="separator:a8cbe1743f36aed0a68c446f0392ec93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70dfeb22c2d7bf7aac11a168f80d8bb1"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:a70dfeb22c2d7bf7aac11a168f80d8bb1"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#a70dfeb22c2d7bf7aac11a168f80d8bb1">ProjectedValue</a> (const TrustRegionProblem &amp;problem, const int64_t <a class="el" href="routing__search_8cc.html#aa9d6bcc39dc199c2a2671a88ecf3630e">index</a>, const double step_size)</td></tr>
<tr class="separator:a70dfeb22c2d7bf7aac11a168f80d8bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8901158cf75681cf82a1d866a1118e6"><td class="memTemplParams" colspan="2">template&lt;typename ArrayType , typename ValueFunction &gt; </td></tr>
<tr class="memitem:ab8901158cf75681cf82a1d866a1118e6"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#ab8901158cf75681cf82a1d866a1118e6">EasyMedian</a> (ArrayType array, ValueFunction value_function)</td></tr>
<tr class="separator:ab8901158cf75681cf82a1d866a1118e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1a488cd88b2db320196184c8a60713"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:a0d1a488cd88b2db320196184c8a60713"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#a0d1a488cd88b2db320196184c8a60713">ComputeInitialUndecidedComponents</a> (const TrustRegionProblem &amp;problem, int64_t start_index, int64_t end_index, std::vector&lt; int64_t &gt; &amp;undecided_components)</td></tr>
<tr class="separator:a0d1a488cd88b2db320196184c8a60713"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af260cca7eeddd5e8e77712bd259b3278"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:af260cca7eeddd5e8e77712bd259b3278"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#af260cca7eeddd5e8e77712bd259b3278">RadiusSquaredOfUndecidedComponents</a> (const TrustRegionProblem &amp;problem, const double step_size, const std::vector&lt; int64_t &gt; &amp;undecided_components)</td></tr>
<tr class="separator:af260cca7eeddd5e8e77712bd259b3278"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3c6d3cc8d588acbb2573e3384f3bd0"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:a7d3c6d3cc8d588acbb2573e3384f3bd0"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#a7d3c6d3cc8d588acbb2573e3384f3bd0">RemoveCriticalStepsAboveThreshold</a> (const TrustRegionProblem &amp;problem, const double step_size_threshold, std::vector&lt; int64_t &gt; &amp;undecided_components)</td></tr>
<tr class="separator:a7d3c6d3cc8d588acbb2573e3384f3bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8ad95f3ab1aca8e985d46d0db21e15f"><td class="memTemplParams" colspan="2">template&lt;typename TrustRegionProblem &gt; </td></tr>
<tr class="memitem:aa8ad95f3ab1aca8e985d46d0db21e15f"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp_1_1internal.html#aa8ad95f3ab1aca8e985d46d0db21e15f">RemoveCriticalStepsBelowThreshold</a> (const TrustRegionProblem &amp;problem, const double step_size_threshold, std::vector&lt; int64_t &gt; &amp;undecided_components)</td></tr>
<tr class="separator:aa8ad95f3ab1aca8e985d46d0db21e15f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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_8h.html">trust_region.h</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>