Files
ortools-clone/docs/cpp_sat/model_8h_source.html

110 lines
33 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2019-06-12 22:00:29 +02:00
<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>
2020-09-01 16:00:33 +02:00
<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">
2021-09-20 15:57:27 +02:00
<span id="sfml">Google OR-Tools 9.1</span>
</div>
</div>
2019-08-07 18:01:08 -07:00
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
2019-08-12 09:16:03 -07:00
<h2>C++ Reference</h2>
2019-08-07 18:01:08 -07:00
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
2019-08-12 09:16:03 -07:00
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
2019-08-07 18:01:08 -07:00
<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">
2019-08-07 18:01:08 -07:00
<div align="center">
<h1 style="color: #145A32;">C++ Reference: CP-SAT</h1>
</div>
2021-09-20 15:57:27 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2020-09-01 16:00:33 +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-01 16:00:33 +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">
2019-06-12 22:00:29 +02:00
</div>
2019-07-12 13:25:23 -07:00
</div>
2020-09-01 16:00:33 +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
$(document).ready(function(){initNavTree('model_8h_source.html','');});
2020-09-01 16:00:33 +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>
2019-06-12 22:00:29 +02:00
<div class="header">
<div class="headertitle">
<div class="title">model.h</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<a href="model_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="preprocessor">#ifndef OR_TOOLS_SAT_MODEL_H_</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define OR_TOOLS_SAT_MODEL_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;memory&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;ortools/base/logging.h&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;ortools/base/macros.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;ortools/base/map_util.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;ortools/base/typeid.h&quot;</s
<div class="ttc" id="classoperations__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#l00038">model.h:38</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a8d72645353ea6770911c4e0724995ed6"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a8d72645353ea6770911c4e0724995ed6">operations_research::sat::Model::GetOrCreate</a></div><div class="ttdeci">T * GetOrCreate()</div><div class="ttdoc">Returns an object of type T that is unique to this model (like a &quot;local&quot; singleton).</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00106">model.h:106</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_ad5efe7312ac548dfc3e91cff8c84b256"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#ad5efe7312ac548dfc3e91cff8c84b256">operations_research::sat::Model::Model</a></div><div class="ttdeci">Model(std::string name)</div><div class="ttdoc">When there is more than one model in an application, it makes sense to name them for debugging or log...</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00054">model.h:54</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a30c57abda5ed227c85b50007cee876db"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a30c57abda5ed227c85b50007cee876db">operations_research::sat::Model::Model</a></div><div class="ttdeci">Model()</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00040">model.h:40</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a572e6368e1bf222cda8edfe559ec686b"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a572e6368e1bf222cda8edfe559ec686b">operations_research::sat::Model::Create</a></div><div class="ttdeci">T * Create()</div><div class="ttdoc">This returns a non-singleton object owned by the model and created with the T(Model* model) construct...</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00157">model.h:157</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a37eb53a23cb596ef5d2e3bbc0fab70dc"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a37eb53a23cb596ef5d2e3bbc0fab70dc">operations_research::sat::Model::Get</a></div><div class="ttdeci">T Get(std::function&lt; T(const Model &amp;)&gt; f) const</div><div class="ttdoc">Similar to Add() but this is const.</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00087">model.h:87</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a7b8d774b566431b8932ba0f3c921ec7d"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a7b8d774b566431b8932ba0f3c921ec7d">operations_research::sat::Model::Add</a></div><div class="ttdeci">T Add(std::function&lt; T(Model *)&gt; f)</div><div class="ttdoc">This makes it possible to have a nicer API on the client side, and it allows both of these forms:</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00081">model.h:81</a></div></div>
<div class="ttc" id="namespaceoperations__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#l00054">cp_model.h:54</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a191cd9b1ba3e3c01a558a1f6c02a4429"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a191cd9b1ba3e3c01a558a1f6c02a4429">operations_research::sat::Model::Name</a></div><div class="ttdeci">const std::string &amp; Name() const</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00175">model.h:175</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a252c349b237f7779edf32778eb541a99"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a252c349b237f7779edf32778eb541a99">operations_research::sat::Model::~Model</a></div><div class="ttdeci">~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="classoperations__research_1_1sat_1_1_model_html_a66b60c092ecee6c1aa8c6a8823ab19d8"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a66b60c092ecee6c1aa8c6a8823ab19d8">operations_research::sat::Model::Get</a></div><div class="ttdeci">const T * Get() const</div><div class="ttdoc">Likes GetOrCreate() but do not create the object if it is non-existing.</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00127">model.h:127</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_a7fac5de5604ea8668bc414536e8aa7ee"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#a7fac5de5604ea8668bc414536e8aa7ee">operations_research::sat::Model::Register</a></div><div class="ttdeci">void Register(T *non_owned_class)</div><div class="ttdoc">Register a non-owned class that will be &quot;singleton&quot; in the model.</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00169">model.h:169</a></div></div>
<div class="ttc" id="classoperations__research_1_1sat_1_1_model_html_ac779eb15f8e4162692d13c584426d693"><div class="ttname"><a href="classoperations__research_1_1sat_1_1_model.html#ac779eb15f8e4162692d13c584426d693">operations_research::sat::Model::Mutable</a></div><div class="ttdeci">T * Mutable() const</div><div class="ttdoc">Same as Get(), but returns a mutable version of the object.</div><div class="ttdef"><b>Definition:</b> <a href="model_8h_source.html#l00136">model.h:136</a></div></div>
2021-01-26 11:28:50 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2019-08-07 18:01:08 -07:00
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
2019-06-12 22:00:29 +02:00
</html>