219 lines
33 KiB
HTML
219 lines
33 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: termination.h Source File</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
|
|
 <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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('termination_8h_source.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="headertitle"><div class="title">termination.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="termination_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef PDLP_TERMINATION_H_</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define PDLP_TERMINATION_H_</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include "absl/types/optional.h"</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include "ortools/pdlp/solve_log.pb.h"</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include "ortools/pdlp/solvers.pb.h"</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research_1_1pdlp.html">operations_research::pdlp</a> {</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html"> 23</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html">TerminationReasonAndPointType</a> {</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#a36d5365d462f57468ba3a9d8ae6bbec9"> 24</a></span> <a class="code hl_enumeration" href="namespaceoperations__research_1_1math__opt.html#ad02e69a0531469b463df907c7b2ad194">TerminationReason</a> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#a36d5365d462f57468ba3a9d8ae6bbec9">reason</a>;</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#ab1785f22acaa1c80392a04df45befb93"> 25</a></span> PointType <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#ab1785f22acaa1c80392a04df45befb93">type</a>;</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Information about the quadratic program's primal and dual bounds that are</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// needed to evaluate relative convergence criteria.</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html"> 30</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html">QuadraticProgramBoundNorms</a> {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#ab3f4b0ebcc89ef8fce922335e0026a95"> 31</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#ab3f4b0ebcc89ef8fce922335e0026a95">l2_norm_primal_linear_objective</a>;</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adcf372259113849bfe323c599f77f547"> 32</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adcf372259113849bfe323c599f77f547">l2_norm_constraint_bounds</a>;</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adc56dab042af6eb15263a5e62aa1e7f5"> 33</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adc56dab042af6eb15263a5e62aa1e7f5">l_inf_norm_primal_linear_objective</a>;</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#a64e7f471ef722b483682884caf14e670"> 34</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#a64e7f471ef722b483682884caf14e670">l_inf_norm_constraint_bounds</a>;</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>};</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// Checks if any termination criteria are satisfied by the solution state</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">// described by the IterationStats instance stats (see definitions of</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">// termination criteria in solvers.proto). bound_norms provides the instance-</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// dependent data required for the relative convergence criteria. Returns a</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">// termination reason and a point type if so (if multiple are satisfied, the</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// optimality and infeasibility conditions are checked first). If</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// force_numerical_termination is true, returns NUMERICAL_ERROR if no other</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">// criteria are satisfied. The return value is empty in any other case. If the</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// output is not empty, the PointType indicates which entry prompted</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">// termination. If no entry prompted termination, e.g. NUMERICAL_ERROR or</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">// ITERATION_LIMIT is returned, then the PointType is set to POINT_TYPE_NONE.</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">// NOTE: This function assumes that the solution used to compute the stats</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">// satisfies the primal and dual variable bounds; see</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">// https://developers.google.com/optimization/lp/pdlp_math#dual_variable_bounds.</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>absl::optional<TerminationReasonAndPointType> <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#a7d2e7889c98661aba130697a142fdf4b">CheckTerminationCriteria</a>(</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">const</span> TerminationCriteria& criteria, <span class="keyword">const</span> IterationStats& stats,</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">const</span> <a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html">QuadraticProgramBoundNorms</a>& bound_norms,</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">bool</span> force_numerical_termination = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">// Extracts the norms needed for the termination criteria from the full problem</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment">// statistics.</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html">QuadraticProgramBoundNorms</a> <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#ac69c2a44159905c520139def17af7e4f">BoundNormsFromProblemStats</a>(</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">const</span> QuadraticProgramStats& stats);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">// Metrics for tracking progress when relative convergence criteria are used.</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">// These depend on the ConvergenceInformation, the problem data, and the</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">// convergence tolerances.</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html"> 64</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html">RelativeConvergenceInformation</a> {</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Relative versions of the residuals, defined as</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// relative_residual = residual / (eps_ratio + norm),</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// where</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// eps_ratio = eps_optimal_absolute / eps_optimal_relative</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// residual = one of the residuals (l{2,_inf}_{primal,dual}_residual)</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// norm = the relative norm (l{2,_inf} norm of</span></div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// {constraint_bounds,primal_linear_objective} respectively).</span></div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// If eps_optimal_relative = 0.0, these will all be 0.0.</span></div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">//</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// If eps_optimal_relative > 0.0, the absolute and relative termination</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// criteria translate to relative_residual <= eps_optimal_relative.</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a70d9982724056866c95e3085712b1c29"> 76</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a70d9982724056866c95e3085712b1c29">relative_l_inf_primal_residual</a> = 0;</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a613352413bf3d7b5021644158a4848fa"> 77</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a613352413bf3d7b5021644158a4848fa">relative_l2_primal_residual</a> = 0;</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a4096b828a747baff79e95cbeda1b8aac"> 78</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a4096b828a747baff79e95cbeda1b8aac">relative_l_inf_dual_residual</a> = 0;</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a0aae409a341fa649cf2473177abcb54e"> 79</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a0aae409a341fa649cf2473177abcb54e">relative_l2_dual_residual</a> = 0;</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// Relative optimality gap:</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// (primal_objective - dual_objective) /</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// (eps_ratio + |primal_objective| + |dual_objective|)</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#adb8dac7c4b1c7a00831d6e6549751782"> 84</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#adb8dac7c4b1c7a00831d6e6549751782">relative_optimality_gap</a> = 0;</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>};</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html">RelativeConvergenceInformation</a> <a class="code hl_function" href="namespaceoperations__research_1_1pdlp.html#a8e307fb8ac2854dd493d52760dd3aa30">ComputeRelativeResiduals</a>(</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">double</span> eps_optimal_absolute, <span class="keywordtype">double</span> eps_optimal_relative,</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">const</span> <a class="code hl_struct" href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html">QuadraticProgramBoundNorms</a>& norms,</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">const</span> ConvergenceInformation& stats);</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>} <span class="comment">// namespace operations_research::pdlp</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif </span><span class="comment">// PDLP_TERMINATION_H_</span></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1math__opt_html_ad02e69a0531469b463df907c7b2ad194"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ad02e69a0531469b463df907c7b2ad194">operations_research::math_opt::TerminationReason</a></div><div class="ttdeci">TerminationReason</div><div class="ttdef"><b>Definition:</b> <a href="solve__result_8h_source.html#l00150">solve_result.h:150</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html">operations_research::pdlp</a></div><div class="ttdef"><b>Definition:</b> <a href="iteration__stats_8cc_source.html#l00040">iteration_stats.cc:40</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_a7d2e7889c98661aba130697a142fdf4b"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#a7d2e7889c98661aba130697a142fdf4b">operations_research::pdlp::CheckTerminationCriteria</a></div><div class="ttdeci">absl::optional< TerminationReasonAndPointType > CheckTerminationCriteria(const TerminationCriteria &criteria, const IterationStats &stats, const QuadraticProgramBoundNorms &bound_norms, const bool force_numerical_termination)</div><div class="ttdef"><b>Definition:</b> <a href="termination_8cc_source.html#l00090">termination.cc:90</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_a8e307fb8ac2854dd493d52760dd3aa30"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#a8e307fb8ac2854dd493d52760dd3aa30">operations_research::pdlp::ComputeRelativeResiduals</a></div><div class="ttdeci">RelativeConvergenceInformation ComputeRelativeResiduals(const double eps_optimal_absolute, const double eps_optimal_relative, const QuadraticProgramBoundNorms &norms, const ConvergenceInformation &stats)</div><div class="ttdef"><b>Definition:</b> <a href="termination_8cc_source.html#l00147">termination.cc:147</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1pdlp_html_ac69c2a44159905c520139def17af7e4f"><div class="ttname"><a href="namespaceoperations__research_1_1pdlp.html#ac69c2a44159905c520139def17af7e4f">operations_research::pdlp::BoundNormsFromProblemStats</a></div><div class="ttdeci">QuadraticProgramBoundNorms BoundNormsFromProblemStats(const QuadraticProgramStats &stats)</div><div class="ttdef"><b>Definition:</b> <a href="termination_8cc_source.html#l00138">termination.cc:138</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms_html"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html">operations_research::pdlp::QuadraticProgramBoundNorms</a></div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00030">termination.h:30</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms_html_a64e7f471ef722b483682884caf14e670"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#a64e7f471ef722b483682884caf14e670">operations_research::pdlp::QuadraticProgramBoundNorms::l_inf_norm_constraint_bounds</a></div><div class="ttdeci">double l_inf_norm_constraint_bounds</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00034">termination.h:34</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms_html_ab3f4b0ebcc89ef8fce922335e0026a95"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#ab3f4b0ebcc89ef8fce922335e0026a95">operations_research::pdlp::QuadraticProgramBoundNorms::l2_norm_primal_linear_objective</a></div><div class="ttdeci">double l2_norm_primal_linear_objective</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00031">termination.h:31</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms_html_adc56dab042af6eb15263a5e62aa1e7f5"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adc56dab042af6eb15263a5e62aa1e7f5">operations_research::pdlp::QuadraticProgramBoundNorms::l_inf_norm_primal_linear_objective</a></div><div class="ttdeci">double l_inf_norm_primal_linear_objective</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00033">termination.h:33</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms_html_adcf372259113849bfe323c599f77f547"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_quadratic_program_bound_norms.html#adcf372259113849bfe323c599f77f547">operations_research::pdlp::QuadraticProgramBoundNorms::l2_norm_constraint_bounds</a></div><div class="ttdeci">double l2_norm_constraint_bounds</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00032">termination.h:32</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html">operations_research::pdlp::RelativeConvergenceInformation</a></div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00064">termination.h:64</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html_a0aae409a341fa649cf2473177abcb54e"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a0aae409a341fa649cf2473177abcb54e">operations_research::pdlp::RelativeConvergenceInformation::relative_l2_dual_residual</a></div><div class="ttdeci">double relative_l2_dual_residual</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00079">termination.h:79</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html_a4096b828a747baff79e95cbeda1b8aac"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a4096b828a747baff79e95cbeda1b8aac">operations_research::pdlp::RelativeConvergenceInformation::relative_l_inf_dual_residual</a></div><div class="ttdeci">double relative_l_inf_dual_residual</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00078">termination.h:78</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html_a613352413bf3d7b5021644158a4848fa"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a613352413bf3d7b5021644158a4848fa">operations_research::pdlp::RelativeConvergenceInformation::relative_l2_primal_residual</a></div><div class="ttdeci">double relative_l2_primal_residual</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00077">termination.h:77</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html_a70d9982724056866c95e3085712b1c29"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#a70d9982724056866c95e3085712b1c29">operations_research::pdlp::RelativeConvergenceInformation::relative_l_inf_primal_residual</a></div><div class="ttdeci">double relative_l_inf_primal_residual</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00076">termination.h:76</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_relative_convergence_information_html_adb8dac7c4b1c7a00831d6e6549751782"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_relative_convergence_information.html#adb8dac7c4b1c7a00831d6e6549751782">operations_research::pdlp::RelativeConvergenceInformation::relative_optimality_gap</a></div><div class="ttdeci">double relative_optimality_gap</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00084">termination.h:84</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_termination_reason_and_point_type_html"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html">operations_research::pdlp::TerminationReasonAndPointType</a></div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00023">termination.h:23</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_termination_reason_and_point_type_html_a36d5365d462f57468ba3a9d8ae6bbec9"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#a36d5365d462f57468ba3a9d8ae6bbec9">operations_research::pdlp::TerminationReasonAndPointType::reason</a></div><div class="ttdeci">TerminationReason reason</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00024">termination.h:24</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1pdlp_1_1_termination_reason_and_point_type_html_ab1785f22acaa1c80392a04df45befb93"><div class="ttname"><a href="structoperations__research_1_1pdlp_1_1_termination_reason_and_point_type.html#ab1785f22acaa1c80392a04df45befb93">operations_research::pdlp::TerminationReasonAndPointType::type</a></div><div class="ttdeci">PointType type</div><div class="ttdef"><b>Definition:</b> <a href="termination_8h_source.html#l00025">termination.h:25</a></div></div>
|
|
</div><!-- fragment --></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="termination_8h.html">termination.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>
|