81 lines
24 KiB
HTML
81 lines
24 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">OR-Tools 7.2</span>
|
|
</div>
|
|
</div>
|
|
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('cp__model__solver_8h_source.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<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 "<a class="code" href="sat__parameters_8pb_8h.html">ortools/sat/sat_parameters.pb.h</a>"</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="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Returns a std::string with some statistics on the given CpModelProto.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</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="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Returns a std::string with some statistics on the solver response.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</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="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Solves the given CpModelProto.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Note that the API takes a Model* that will be filled with the in-memory</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// representation of the given CpModelProto. It is done this way so that it is</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// easy to set custom parameters or interrupt the solver will calls like:</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// - model->Add(NewSatParameters(parameters_as_string_or_proto));</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// - model->GetOrCreate<TimeLimit>()->RegisterExternalBooleanAsLimit(&stop);</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</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="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Solves the given cp_model and returns an instance of CpSolverResponse.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</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="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// Solves the given cp_model with the give sat parameters, and returns an</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// instance of CpSolverResponse.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</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="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> SatParameters& params);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Solves the given cp_model with the given sat parameters as std::string in</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// JSon format, and returns an instance of CpSolverResponse.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</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="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> std::string& params);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif // !__PORTABLE_PLATFORM__</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// Allows to register a solution "observer" with the model with</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// model.Add(NewFeasibleSolutionObserver([](response){...}));</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// The given function will be called on each "improving" feasible solution found</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// during the search. For a non-optimization problem, if the option to find all</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// solution was set, then this will be called on each new solution.</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#aacf15d440f0db4cd0a63c8aebe85db6d"> 64</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#aacf15d440f0db4cd0a63c8aebe85db6d">NewFeasibleSolutionObserver</a>(</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</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="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// If set, the underlying solver will call this function "regularly" in a</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// deterministic way. It will then wait until this function returns with the</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// current "best" information about the current problem.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">//</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// This is meant to be used in a multi-threaded environment with many parallel</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// solving process. If the returned current "best" response only uses</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// informations derived at a lower deterministic time (possibly with offset)</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// than the deterministic time of the current thread, then the whole process can</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// be made deterministic.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>* model);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Allows to change the default parameters with</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// model->Add(NewSatParameters(parameters_as_string_or_proto))</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// before calling SolveCpModel().</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b"> 83</a></span> std::function<<a class="code" href="classoperations__research_1_1sat_1_1SatParameters.html">SatParameters</a>(<a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>*)> <a class="code" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">NewSatParameters</a>(</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> std::string& params);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // !__PORTABLE_PLATFORM__</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> std::function<<a class="code" href="classoperations__research_1_1sat_1_1SatParameters.html">SatParameters</a>(<a class="code" href="classoperations__research_1_1sat_1_1Model.html">Model</a>*)> <a class="code" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">NewSatParameters</a>(</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> <a class="code" href="classoperations__research_1_1sat_1_1SatParameters.html">SatParameters</a>& parameters);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> } <span class="comment">// namespace sat</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } <span class="comment">// namespace operations_research</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // OR_TOOLS_SAT_CP_MODEL_SOLVER_H_</span></div><div class="ttc" id="namespaceoperations__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 std::string with some statistics on the given CpModelProto.</div></div>
|
|
<div class="ttc" id="namespaceoperations__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="namespaceoperations__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="namespaceoperations__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 std::string with some statistics on the solver response.</div></div>
|
|
<div class="ttc" id="classoperations__research_1_1sat_1_1SatParameters_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1SatParameters.html">operations_research::sat::SatParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="sat__parameters_8pb_8h_source.html#l00324">sat_parameters.pb.h:324</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__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 cp_model and returns an instance of CpSolverResponse.</div></div>
|
|
<div class="ttc" id="model_8h_html"><div class="ttname"><a href="model_8h.html">model.h</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_1_1sat_html_aacf15d440f0db4cd0a63c8aebe85db6d"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#aacf15d440f0db4cd0a63c8aebe85db6d">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">Allows to register a solution "observer" with the model with model.Add(NewFeasibleSolutionObserver([]...</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__solver_8h_source.html#l00064">cp_model_solver.h:64</a></div></div>
|
|
<div class="ttc" id="classoperations__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#l00035">model.h:35</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__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 cp_model with the give sat parameters, and returns an instance of CpSolverResponse.</div></div>
|
|
<div class="ttc" id="namespaceoperations__research_1_1sat_html_a10700832ca6bc420f2931eb707957b0b"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">operations_research::sat::NewSatParameters</a></div><div class="ttdeci">std::function< SatParameters(Model *)> NewSatParameters(const std::string &params)</div><div class="ttdoc">Allows to change the default parameters with model->Add(NewSatParameters(parameters_as_string_or_prot...</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__solver_8h_source.html#l00083">cp_model_solver.h:83</a></div></div>
|
|
<div class="ttc" id="sat__parameters_8pb_8h_html"><div class="ttname"><a href="sat__parameters_8pb_8h.html">sat_parameters.pb.h</a></div></div>
|
|
<div class="ttc" id="cp__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="classoperations__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#l04189">cp_model.pb.h:4189</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">Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in c...</div><div class="ttdef"><b>Definition:</b> <a href="cp__model_8h_source.html#l00048">cp_model.h:48</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|