165 lines
19 KiB
HTML
165 lines
19 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"/>-->
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.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="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">Google OR-Tools 9.3</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.9.3 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('cp__model__solver_8h_source.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="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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" 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 id="l00003" 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 id="l00004" 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 id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" 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 id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" 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 id="l00009" 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 id="l00010" 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 id="l00011" 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 id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" 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 id="l00015" 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 id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "ortools/base/integral_types.h"</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include "ortools/sat/cp_model.pb.h"</span></div>
|
|
<div class="line"><a id="l00023" 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 id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "ortools/sat/sat_parameters.pb.h"</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span>sat {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8"> 30</a></span>CpSolverResponse <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8">Solve</a>(<span class="keyword">const</span> CpModelProto& model_proto);</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12"> 33</a></span>CpSolverResponse <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">SolveWithParameters</a>(<span class="keyword">const</span> CpModelProto& model_proto,</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">const</span> SatParameters& params);</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb"> 37</a></span>std::string <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb">CpModelStats</a>(<span class="keyword">const</span> CpModelProto& model);</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a74d5c1c69142b6e668f8bc7de4e0ec7e"> 45</a></span>std::string <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a74d5c1c69142b6e668f8bc7de4e0ec7e">CpSolverResponseStats</a>(<span class="keyword">const</span> CpSolverResponse& response,</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">bool</span> has_objective = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf"> 59</a></span>CpSolverResponse <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf">SolveCpModel</a>(<span class="keyword">const</span> CpModelProto& model_proto, <a class="code hl_class" href="classoperations__research_1_1sat_1_1_model.html">Model</a>* model);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#af52c27ecb43d6486c1a70e022b4aad39"> 66</a></span>CpSolverResponse <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">SolveWithParameters</a>(<span class="keyword">const</span> CpModelProto& model_proto,</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">const</span> std::string& params);</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#endif </span><span class="comment">// !__PORTABLE_PLATFORM__</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a0558490428f07c5db7b6ae292001375c"> 89</a></span>std::function<void(<a class="code hl_class" href="classoperations__research_1_1sat_1_1_model.html">Model</a>*)> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a0558490428f07c5db7b6ae292001375c">NewFeasibleSolutionObserver</a>(</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> CpSolverResponse& response)>& observer);</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="preprocessor">#if !defined(__PORTABLE_PLATFORM__)</span></div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b"> 100</a></span>std::function<SatParameters(<a class="code hl_class" href="classoperations__research_1_1sat_1_1_model.html">Model</a>*)> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">NewSatParameters</a>(</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">const</span> std::string& params);</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#endif </span><span class="comment">// !__PORTABLE_PLATFORM__</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1sat.html#adbf4fa68898b3aaa2e6de2b5d3064580"> 103</a></span>std::function<SatParameters(<a class="code hl_class" href="classoperations__research_1_1sat_1_1_model.html">Model</a>*)> <a class="code hl_function" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">NewSatParameters</a>(</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">const</span> SatParameters& parameters);</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>} <span class="comment">// namespace sat</span></div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_SAT_CP_MODEL_SOLVER_H_</span></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1_model_html"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.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#l00042">model.h:42</a></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_a0558490428f07c5db7b6ae292001375c"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a0558490428f07c5db7b6ae292001375c">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>
|
|
<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_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">Creates parameters for the solver, which you can add to the model with.</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_a74d5c1c69142b6e668f8bc7de4e0ec7e"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a74d5c1c69142b6e668f8bc7de4e0ec7e">operations_research::sat::CpSolverResponseStats</a></div><div class="ttdeci">std::string CpSolverResponseStats(const CpSolverResponse &response, bool has_objective=true)</div><div class="ttdoc">Returns a string with some statistics on the solver response.</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="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 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#l00058">cp_model.h:58</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div>
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|