536 lines
32 KiB
HTML
536 lines
32 KiB
HTML
<!-- 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"/>
|
|
<meta name="generator" content="Doxygen 1.8.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: Model</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>
|
|
<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
|
|
 <span id="projectnumber">8.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classoperations__research_1_1sat_1_1Model.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="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classoperations__research_1_1sat_1_1Model-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Model</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class that owns everything related to a particular optimization model. </p>
|
|
<p>This class is actually a fully generic wrapper that can hold any type of constraints, watchers, solvers and provide a mecanism to wire them together. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00038">38</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a30c57abda5ed227c85b50007cee876db"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a30c57abda5ed227c85b50007cee876db">Model</a> ()</td></tr>
|
|
<tr class="separator:a30c57abda5ed227c85b50007cee876db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a252c349b237f7779edf32778eb541a99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a252c349b237f7779edf32778eb541a99">~Model</a> ()</td></tr>
|
|
<tr class="separator:a252c349b237f7779edf32778eb541a99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5efe7312ac548dfc3e91cff8c84b256"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#ad5efe7312ac548dfc3e91cff8c84b256">Model</a> (std::string <a class="el" href="linear__solver_8cc.html#a82e2a7e0f28d620da677073b6b24574b">name</a>)</td></tr>
|
|
<tr class="memdesc:ad5efe7312ac548dfc3e91cff8c84b256"><td class="mdescLeft"> </td><td class="mdescRight">When there is more than one model in an application, it makes sense to name them for debugging or logging. <a href="classoperations__research_1_1sat_1_1Model.html#ad5efe7312ac548dfc3e91cff8c84b256">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5efe7312ac548dfc3e91cff8c84b256"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b8d774b566431b8932ba0f3c921ec7d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a7b8d774b566431b8932ba0f3c921ec7d"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a7b8d774b566431b8932ba0f3c921ec7d">Add</a> (std::function< T(<a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> *)> f)</td></tr>
|
|
<tr class="memdesc:a7b8d774b566431b8932ba0f3c921ec7d"><td class="mdescLeft"> </td><td class="mdescRight">This makes it possible to have a nicer API on the client side, and it allows both of these forms: <a href="classoperations__research_1_1sat_1_1Model.html#a7b8d774b566431b8932ba0f3c921ec7d">More...</a><br /></td></tr>
|
|
<tr class="separator:a7b8d774b566431b8932ba0f3c921ec7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37eb53a23cb596ef5d2e3bbc0fab70dc"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a37eb53a23cb596ef5d2e3bbc0fab70dc"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a37eb53a23cb596ef5d2e3bbc0fab70dc">Get</a> (std::function< T(const <a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> &)> f) const</td></tr>
|
|
<tr class="memdesc:a37eb53a23cb596ef5d2e3bbc0fab70dc"><td class="mdescLeft"> </td><td class="mdescRight">Similar to <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a7b8d774b566431b8932ba0f3c921ec7d" title="This makes it possible to have a nicer API on the client side, and it allows both of these forms:">Add()</a> but this is const. <a href="classoperations__research_1_1sat_1_1Model.html#a37eb53a23cb596ef5d2e3bbc0fab70dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a37eb53a23cb596ef5d2e3bbc0fab70dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d72645353ea6770911c4e0724995ed6"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a8d72645353ea6770911c4e0724995ed6"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a8d72645353ea6770911c4e0724995ed6">GetOrCreate</a> ()</td></tr>
|
|
<tr class="memdesc:a8d72645353ea6770911c4e0724995ed6"><td class="mdescLeft"> </td><td class="mdescRight">Returns an object of type T that is unique to this model (like a "local" singleton). <a href="classoperations__research_1_1sat_1_1Model.html#a8d72645353ea6770911c4e0724995ed6">More...</a><br /></td></tr>
|
|
<tr class="separator:a8d72645353ea6770911c4e0724995ed6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66b60c092ecee6c1aa8c6a8823ab19d8"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a66b60c092ecee6c1aa8c6a8823ab19d8"><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a66b60c092ecee6c1aa8c6a8823ab19d8">Get</a> () const</td></tr>
|
|
<tr class="memdesc:a66b60c092ecee6c1aa8c6a8823ab19d8"><td class="mdescLeft"> </td><td class="mdescRight">Likes <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a8d72645353ea6770911c4e0724995ed6" title="Returns an object of type T that is unique to this model (like a "local" singleton).">GetOrCreate()</a> but do not create the object if it is non-existing. <a href="classoperations__research_1_1sat_1_1Model.html#a66b60c092ecee6c1aa8c6a8823ab19d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a66b60c092ecee6c1aa8c6a8823ab19d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac779eb15f8e4162692d13c584426d693"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ac779eb15f8e4162692d13c584426d693"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#ac779eb15f8e4162692d13c584426d693">Mutable</a> () const</td></tr>
|
|
<tr class="memdesc:ac779eb15f8e4162692d13c584426d693"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a37eb53a23cb596ef5d2e3bbc0fab70dc" title="Similar to Add() but this is const.">Get()</a>, but returns a mutable version of the object. <a href="classoperations__research_1_1sat_1_1Model.html#ac779eb15f8e4162692d13c584426d693">More...</a><br /></td></tr>
|
|
<tr class="separator:ac779eb15f8e4162692d13c584426d693"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee6e749f21ce871e8a4f306ba25f2c83"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:aee6e749f21ce871e8a4f306ba25f2c83"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#aee6e749f21ce871e8a4f306ba25f2c83">TakeOwnership</a> (T *t)</td></tr>
|
|
<tr class="memdesc:aee6e749f21ce871e8a4f306ba25f2c83"><td class="mdescLeft"> </td><td class="mdescRight">Gives ownership of a pointer to this model. <a href="classoperations__research_1_1sat_1_1Model.html#aee6e749f21ce871e8a4f306ba25f2c83">More...</a><br /></td></tr>
|
|
<tr class="separator:aee6e749f21ce871e8a4f306ba25f2c83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a572e6368e1bf222cda8edfe559ec686b"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a572e6368e1bf222cda8edfe559ec686b"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a572e6368e1bf222cda8edfe559ec686b">Create</a> ()</td></tr>
|
|
<tr class="memdesc:a572e6368e1bf222cda8edfe559ec686b"><td class="mdescLeft"> </td><td class="mdescRight">This returns a non-singleton object owned by the model and created with the T(Model* model) constructor if it exist or the T() constructor otherwise. <a href="classoperations__research_1_1sat_1_1Model.html#a572e6368e1bf222cda8edfe559ec686b">More...</a><br /></td></tr>
|
|
<tr class="separator:a572e6368e1bf222cda8edfe559ec686b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7fac5de5604ea8668bc414536e8aa7ee"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a7fac5de5604ea8668bc414536e8aa7ee"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a7fac5de5604ea8668bc414536e8aa7ee">Register</a> (T *non_owned_class)</td></tr>
|
|
<tr class="memdesc:a7fac5de5604ea8668bc414536e8aa7ee"><td class="mdescLeft"> </td><td class="mdescRight">Register a non-owned class that will be "singleton" in the model. <a href="classoperations__research_1_1sat_1_1Model.html#a7fac5de5604ea8668bc414536e8aa7ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a7fac5de5604ea8668bc414536e8aa7ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a191cd9b1ba3e3c01a558a1f6c02a4429"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1sat_1_1Model.html#a191cd9b1ba3e3c01a558a1f6c02a4429">Name</a> () const</td></tr>
|
|
<tr class="separator:a191cd9b1ba3e3c01a558a1f6c02a4429"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a30c57abda5ed227c85b50007cee876db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30c57abda5ed227c85b50007cee876db">◆ </a></span>Model() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00040">40</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a252c349b237f7779edf32778eb541a99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a252c349b237f7779edf32778eb541a99">◆ </a></span>~Model()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">~<a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00042">42</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5efe7312ac548dfc3e91cff8c84b256"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5efe7312ac548dfc3e91cff8c84b256">◆ </a></span>Model() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>When there is more than one model in an application, it makes sense to name them for debugging or logging. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00054">54</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a7b8d774b566431b8932ba0f3c921ec7d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b8d774b566431b8932ba0f3c921ec7d">◆ </a></span>Add()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T Add </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::function< T(<a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> *)> </td>
|
|
<td class="paramname"><em>f</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This makes it possible to have a nicer API on the client side, and it allows both of these forms: </p>
|
|
<ul>
|
|
<li>ConstraintCreationFunction(contraint_args, &model);</li>
|
|
<li>model.Add(ConstraintCreationFunction(contraint_args));</li>
|
|
</ul>
|
|
<p>The second form is a bit nicer for the client and it also allows to store constraints and add them later. However, the function creating the constraint is slighly more involved.</p>
|
|
<div class="fragment"><div class="line">std::function<void(<a class="code" href="classoperations__research_1_1sat_1_1Model.html#a30c57abda5ed227c85b50007cee876db">Model</a>*)> ConstraintCreationFunction(contraint_args) {</div>
|
|
<div class="line"> <span class="keywordflow">return</span> [=] (<a class="code" href="classoperations__research_1_1sat_1_1Model.html#a30c57abda5ed227c85b50007cee876db">Model</a>* <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>) {</div>
|
|
<div class="line"> ... the same code ...</div>
|
|
<div class="line"> };</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><p>We also have a templated return value for the functions that need it like </p><div class="fragment"><div class="line"><span class="keyword">const</span> BooleanVariable <a class="code" href="constraint__solver_2table_8cc.html#a344010e26426d6a13411648d988bc9b6">b</a> = <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>.Add(<a class="code" href="namespaceoperations__research_1_1sat.html#a38766514ce4824ae1e093a25d7fb43b3">NewBooleanVariable</a>());</div>
|
|
<div class="line"><span class="keyword">const</span> IntegerVariable i = <a class="code" href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a>.Add(<a class="code" href="namespaceoperations__research_1_1sat.html#a847e8bc51b18a71329b9f0dde2d48293">NewWeightedSum</a>(weights, variables));</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00081">81</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a572e6368e1bf222cda8edfe559ec686b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a572e6368e1bf222cda8edfe559ec686b">◆ </a></span>Create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* Create </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This returns a non-singleton object owned by the model and created with the T(Model* model) constructor if it exist or the T() constructor otherwise. </p>
|
|
<p>It is just a shortcut to new + <a class="el" href="classoperations__research_1_1sat_1_1Model.html#aee6e749f21ce871e8a4f306ba25f2c83" title="Gives ownership of a pointer to this model.">TakeOwnership()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00157">157</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a66b60c092ecee6c1aa8c6a8823ab19d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66b60c092ecee6c1aa8c6a8823ab19d8">◆ </a></span>Get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T* Get </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Likes <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a8d72645353ea6770911c4e0724995ed6" title="Returns an object of type T that is unique to this model (like a "local" singleton).">GetOrCreate()</a> but do not create the object if it is non-existing. </p>
|
|
<p>This returns a const version of the object. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00127">127</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37eb53a23cb596ef5d2e3bbc0fab70dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37eb53a23cb596ef5d2e3bbc0fab70dc">◆ </a></span>Get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T Get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::function< T(const <a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a> &)> </td>
|
|
<td class="paramname"><em>f</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Similar to <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a7b8d774b566431b8932ba0f3c921ec7d" title="This makes it possible to have a nicer API on the client side, and it allows both of these forms:">Add()</a> but this is const. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00087">87</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d72645353ea6770911c4e0724995ed6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d72645353ea6770911c4e0724995ed6">◆ </a></span>GetOrCreate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* GetOrCreate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an object of type T that is unique to this model (like a "local" singleton). </p>
|
|
<p>This returns an already created instance or create a new one if needed using the T(Model* model) constructor if it exist or T() otherwise.</p>
|
|
<p>This works a bit like in a dependency injection framework and allows to really easily wire all the classes that make up a solver together. For instance a constraint can depends on the LiteralTrail, or the <a class="el" href="classoperations__research_1_1sat_1_1IntegerTrail.html">IntegerTrail</a> or both, it can depend on a Watcher class to register itself in order to be called when needed and so on.</p>
|
|
<p>IMPORTANT: the Model* constructor functions shouldn't form a cycle between each other, otherwise this will crash the program. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00106">106</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac779eb15f8e4162692d13c584426d693"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac779eb15f8e4162692d13c584426d693">◆ </a></span>Mutable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* Mutable </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Same as <a class="el" href="classoperations__research_1_1sat_1_1Model.html#a37eb53a23cb596ef5d2e3bbc0fab70dc" title="Similar to Add() but this is const.">Get()</a>, but returns a mutable version of the object. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00136">136</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a191cd9b1ba3e3c01a558a1f6c02a4429"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a191cd9b1ba3e3c01a558a1f6c02a4429">◆ </a></span>Name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& Name </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00175">175</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7fac5de5604ea8668bc414536e8aa7ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7fac5de5604ea8668bc414536e8aa7ee">◆ </a></span>Register()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Register </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>non_owned_class</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register a non-owned class that will be "singleton" in the model. </p>
|
|
<p>It is an error to call this on an already registered class. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00169">169</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee6e749f21ce871e8a4f306ba25f2c83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee6e749f21ce871e8a4f306ba25f2c83">◆ </a></span>TakeOwnership()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TakeOwnership </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>t</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gives ownership of a pointer to this model. </p>
|
|
<p>It will be destroyed when the model is. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="sat_2model_8h_source.html#l00147">147</a> of file <a class="el" href="sat_2model_8h_source.html">sat/model.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="sat_2model_8h_source.html">sat/model.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a847e8bc51b18a71329b9f0dde2d48293"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a847e8bc51b18a71329b9f0dde2d48293">operations_research::sat::NewWeightedSum</a></div><div class="ttdeci">std::function< IntegerVariable(Model *)> NewWeightedSum(const VectorInt &coefficients, const std::vector< IntegerVariable > &vars)</div><div class="ttdef"><b>Definition:</b> <a href="integer__expr_8h_source.html#l00597">integer_expr.h:597</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1sat_1_1Model_html_a30c57abda5ed227c85b50007cee876db"><div class="ttname"><a href="classoperations__research_1_1sat_1_1Model.html#a30c57abda5ed227c85b50007cee876db">operations_research::sat::Model::Model</a></div><div class="ttdeci">Model()</div><div class="ttdef"><b>Definition:</b> <a href="sat_2model_8h_source.html#l00040">sat/model.h:40</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1sat_html_a38766514ce4824ae1e093a25d7fb43b3"><div class="ttname"><a href="namespaceoperations__research_1_1sat.html#a38766514ce4824ae1e093a25d7fb43b3">operations_research::sat::NewBooleanVariable</a></div><div class="ttdeci">std::function< BooleanVariable(Model *)> NewBooleanVariable()</div><div class="ttdef"><b>Definition:</b> <a href="integer_8h_source.html#l01315">integer.h:1315</a></div></div>
|
|
<div class="ttc" id="agurobi__interface_8cc_html_a0728f23c9a47655d38e0bf1a2f200bcf"><div class="ttname"><a href="gurobi__interface_8cc.html#a0728f23c9a47655d38e0bf1a2f200bcf">model</a></div><div class="ttdeci">GRBmodel * model</div><div class="ttdef"><b>Definition:</b> <a href="gurobi__interface_8cc_source.html#l00195">gurobi_interface.cc:195</a></div></div>
|
|
<div class="ttc" id="aconstraint__solver_2table_8cc_html_a344010e26426d6a13411648d988bc9b6"><div class="ttname"><a href="constraint__solver_2table_8cc.html#a344010e26426d6a13411648d988bc9b6">b</a></div><div class="ttdeci">int64 b</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_2table_8cc_source.html#l00043">constraint_solver/table.cc:43</a></div></div>
|
|
<!-- 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="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="namespaceoperations__research_1_1sat.html">sat</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1sat_1_1Model.html">Model</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|