always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
93adfb62ac7e500e7489d63f3aca729da8d8d012
ortools-clone/docs/cpp/scip__interface_8cc.html
Mizux Seiha d1b6751cad Update doc
2020-11-18 14:53:53 +01:00

291 lines
17 KiB
HTML
Raw Blame History

<!-- 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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: scip_interface.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">8.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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('scip__interface_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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">scip_interface.cc File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="scip__interface_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="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_1_s_c_i_p_interface.html">SCIPInterface</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_1_scip_constraint_handler_for_m_p_callback.html">ScipConstraintHandlerForMPCallback</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_1_scip_m_p_callback_context.html">ScipMPCallbackContext</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 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">The vehicle routing library lets one model and solve generic vehicle routing problems ranging from the Traveling Salesman Problem to more complex problems such as the Capacitated Vehicle Routing Problem with Time Windows. <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:a1ea9e351e9f26e38b029c3cb01f167cd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scip__interface_8cc.html#a1ea9e351e9f26e38b029c3cb01f167cd">RETURN_IF_ALREADY_IN_ERROR_STATE</a></td></tr>
<tr class="separator:a1ea9e351e9f26e38b029c3cb01f167cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bee93eab1478b18c16b877db7c3885f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scip__interface_8cc.html#a3bee93eab1478b18c16b877db7c3885f">RETURN_AND_STORE_IF_SCIP_ERROR</a>(x)</td></tr>
<tr class="separator:a3bee93eab1478b18c16b877db7c3885f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8cab6c879dc456fe0096c02bce706e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scip__interface_8cc.html#a8e8cab6c879dc456fe0096c02bce706e">RETURN_ABNORMAL_IF_BAD_STATUS</a></td></tr>
<tr class="separator:a8e8cab6c879dc456fe0096c02bce706e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2062b8242f9df918deea5453973753f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scip__interface_8cc.html#a2062b8242f9df918deea5453973753f4">RETURN_ABNORMAL_IF_SCIP_ERROR</a>(x)</td></tr>
<tr class="separator:a2062b8242f9df918deea5453973753f4"><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:a0c995fe033eca0f3e3213f56e9f4d258"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scip__interface_8cc.html#a0c995fe033eca0f3e3213f56e9f4d258">ABSL_FLAG</a> (bool, scip_feasibility_emphasis, false, &quot;When true, emphasize search towards feasibility. This may or &quot; &quot;may not result in speedups in some problems.&quot;)</td></tr>
<tr class="separator:a0c995fe033eca0f3e3213f56e9f4d258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bdf7de568fd36934caf67b1bfd20455"><td class="memItemLeft" align="right" valign="top">MPSolverInterface *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a1bdf7de568fd36934caf67b1bfd20455">BuildSCIPInterface</a> (MPSolver *const solver)</td></tr>
<tr class="separator:a1bdf7de568fd36934caf67b1bfd20455"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8e8cab6c879dc456fe0096c02bce706e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e8cab6c879dc456fe0096c02bce706e">&#9670;&nbsp;</a></span>RETURN_ABNORMAL_IF_BAD_STATUS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_ABNORMAL_IF_BAD_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (!status_.ok()) { \</div>
<div class="line"> LOG_IF(<a class="code" href="log__severity_8h.html#ab4a2cbab234914b320b7fae11b6e8cb9">INFO</a>, solver_-&gt;OutputIsEnabled()) \</div>
<div class="line"> &lt;&lt; <span class="stringliteral">&quot;Invalid SCIP status: &quot;</span> &lt;&lt; status_; \</div>
<div class="line"> return result_status_ = MPSolver::ABNORMAL; \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="scip__interface_8cc_source.html#l00614">614</a> of file <a class="el" href="scip__interface_8cc_source.html">scip_interface.cc</a>.</p>
</div>
</div>
<a id="a2062b8242f9df918deea5453973753f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2062b8242f9df918deea5453973753f4">&#9670;&nbsp;</a></span>RETURN_ABNORMAL_IF_SCIP_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_ABNORMAL_IF_SCIP_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> RETURN_ABNORMAL_IF_BAD_STATUS; \</div>
<div class="line"> status_ = <a class="code" href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a>(x); \</div>
<div class="line"> RETURN_ABNORMAL_IF_BAD_STATUS; \</div>
<div class="line"> } <span class="keywordflow">while</span> (<span class="keyword">false</span>);</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="scip__interface_8cc_source.html#l00623">623</a> of file <a class="el" href="scip__interface_8cc_source.html">scip_interface.cc</a>.</p>
</div>
</div>
<a id="a3bee93eab1478b18c16b877db7c3885f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bee93eab1478b18c16b877db7c3885f">&#9670;&nbsp;</a></span>RETURN_AND_STORE_IF_SCIP_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_AND_STORE_IF_SCIP_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> status_ = <a class="code" href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a>(x); \</div>
<div class="line"> if (!status_.ok()) return; \</div>
<div class="line"> } while (false)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="scip__interface_8cc_source.html#l00282">282</a> of file <a class="el" href="scip__interface_8cc_source.html">scip_interface.cc</a>.</p>
</div>
</div>
<a id="a1ea9e351e9f26e38b029c3cb01f167cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ea9e351e9f26e38b029c3cb01f167cd">&#9670;&nbsp;</a></span>RETURN_IF_ALREADY_IN_ERROR_STATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RETURN_IF_ALREADY_IN_ERROR_STATE</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (!status_.ok()) { \</div>
<div class="line"> VLOG_EVERY_N(1, 10) &lt;&lt; <span class="stringliteral">&quot;Early abort: SCIP is in error state.&quot;</span>; \</div>
<div class="line"> return; \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="scip__interface_8cc_source.html#l00274">274</a> of file <a class="el" href="scip__interface_8cc_source.html">scip_interface.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0c995fe033eca0f3e3213f56e9f4d258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c995fe033eca0f3e3213f56e9f4d258">&#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">bool&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">scip_feasibility_emphasis&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">false&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&quot;When&#160;</td>
<td class="paramname"><em>true</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">emphasize search towards feasibility. This may or &quot; &quot;may not result in speedups in some problems.&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 -->
<div class="ttc" id="alog__severity_8h_html_ab4a2cbab234914b320b7fae11b6e8cb9"><div class="ttname"><a href="log__severity_8h.html#ab4a2cbab234914b320b7fae11b6e8cb9">INFO</a></div><div class="ttdeci">const int INFO</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00031">log_severity.h:31</a></div></div>
<div class="ttc" id="ascip__helper__macros_8h_html_a01a5597b6c8cb50ac465e5abebf00eec"><div class="ttname"><a href="scip__helper__macros_8h.html#a01a5597b6c8cb50ac465e5abebf00eec">SCIP_TO_STATUS</a></div><div class="ttdeci">#define SCIP_TO_STATUS(x)</div><div class="ttdef"><b>Definition:</b> <a href="scip__helper__macros_8h_source.html#l00039">scip_helper_macros.h:39</a></div></div>
<!-- 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="scip__interface_8cc.html">scip_interface.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.20 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink