Files
ortools-clone/docs/cpp_sat/namespaceoperations__research.html
Corentin Le Molgat 29c909503c Fix doxygen input list
2020-01-31 17:38:10 +01:00

345 lines
20 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">operations_research Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceoperations__research_1_1sat"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html">sat</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1BooleanAssignment.html">BooleanAssignment</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a closed interval [start, end]. <a href="structoperations__research_1_1ClosedInterval.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1Domain.html">Domain</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">We call <em>domain</em> any subset of Int64 = [kint64min, kint64max]. <a href="classoperations__research_1_1Domain.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1LinearBooleanConstraint.html">LinearBooleanConstraint</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1LinearBooleanProblem.html">LinearBooleanProblem</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1LinearObjective.html">LinearObjective</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1NestedTimeLimit.html">NestedTimeLimit</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a way to nest time limits for algorithms where a certain part of the computation is bounded not just by the overall time limit, but also by a stricter time limit specific just for this particular part. <a href="classoperations__research_1_1NestedTimeLimit.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SharedTimeLimit.html">SharedTimeLimit</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SortedDisjointIntervalList.html">SortedDisjointIntervalList</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class represents a sorted list of disjoint, closed intervals. <a href="classoperations__research_1_1SortedDisjointIntervalList.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple class to enforce both an elapsed time limit and a deterministic time limit in the same thread as a program. <a href="classoperations__research_1_1TimeLimit.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5c341d9214d5d46014089435ba0e26d3"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a5c341d9214d5d46014089435ba0e26d3">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &amp;interval)</td></tr>
<tr class="separator:a5c341d9214d5d46014089435ba0e26d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa301d39d2a9271daf8c65e779635335"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aaa301d39d2a9271daf8c65e779635335">operator&lt;&lt;</a> (std::ostream &amp;out, const std::vector&lt; <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &gt; &amp;intervals)</td></tr>
<tr class="separator:aaa301d39d2a9271daf8c65e779635335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8c23924c4b61ed5c531424a6f18bde1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#ab8c23924c4b61ed5c531424a6f18bde1">IntervalsAreSortedAndNonAdjacent</a> (absl::Span&lt; const <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &gt; intervals)</td></tr>
<tr class="memdesc:ab8c23924c4b61ed5c531424a6f18bde1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true iff we have: <a href="namespaceoperations__research.html#ab8c23924c4b61ed5c531424a6f18bde1">More...</a><br /></td></tr>
<tr class="separator:ab8c23924c4b61ed5c531424a6f18bde1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abebf3070a940da6bf678953a66584e76"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#abebf3070a940da6bf678953a66584e76">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;domain)</td></tr>
<tr class="separator:abebf3070a940da6bf678953a66584e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae861bbddc2a8766ec1631f18b6edf961"><td class="memItemLeft" align="right" valign="top">int64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#ae861bbddc2a8766ec1631f18b6edf961">SumOfKMinValueInDomain</a> (const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;domain, int k)</td></tr>
<tr class="separator:ae861bbddc2a8766ec1631f18b6edf961"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2302f6e1343327d0d686023150b4dcf"><td class="memItemLeft" align="right" valign="top">int64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aa2302f6e1343327d0d686023150b4dcf">SumOfKMaxValueInDomain</a> (const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;domain, int k)</td></tr>
<tr class="separator:aa2302f6e1343327d0d686023150b4dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a440252e6a87c7ee2f290f750e4520326"><td class="memItemLeft" align="right" valign="top">BooleanAssignmentDefaultTypeInternal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a440252e6a87c7ee2f290f750e4520326">_BooleanAssignment_default_instance_</a></td></tr>
<tr class="separator:a440252e6a87c7ee2f290f750e4520326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c77c642d778b82561e14d4d88fe982"><td class="memItemLeft" align="right" valign="top">LinearBooleanConstraintDefaultTypeInternal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a44c77c642d778b82561e14d4d88fe982">_LinearBooleanConstraint_default_instance_</a></td></tr>
<tr class="separator:a44c77c642d778b82561e14d4d88fe982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecb63fab84829b29e02f6481963463f5"><td class="memItemLeft" align="right" valign="top">LinearBooleanProblemDefaultTypeInternal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aecb63fab84829b29e02f6481963463f5">_LinearBooleanProblem_default_instance_</a></td></tr>
<tr class="separator:aecb63fab84829b29e02f6481963463f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acff383180e0a501ae04bf4a31adfe5a2"><td class="memItemLeft" align="right" valign="top">LinearObjectiveDefaultTypeInternal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#acff383180e0a501ae04bf4a31adfe5a2">_LinearObjective_default_instance_</a></td></tr>
<tr class="separator:acff383180e0a501ae04bf4a31adfe5a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab8c23924c4b61ed5c531424a6f18bde1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8c23924c4b61ed5c531424a6f18bde1">&#9670;&nbsp;</a></span>IntervalsAreSortedAndNonAdjacent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operations_research::IntervalsAreSortedAndNonAdjacent </td>
<td>(</td>
<td class="paramtype">absl::Span&lt; const <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &gt;&#160;</td>
<td class="paramname"><em>intervals</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true iff we have: </p>
<ul>
<li>The intervals appear in increasing order.</li>
<li>for all i: intervals[i].start &lt;= intervals[i].end</li>
<li>for all i but the last: intervals[i].end + 1 &lt; intervals[i+1].start </li>
</ul>
</div>
</div>
<a id="a5c341d9214d5d46014089435ba0e26d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c341d9214d5d46014089435ba0e26d3">&#9670;&nbsp;</a></span>operator&lt;&lt;() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operations_research::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &amp;&#160;</td>
<td class="paramname"><em>interval</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abebf3070a940da6bf678953a66584e76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abebf3070a940da6bf678953a66584e76">&#9670;&nbsp;</a></span>operator&lt;&lt;() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operations_research::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;&#160;</td>
<td class="paramname"><em>domain</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaa301d39d2a9271daf8c65e779635335"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa301d39d2a9271daf8c65e779635335">&#9670;&nbsp;</a></span>operator&lt;&lt;() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operations_research::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structoperations__research_1_1ClosedInterval.html">ClosedInterval</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>intervals</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa2302f6e1343327d0d686023150b4dcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2302f6e1343327d0d686023150b4dcf">&#9670;&nbsp;</a></span>SumOfKMaxValueInDomain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64 operations_research::SumOfKMaxValueInDomain </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;&#160;</td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>k</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae861bbddc2a8766ec1631f18b6edf961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae861bbddc2a8766ec1631f18b6edf961">&#9670;&nbsp;</a></span>SumOfKMinValueInDomain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64 operations_research::SumOfKMinValueInDomain </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1Domain.html">Domain</a> &amp;&#160;</td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>k</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a440252e6a87c7ee2f290f750e4520326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a440252e6a87c7ee2f290f750e4520326">&#9670;&nbsp;</a></span>_BooleanAssignment_default_instance_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BooleanAssignmentDefaultTypeInternal _BooleanAssignment_default_instance_</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a44c77c642d778b82561e14d4d88fe982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44c77c642d778b82561e14d4d88fe982">&#9670;&nbsp;</a></span>_LinearBooleanConstraint_default_instance_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LinearBooleanConstraintDefaultTypeInternal _LinearBooleanConstraint_default_instance_</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aecb63fab84829b29e02f6481963463f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecb63fab84829b29e02f6481963463f5">&#9670;&nbsp;</a></span>_LinearBooleanProblem_default_instance_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LinearBooleanProblemDefaultTypeInternal _LinearBooleanProblem_default_instance_</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acff383180e0a501ae04bf4a31adfe5a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acff383180e0a501ae04bf4a31adfe5a2">&#9670;&nbsp;</a></span>_LinearObjective_default_instance_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LinearObjectiveDefaultTypeInternal _LinearObjective_default_instance_</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>