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

312 lines
19 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: sharded_optimization_utils.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('sharded__optimization__utils_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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">sharded_optimization_utils.cc File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="sharded__optimization__utils_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="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:ab315578d37cb2f5e1111b0176254cb84"><td class="memItemLeft" align="right" valign="top">QuadraticProgramStats&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#ab315578d37cb2f5e1111b0176254cb84">ComputeStats</a> (const ShardedQuadraticProgram &amp;qp, const double infinite_constraint_bound_threshold)</td></tr>
<tr class="separator:ab315578d37cb2f5e1111b0176254cb84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54ded6625965f8ddd342161a55263cce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a54ded6625965f8ddd342161a55263cce">LInfRuizRescaling</a> (const ShardedQuadraticProgram &amp;sharded_qp, const int num_iterations, VectorXd &amp;row_scaling_vec, VectorXd &amp;col_scaling_vec)</td></tr>
<tr class="separator:a54ded6625965f8ddd342161a55263cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dee2894b8028a57b7f7d2306b402e44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a9dee2894b8028a57b7f7d2306b402e44">L2NormRescaling</a> (const ShardedQuadraticProgram &amp;sharded_qp, VectorXd &amp;row_scaling_vec, VectorXd &amp;col_scaling_vec)</td></tr>
<tr class="separator:a9dee2894b8028a57b7f7d2306b402e44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac68304831a1bc81557fb03623a619d6"><td class="memItemLeft" align="right" valign="top">ScalingVectors&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#aac68304831a1bc81557fb03623a619d6">ApplyRescaling</a> (const RescalingOptions &amp;rescaling_options, ShardedQuadraticProgram &amp;sharded_qp)</td></tr>
<tr class="separator:aac68304831a1bc81557fb03623a619d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a259d3f73717a2ababa9df2dd43914656"><td class="memItemLeft" align="right" valign="top">LagrangianPart&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a259d3f73717a2ababa9df2dd43914656">ComputePrimalGradient</a> (const ShardedQuadraticProgram &amp;sharded_qp, const VectorXd &amp;primal_solution, const VectorXd &amp;dual_product)</td></tr>
<tr class="separator:a259d3f73717a2ababa9df2dd43914656"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe6fa17061fa3b8610cce9cf707574f"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a6fe6fa17061fa3b8610cce9cf707574f">DualSubgradientCoefficient</a> (const double constraint_lower_bound, const double constraint_upper_bound, const double dual, const double primal_product)</td></tr>
<tr class="separator:a6fe6fa17061fa3b8610cce9cf707574f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a608ed26a4c7ff3bdcb22d25ff890f47d"><td class="memItemLeft" align="right" valign="top">LagrangianPart&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a608ed26a4c7ff3bdcb22d25ff890f47d">ComputeDualGradient</a> (const ShardedQuadraticProgram &amp;sharded_qp, const Eigen::VectorXd &amp;dual_solution, const Eigen::VectorXd &amp;primal_product)</td></tr>
<tr class="separator:a608ed26a4c7ff3bdcb22d25ff890f47d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a880902cb3a98b7205fa57be9e16a82c7"><td class="memItemLeft" align="right" valign="top">SingularValueAndIterations&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a880902cb3a98b7205fa57be9e16a82c7">EstimateMaximumSingularValueOfConstraintMatrix</a> (const ShardedQuadraticProgram &amp;sharded_qp, const absl::optional&lt; VectorXd &gt; &amp;primal_solution, const absl::optional&lt; VectorXd &gt; &amp;dual_solution, const double desired_relative_error, const double failure_probability, std::mt19937 &amp;mt_generator)</td></tr>
<tr class="separator:a880902cb3a98b7205fa57be9e16a82c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5482747bc024e4a57be9c9200d329fad"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a5482747bc024e4a57be9c9200d329fad">HasValidBounds</a> (const ShardedQuadraticProgram &amp;sharded_qp)</td></tr>
<tr class="separator:a5482747bc024e4a57be9c9200d329fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb7f29f435d6c9fc53148ee403c7049e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#acb7f29f435d6c9fc53148ee403c7049e">ProjectToPrimalVariableBounds</a> (const ShardedQuadraticProgram &amp;sharded_qp, VectorXd &amp;primal)</td></tr>
<tr class="separator:acb7f29f435d6c9fc53148ee403c7049e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a898c0c776a5736cf1931036d0d370724"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a898c0c776a5736cf1931036d0d370724">ProjectToDualVariableBounds</a> (const ShardedQuadraticProgram &amp;sharded_qp, VectorXd &amp;dual)</td></tr>
<tr class="separator:a898c0c776a5736cf1931036d0d370724"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a649a0e24412692f36d1d6c1301caf1d1"><td class="memItemLeft" align="right" valign="top">constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1pdlp.html#a649a0e24412692f36d1d6c1301caf1d1">kInfinity</a> = std::numeric_limits&lt;double&gt;::infinity()</td></tr>
<tr class="separator:a649a0e24412692f36d1d6c1301caf1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a2e50537b138c27e2e30e8d3a568fbee0" name="a2e50537b138c27e2e30e8d3a568fbee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e50537b138c27e2e30e8d3a568fbee0">&#9670;&nbsp;</a></span>average</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double average = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00101">101</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a2a897122b37c5a906205687aecdb627b" name="a2a897122b37c5a906205687aecdb627b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a897122b37c5a906205687aecdb627b">&#9670;&nbsp;</a></span>l2_norm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double l2_norm = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00102">102</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a90a377dabbff2504d9c2c3a51030d216" name="a90a377dabbff2504d9c2c3a51030d216"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90a377dabbff2504d9c2c3a51030d216">&#9670;&nbsp;</a></span>largest</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double largest = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00099">99</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="aa2e8644f5973aaf5614f7694ef29281d" name="aa2e8644f5973aaf5614f7694ef29281d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2e8644f5973aaf5614f7694ef29281d">&#9670;&nbsp;</a></span>max_col_norm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double max_col_norm</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00106">106</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a50b61c289d15248d14d7e2560242f08c" name="a50b61c289d15248d14d7e2560242f08c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50b61c289d15248d14d7e2560242f08c">&#9670;&nbsp;</a></span>max_row_norm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double max_row_norm</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00108">108</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="aed33cfe7d4d1bcda205ef2b972014b69" name="aed33cfe7d4d1bcda205ef2b972014b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed33cfe7d4d1bcda205ef2b972014b69">&#9670;&nbsp;</a></span>min_col_norm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double min_col_norm</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00107">107</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a2bc5760472b765b9ccbba08b19a93ac1" name="a2bc5760472b765b9ccbba08b19a93ac1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bc5760472b765b9ccbba08b19a93ac1">&#9670;&nbsp;</a></span>min_row_norm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double min_row_norm</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00109">109</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a7c25263f41ff0baff82a0faaf3630ce4" name="a7c25263f41ff0baff82a0faaf3630ce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c25263f41ff0baff82a0faaf3630ce4">&#9670;&nbsp;</a></span>num_finite</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t num_finite = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00097">97</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a4d37e0f041f757e75ba8ac17ded9cfbc" name="a4d37e0f041f757e75ba8ac17ded9cfbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d37e0f041f757e75ba8ac17ded9cfbc">&#9670;&nbsp;</a></span>num_nonzero</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t num_nonzero = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00098">98</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.cc</a>.</p>
</div>
</div>
<a id="a229a2d9c49444ad43e50c4efddb3b607" name="a229a2d9c49444ad43e50c4efddb3b607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a229a2d9c49444ad43e50c4efddb3b607">&#9670;&nbsp;</a></span>smallest</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double smallest = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sharded__optimization__utils_8cc_source.html#l00100">100</a> of file <a class="el" href="sharded__optimization__utils_8cc_source.html">sharded_optimization_utils.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="sharded__optimization__utils_8cc.html">sharded_optimization_utils.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>