Files
ortools-clone/docs/java/MultipleCircuitConstraint_8java_source.html
Laurent Perron a2ad6677e1 regenerate doc
2022-01-16 18:02:36 +01:00

112 lines
16 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.2</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>Java Reference</h2>
<ul>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1sat.html">CP-SAT</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1graph.html">Graph</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1algorithms.html">Knapsack solver</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1linearsolver.html">Linear solver</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1constraintsolver.html">Routing</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1util.html">Util</a></li>
</ul>
</div>
<div id="content">
<div align="center">
<h1 style="color: #145A32;">Java Reference</h1>
</div>
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&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">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('MultipleCircuitConstraint_8java_source.html','');});
/* @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">MultipleCircuitConstraint.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="MultipleCircuitConstraint_8java.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="keyword">package </span>com.google.ortools.sat;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html">CpModelProto</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto.html">RoutesConstraintProto</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html"> 24</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html">MultipleCircuitConstraint</a> <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html">Constraint</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a3a252b15087b9bd302dd697e6bc1acf9"> 25</a></span>&#160; <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a3a252b15087b9bd302dd697e6bc1acf9">MultipleCircuitConstraint</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html">CpModelProto</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder.html">Builder</a> builder) {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; super(builder);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a809c8bf39b3d5d66e0dba3743e1ea9e9"> 36</a></span>&#160; <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html">MultipleCircuitConstraint</a> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a809c8bf39b3d5d66e0dba3743e1ea9e9">addArc</a>(<span class="keywordtype">int</span> tail, <span class="keywordtype">int</span> head, <a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a> literal) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto.html">RoutesConstraintProto</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto_1_1Builder.html">Builder</a> circuit = <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a745f45cacfc19026a06b544c914a773d">getBuilder</a>().getRoutesBuilder();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; circuit.addTails(tail);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; circuit.addHeads(head);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; circuit.addLiterals(literal.<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>());</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> <span class="keyword">this</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div><div class="ttc" id="namespacecom_1_1google_1_1ortools_1_1sat_html"><div class="ttname"><a href="namespacecom_1_1google_1_1ortools_1_1sat.html">com.google.ortools.sat</a></div><div class="ttdef"><b>Definition:</b> <a href="AllDifferentConstraintProto_8java_source.html#l00004">AllDifferentConstraintProto.java:4</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto.html">com.google.ortools.sat.RoutesConstraintProto</a></div><div class="ttdef"><b>Definition:</b> <a href="RoutesConstraintProto_8java_source.html#l00029">RoutesConstraintProto.java:29</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint_html_a3a252b15087b9bd302dd697e6bc1acf9"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a3a252b15087b9bd302dd697e6bc1acf9">com.google.ortools.sat.MultipleCircuitConstraint.MultipleCircuitConstraint</a></div><div class="ttdeci">MultipleCircuitConstraint(CpModelProto.Builder builder)</div><div class="ttdef"><b>Definition:</b> <a href="MultipleCircuitConstraint_8java_source.html#l00025">MultipleCircuitConstraint.java:25</a></div></div>
<div class="ttc" id="namespacecom_html"><div class="ttname"><a href="namespacecom.html">com</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html">com.google.ortools.sat.Constraint</a></div><div class="ttdoc">Wrapper around a ConstraintProto.</div><div class="ttdef"><b>Definition:</b> <a href="java_2com_2google_2ortools_2sat_2Constraint_8java_source.html#l00025">java/com/google/ortools/sat/Constraint.java:25</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1RoutesConstraintProto_1_1Builder.html">com.google.ortools.sat.RoutesConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="RoutesConstraintProto_8java_source.html#l00653">RoutesConstraintProto.java:653</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html_a59d053c950ff1e9f8a004d493f34e754"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">com.google.ortools.sat.Literal.getIndex</a></div><div class="ttdeci">int getIndex()</div></div>
<div class="ttc" id="namespacecom_1_1google_1_1ortools_html"><div class="ttname"><a href="namespacecom_1_1google_1_1ortools.html">com.google.ortools</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html">com.google.ortools.sat.CpModelProto</a></div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00013">CpModelProto.java:13</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint_html_a809c8bf39b3d5d66e0dba3743e1ea9e9"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html#a809c8bf39b3d5d66e0dba3743e1ea9e9">com.google.ortools.sat.MultipleCircuitConstraint.addArc</a></div><div class="ttdeci">MultipleCircuitConstraint addArc(int tail, int head, Literal literal)</div><div class="ttdoc">Add an arc to the graph of the multiple circuit constraint.</div><div class="ttdef"><b>Definition:</b> <a href="MultipleCircuitConstraint_8java_source.html#l00036">MultipleCircuitConstraint.java:36</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html">com.google.ortools.sat.MultipleCircuitConstraint</a></div><div class="ttdoc">Specialized multiple circuit constraint.</div><div class="ttdef"><b>Definition:</b> <a href="MultipleCircuitConstraint_8java_source.html#l00024">MultipleCircuitConstraint.java:24</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">com.google.ortools.sat.Literal</a></div><div class="ttdoc">Interface to describe a boolean variable or its negation.</div><div class="ttdef"><b>Definition:</b> <a href="Literal_8java_source.html#l00017">Literal.java:17</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_a745f45cacfc19026a06b544c914a773d"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a745f45cacfc19026a06b544c914a773d">com.google.ortools.sat.Constraint.getBuilder</a></div><div class="ttdeci">ConstraintProto.Builder getBuilder()</div><div class="ttdoc">Returns the constraint builder.</div><div class="ttdef"><b>Definition:</b> <a href="java_2com_2google_2ortools_2sat_2Constraint_8java_source.html#l00049">java/com/google/ortools/sat/Constraint.java:49</a></div></div>
<div class="ttc" id="namespacecom_1_1google_html"><div class="ttname"><a href="namespacecom_1_1google.html">com.google</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder.html">com.google.ortools.sat.CpModelProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l01029">CpModelProto.java:1029</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>