135 lines
18 KiB
HTML
135 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>OR-Tools</title>
|
|
<meta http-equiv="Content-Type" content="text/html;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">Google OR-Tools 7.5</span>
|
|
</div>
|
|
</div>
|
|
<div id="content" style="width: 100%; overflow: hidden;">
|
|
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
|
<h2>C++ Reference</h2>
|
|
<ul>
|
|
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
|
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
|
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
|
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
|
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<div align="center">
|
|
<h1 style="color: #145A32;">C++ Reference: CP-SAT</h1>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_dddac007a45022d9da6ea1dee012c3b9.html">sat</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">cp_model_solver.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="cp__model__solver_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> <span class="comment">// Copyright 2010-2018 Google LLC</span></div>
|
|
<div class="line"><a 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 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 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 name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 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 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef OR_TOOLS_SAT_CP_MODEL_SOLVER_H_</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define OR_TOOLS_SAT_CP_MODEL_SOLVER_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "ortools/base/integral_types.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="cp__model_8pb_8h.html">ortools/sat/cp_model.pb.h</a>"</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="model_8h.html">ortools/sat/model.h</a>"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "ortools/sat/sat_parameters.pb.h"</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <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</span> <span class="keyword">namespace </span>sat {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> CpSolverResponse <a class="code" href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8">Solve</a>(<span class="keyword">const</span> CpModelProto& model_proto);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> CpSolverResponse <a class="code" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">SolveWithParameters</a>(<span class="keyword">const</span> CpModelProto& model_proto,</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">const</span> SatParameters& params);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> std::string <a class="code" href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb">CpModelStats</a>(<span class="keyword">const</span> CpModelProto& model);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> std::string <a class="code" href="namespaceoperations__research_1_1sat.html#ac2d87e8109f9c60f7af84a60106abd57">CpSolverResponseStats</a>(<span class="keyword">const</span> CpSolverResponse& response);</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> CpSolverResponse <a class="code" href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf">SolveCpModel</a>(<span class="keyword">const</span> CpModelProto& model_proto, Model* model);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> CpSolverResponse <a class="code" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">SolveWithParameters</a>(<span class="keyword">const</span> CpModelProto& model_proto,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> std::string& params);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#endif // !__PORTABLE_PLATFORM__</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a47117e7eefc0bb9b66054a64988804e6"> 72</a></span> std::function<void(<a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>*)> <a class="code" href="namespaceoperations__research_1_1sat.html#a47117e7eefc0bb9b66054a64988804e6">NewFeasibleSolutionObserver</a>(</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> <a class="code" href="classoperations__research_1_1sat_1_1CpSolverResponse.html">CpSolverResponse</a>& response)>& observer);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">void</span> <a class="code" href="namespaceoperations__research_1_1sat.html#ad04337634227eac006d3e33a7028f82f">SetSynchronizationFunction</a>(std::function<<a class="code" href="classoperations__research_1_1sat_1_1CpSolverResponse.html">CpSolverResponse</a>()> f,</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>* model);</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a1684fe34484d78336d3cdac55ec6de57"> 97</a></span> std::function<SatParameters(<a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>*)> <a class="code" href="namespaceoperations__research_1_1sat.html#a1684fe34484d78336d3cdac55ec6de57">NewSatParameters</a>(</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> std::string& params);</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // !__PORTABLE_PLATFORM__</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> std::function<SatParameters(<a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>*)> <a class="code" href="namespaceoperations__research_1_1sat.html#a1684fe34484d78336d3cdac55ec6de57">NewSatParameters</a>(</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">const</span> SatParameters& parameters);</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// namespace sat</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif // OR_TOOLS_SAT_CP_MODEL_SOLVER_H_</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="acp__model_8pb_8h_html"><div class="ttname"><a href="cp__model_8pb_8h.html">cp_model.pb.h</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_ac2d87e8109f9c60f7af84a60106abd57"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#ac2d87e8109f9c60f7af84a60106abd57">operations_research::sat::CpSolverResponseStats</a></div><div class="ttdeci">std::string CpSolverResponseStats(const CpSolverResponse &response)</div><div class="ttdoc">Returns a string with some statistics on the solver response.</div></div>
|
|
<div class="ttc" id="amodel_8h_html"><div class="ttname"><a href="model_8h.html">model.h</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a287579e5f181fc7c89feccf1128faffb"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb">operations_research::sat::CpModelStats</a></div><div class="ttdeci">std::string CpModelStats(const CpModelProto &model)</div><div class="ttdoc">Returns a string with some statistics on the given CpModelProto.</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a09d851f944ab4f305c3d9f8df99b7bf8"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8">operations_research::sat::Solve</a></div><div class="ttdeci">CpSolverResponse Solve(const CpModelProto &model_proto)</div><div class="ttdoc">Solves the given CpModelProto and returns an instance of CpSolverResponse.</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdef"><b>Definition:</b> <a href="cp__model_8h_source.html#l00052">cp_model.h:52</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1Model_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1Model.html">operations_research::sat::Model</a></div><div class="ttdoc">Class that owns everything related to a particular optimization model.</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00038">model.h:38</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a47117e7eefc0bb9b66054a64988804e6"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a47117e7eefc0bb9b66054a64988804e6">operations_research::sat::NewFeasibleSolutionObserver</a></div><div class="ttdeci">std::function< void(Model *)> NewFeasibleSolutionObserver(const std::function< void(const CpSolverResponse &response)> &observer)</div><div class="ttdoc">Creates a solution observer with the model with model.Add(NewFeasibleSolutionObserver([](response){....</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__solver_8h_source.html#l00072">cp_model_solver.h:72</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a9d67b9c66f1cb9c1dcc3415cd5af11bf"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf">operations_research::sat::SolveCpModel</a></div><div class="ttdeci">CpSolverResponse SolveCpModel(const CpModelProto &model_proto, Model *model)</div><div class="ttdoc">Solves the given CpModelProto.</div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1CpSolverResponse_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1CpSolverResponse.html">operations_research::sat::CpSolverResponse</a></div><div class="ttdef"><b>Definition:</b> <a href="cp__model_8pb_8h_source.html#l05256">cp_model.pb.h:5256</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a1684fe34484d78336d3cdac55ec6de57"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a1684fe34484d78336d3cdac55ec6de57">operations_research::sat::NewSatParameters</a></div><div class="ttdeci">std::function< SatParameters(Model *)> NewSatParameters(const std::string &params)</div><div class="ttdoc">Creates parameters for the solver, which you can add to the model with.</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__solver_8h_source.html#l00097">cp_model_solver.h:97</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_ad04337634227eac006d3e33a7028f82f"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#ad04337634227eac006d3e33a7028f82f">operations_research::sat::SetSynchronizationFunction</a></div><div class="ttdeci">void SetSynchronizationFunction(std::function< CpSolverResponse()> f, Model *model)</div><div class="ttdoc">If set, the underlying solver will call this function regularly in a deterministic way.</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_aa3062797aa0396abf37dbcc99a746f12"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">operations_research::sat::SolveWithParameters</a></div><div class="ttdeci">CpSolverResponse SolveWithParameters(const CpModelProto &model_proto, const SatParameters &params)</div><div class="ttdoc">Solves the given CpModelProto with the given parameters.</div></div>
|
|
</div>
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|