Files
ortools-clone/docs/cpp/linear__solver__callback_8h_source.html

145 lines
49 KiB
HTML
Raw Normal View History

2020-09-02 09:42:51 +02:00
<!-- 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"/>
2021-09-20 15:57:27 +02:00
<meta name="generator" content="Doxygen 1.8.15"/>
2020-09-02 09:42:51 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: linear_solver_callback.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>
2021-09-20 15:57:27 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
2020-09-02 09:42:51 +02:00
<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
2021-09-20 15:57:27 +02:00
&#160;<span id="projectnumber">9.1</span>
2020-09-02 09:42:51 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2021-09-20 15:57:27 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2020-09-02 09:42:51 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-09-20 15:57:27 +02:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2020-09-02 09:42:51 +02:00
/* @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 */
2021-09-20 15:57:27 +02:00
$(document).ready(function(){initNavTree('linear__solver__callback_8h_source.html','');});
2020-09-02 09:42:51 +02:00
/* @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">linear_solver_callback.h</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<a href="linear__solver__callback_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2010-2021 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See go/mpsolver-callbacks for documentation on how to use this file.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#ifndef OR_TOOLS_LINEAR_SOLVER_LINEAR_SOLVER_CALLBACK_H_</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define OR_TOOLS_LINEAR_SOLVER_LINEAR_SOLVER_CALLBACK_H_</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;absl/container/flat_hash_map.h&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="integral__types_8h.html">ortools/base/integral_types.h</a>&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27<
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a181258232152ad012fb0f7430248eef2"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a181258232152ad012fb0f7430248eef2">operations_research::MPCallbackEvent::kMultiObj</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831affa5976cb7170d234d6b69921bf0f085"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831affa5976cb7170d234d6b69921bf0f085">operations_research::MPCallbackEvent::kBarrier</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a23fc0ff92a3f47fe0bd2ad3eac3c9b57"><div class="ttname"><a href="namespaceoperations__research.html#a23fc0ff92a3f47fe0bd2ad3eac3c9b57">operations_research::ToString</a></div><div class="ttdeci">const absl::string_view ToString(MPSolver::OptimizationProblemType optimization_problem_type)</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8cc_source.html#l00576">linear_solver.cc:576</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_list_html_abb47cd17f712efd8141cc579d6b9649a"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_list.html#abb47cd17f712efd8141cc579d6b9649a">operations_research::MPCallbackList::MPCallbackList</a></div><div class="ttdeci">MPCallbackList(const std::vector&lt; MPCallback * &gt; &amp;callbacks)</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8cc_source.html#l00072">linear_solver_callback.cc:72</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831aac5d782c5d5407f4f333a40c2cc681ba"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831aac5d782c5d5407f4f333a40c2cc681ba">operations_research::MPCallbackEvent::kPresolve</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_acd15f7b9f561c710a6bfab60cdb2849a"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#acd15f7b9f561c710a6bfab60cdb2849a">operations_research::MPCallbackContext::~MPCallbackContext</a></div><div class="ttdeci">virtual ~MPCallbackContext()</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00068">linear_solver_callback.h:68</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html">operations_research::MPCallbackContext</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00066">linear_solver_callback.h:66</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_list_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_list.html">operations_research::MPCallbackList</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00169">linear_solver_callback.h:169</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_a44b21129261e8cdc93d44c39212ba1dd"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#a44b21129261e8cdc93d44c39212ba1dd">operations_research::MPCallbackContext::NumExploredNodes</a></div><div class="ttdeci">virtual int64_t NumExploredNodes()=0</div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_aa1db5c0051875f7406a147aed7a13649"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#aa1db5c0051875f7406a147aed7a13649">operations_research::MPCallbackContext::AddLazyConstraint</a></div><div class="ttdeci">virtual void AddLazyConstraint(const LinearRange &amp;lazy_constraint)=0</div></div>
<div class="ttc" id="integral__types_8h_html"><div class="ttname"><a href="integral__types_8h.html">integral_types.h</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_variable_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_variable.html">operations_research::MPVariable</a></div><div class="ttdoc">The class for variables of a Mathematical Programming (MP) model.</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8h_source.html#l01071">linear_solver.h:1071</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html_a519c91052e0070bc1097e35746025e37"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html#a519c91052e0070bc1097e35746025e37">operations_research::MPCallback::~MPCallback</a></div><div class="ttdeci">virtual ~MPCallback()</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00150">linear_solver_callback.h:150</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_list_html_a0619d58e42c894eeb17561753709d495"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_list.html#a0619d58e42c894eeb17561753709d495">operations_research::MPCallbackList::RunCallback</a></div><div class="ttdeci">void RunCallback(MPCallbackContext *context) override</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8cc_source.html#l00077">linear_solver_callback.cc:77</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_a83fb66141e4b17ee11bfa9e04dc66563"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#a83fb66141e4b17ee11bfa9e04dc66563">operations_research::MPCallbackContext::VariableValue</a></div><div class="ttdeci">virtual double VariableValue(const MPVariable *variable)=0</div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html_abddae1c9b6bfbbdbfc71179ecfff625e"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html#abddae1c9b6bfbbdbfc71179ecfff625e">operations_research::MPCallback::RunCallback</a></div><div class="ttdeci">virtual void RunCallback(MPCallbackContext *callback_context)=0</div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831ae97d1190dcdbe357a2cf9498ce213335"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831ae97d1190dcdbe357a2cf9498ce213335">operations_research::MPCallbackEvent::kSimplex</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a68ecbabf5f60cdbc5b8d5737fae095b5"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a68ecbabf5f60cdbc5b8d5737fae095b5">operations_research::MPCallbackEvent::kPolling</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html_a6da3cbc1e9119318f3d44a6e4d49f02f"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html#a6da3cbc1e9119318f3d44a6e4d49f02f">operations_research::MPCallback::MPCallback</a></div><div class="ttdeci">MPCallback(bool might_add_cuts, bool might_add_lazy_constraints)</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00147">linear_solver_callback.h:147</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_aef6f1a998a5e8be2a006cc8d0728975d"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#aef6f1a998a5e8be2a006cc8d0728975d">operations_research::MPCallbackContext::SuggestSolution</a></div><div class="ttdeci">virtual double SuggestSolution(const absl::flat_hash_map&lt; const MPVariable *, double &gt; &amp;solution)=0</div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_aad0fd4b98cffeb1caa42d0bf3032607b"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#aad0fd4b98cffeb1caa42d0bf3032607b">operations_research::MPCallbackContext::AddCut</a></div><div class="ttdeci">virtual void AddCut(const LinearRange &amp;cutting_plane)=0</div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831af29c26bf194553ac39cae68e31d6175c"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831af29c26bf194553ac39cae68e31d6175c">operations_research::MPCallbackEvent::kMipNode</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a2cf6e729c26edab22a90defbd8af7d67"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a2cf6e729c26edab22a90defbd8af7d67">operations_research::MPCallbackEvent::kMip</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a9b74dc5b6954a9e2ba62b24c1f8c01e0"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a9b74dc5b6954a9e2ba62b24c1f8c01e0">operations_research::MPCallbackEvent::kMessage</a></div></div>
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html">operations_research::MPCallback</a></div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00142">linear_solver_callback.h:142</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html_a908b5e074d2670fb495f6e899efdf3d3"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html#a908b5e074d2670fb495f6e899efdf3d3">operations_research::MPCallback::might_add_cuts</a></div><div class="ttdeci">bool might_add_cuts() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00157">linear_solver_callback.h:157</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a25c2dc47991b3df171ed5192bcf70390"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a25c2dc47991b3df171ed5192bcf70390">operations_research::MPCallbackEvent::kUnknown</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html">operations_research::LinearRange</a></div><div class="ttdoc">An expression of the form:</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00192">linear_expr.h:192</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_context_html_a114b177c99f427b6d0d6b1b379b5838a"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback_context.html#a114b177c99f427b6d0d6b1b379b5838a">operations_research::MPCallbackContext::Event</a></div><div class="ttdeci">virtual MPCallbackEvent Event()=0</div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831a744c240a000894a88cd9f4740db5b87f"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831a744c240a000894a88cd9f4740db5b87f">operations_research::MPCallbackEvent::kMipSolution</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_callback_html_aba25bfa60f26f0275a683ce9ec618de3"><div class="ttname"><a href="classoperations__research_1_1_m_p_callback.html#aba25bfa60f26f0275a683ce9ec618de3">operations_research::MPCallback::might_add_lazy_constraints</a></div><div class="ttdeci">bool might_add_lazy_constraints() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00158">linear_solver_callback.h:158</a></div></div>
<div class="ttc" id="gurobi__interface_8cc_html_a5f287b83a753915ae862fed64f8640a6"><div class="ttname"><a href="gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6">context</a></div><div class="ttdeci">GurobiMPCallbackContext * context</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00513">gurobi_interface.cc:513</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a4f0b2adea9a4297f27df941fe3ed3831"><div class="ttname"><a href="namespaceoperations__research.html#a4f0b2adea9a4297f27df941fe3ed3831">operations_research::MPCallbackEvent</a></div><div class="ttdeci">MPCallbackEvent</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver__callback_8h_source.html#l00037">linear_solver_callback.h:37</a></div></div>
2021-01-26 11:28:50 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2020-09-02 09:42:51 +02:00
<!-- 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__callback_8h.html">linear_solver_callback.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2021-09-20 15:57:27 +02:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2020-09-02 09:42:51 +02:00
</ul>
</div>
</body>
</html>