Files
ortools-clone/docs/cpp/linear__solver_2model__validator_8cc.html
2021-09-20 15:57:27 +02:00

212 lines
15 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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: model_validator.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('linear__solver_2model__validator_8cc.html','');});
/* @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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">linear_solver/model_validator.cc File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="linear__solver_2model__validator_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 name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top"> &#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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aff224abb81f10208eec52534c895aa07"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linear__solver_2model__validator_8cc.html#aff224abb81f10208eec52534c895aa07">COPY_FIELD_IF_PRESENT</a>(field)&#160;&#160;&#160;<a class="el" href="parser_8yy_8cc.html#a33e91cd0cef6786e9e3a27ac67707207">if</a> (from.has_##field()) to-&gt;set_##field(from.field())</td></tr>
<tr class="separator:aff224abb81f10208eec52534c895aa07"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3f15a1b3b1e093ebe2375816984f938a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="linear__solver_2model__validator_8cc.html#a3f15a1b3b1e093ebe2375816984f938a">ABSL_FLAG</a> (double, model_validator_infinity, 1e100, &quot;Anything above or equal to this magnitude will be considered infinity.&quot;)</td></tr>
<tr class="separator:a3f15a1b3b1e093ebe2375816984f938a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa964b4fd4cba1119c722a85bea947d05"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aa964b4fd4cba1119c722a85bea947d05">FindErrorInMPModelProto</a> (const MPModelProto &amp;<a class="el" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>, double abs_value_threshold=0.0, bool accept_trivially_infeasible_bounds=false)</td></tr>
<tr class="memdesc:aa964b4fd4cba1119c722a85bea947d05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an empty string iff the model is valid and not trivially infeasible. <a href="namespaceoperations__research.html#aa964b4fd4cba1119c722a85bea947d05">More...</a><br /></td></tr>
<tr class="separator:aa964b4fd4cba1119c722a85bea947d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9719cad5eece9b747a6332dd39126f0c"><td class="memItemLeft" align="right" valign="top">absl::optional&lt; LazyMutableCopy&lt; MPModelProto &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a9719cad5eece9b747a6332dd39126f0c">ExtractValidMPModelOrPopulateResponseStatus</a> (const MPModelRequest &amp;request, MPSolutionResponse *<a class="el" href="cp__model__solver_8cc.html#abcd33b18ce6d5a90a4ba5c37cfa58829">response</a>)</td></tr>
<tr class="memdesc:a9719cad5eece9b747a6332dd39126f0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the model is valid and non-empty, returns it (possibly after extracting the model_delta). <a href="namespaceoperations__research.html#a9719cad5eece9b747a6332dd39126f0c">More...</a><br /></td></tr>
<tr class="separator:a9719cad5eece9b747a6332dd39126f0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a028894df65f61e94b6a406ed76901abf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a028894df65f61e94b6a406ed76901abf">ExtractValidMPModelInPlaceOrPopulateResponseStatus</a> (MPModelRequest *request, MPSolutionResponse *<a class="el" href="cp__model__solver_8cc.html#abcd33b18ce6d5a90a4ba5c37cfa58829">response</a>)</td></tr>
<tr class="memdesc:a028894df65f61e94b6a406ed76901abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Like <a class="el" href="namespaceoperations__research.html#a9719cad5eece9b747a6332dd39126f0c" title="If the model is valid and non-empty, returns it (possibly after extracting the model_delta).">ExtractValidMPModelOrPopulateResponseStatus()</a>, but works in-place: if the MPModel needed extraction, it will be populated in the request, and it returns the success boolean. <a href="namespaceoperations__research.html#a028894df65f61e94b6a406ed76901abf">More...</a><br /></td></tr>
<tr class="separator:a028894df65f61e94b6a406ed76901abf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad30505c27ac9dd7ded3396e750cbff5f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#ad30505c27ac9dd7ded3396e750cbff5f">FindFeasibilityErrorInSolutionHint</a> (const MPModelProto &amp;<a class="el" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>, double tolerance)</td></tr>
<tr class="memdesc:ad30505c27ac9dd7ded3396e750cbff5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an empty string if the solution hint given in the model is a feasible solution. <a href="namespaceoperations__research.html#ad30505c27ac9dd7ded3396e750cbff5f">More...</a><br /></td></tr>
<tr class="separator:ad30505c27ac9dd7ded3396e750cbff5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fe0ce1e27e08e817ec6f105976b729f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a1fe0ce1e27e08e817ec6f105976b729f">FindErrorInMPModelDeltaProto</a> (const MPModelDeltaProto &amp;<a class="el" href="resource_8cc.html#af12056bc2a8e3ec563f0940d87abbd2e">delta</a>, const MPModelProto &amp;<a class="el" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>)</td></tr>
<tr class="memdesc:a1fe0ce1e27e08e817ec6f105976b729f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Like FindErrorInMPModelProto, but for a <a class="el" href="classoperations__research_1_1_m_p_model_delta_proto.html">MPModelDeltaProto</a> applied to a given baseline model (assumed valid, eg. <a href="namespaceoperations__research.html#a1fe0ce1e27e08e817ec6f105976b729f">More...</a><br /></td></tr>
<tr class="separator:a1fe0ce1e27e08e817ec6f105976b729f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5d41884f3ad7b19224d25ba9bccd55a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#af5d41884f3ad7b19224d25ba9bccd55a">MergeMPConstraintProtoExceptTerms</a> (const MPConstraintProto &amp;from, MPConstraintProto *to)</td></tr>
<tr class="separator:af5d41884f3ad7b19224d25ba9bccd55a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fa4ae40c78d7a248efb26fde93fb805"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a5fa4ae40c78d7a248efb26fde93fb805">ApplyVerifiedMPModelDelta</a> (const MPModelDeltaProto &amp;<a class="el" href="resource_8cc.html#af12056bc2a8e3ec563f0940d87abbd2e">delta</a>, MPModelProto *<a class="el" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>)</td></tr>
<tr class="separator:a5fa4ae40c78d7a248efb26fde93fb805"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aff224abb81f10208eec52534c895aa07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff224abb81f10208eec52534c895aa07">&#9670;&nbsp;</a></span>COPY_FIELD_IF_PRESENT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COPY_FIELD_IF_PRESENT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">field</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="parser_8yy_8cc.html#a33e91cd0cef6786e9e3a27ac67707207">if</a> (from.has_##field()) to-&gt;set_##field(from.field())</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3f15a1b3b1e093ebe2375816984f938a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f15a1b3b1e093ebe2375816984f938a">&#9670;&nbsp;</a></span>ABSL_FLAG()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ABSL_FLAG </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">model_validator_infinity&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">1e100&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&quot;Anything above or equal to this magnitude will be considered infinity.&quot;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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_4d3a5a688e4550f3d7725aaa5ab9c27b.html">linear_solver</a></li><li class="navelem"><a class="el" href="linear__solver_2model__validator_8cc.html">model_validator.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.8.15 </li>
</ul>
</div>
</body>
</html>