always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
130406df949ec2547bb42a970696bc9631dadb68
ortools-clone/docs/java/CircuitConstraint_8java_source.html

139 lines
15 KiB
HTML
Raw Normal View History

regenerate doxygen doc
2022-01-15 22:53:18 +01:00
<!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.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('CircuitConstraint_8java_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">CircuitConstraint.java</div></div>
</div><!--header-->
<div class="contents">
<a href="CircuitConstraint_8java.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 &quot;License&quot;);</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 &quot;AS IS&quot; 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="keyword">package </span>com.google.ortools.sat;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">import</span> com.google.ortools.sat.CircuitConstraintProto;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">import</span> com.google.ortools.sat.CpModelProto;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html"> 24</a></span><span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html">CircuitConstraint</a> <span class="keyword">extends</span> <a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html">Constraint</a> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#a414b317021cbd30bff4061be50da7c9a"> 25</a></span> <span class="keyword">public</span> <a class="code hl_function" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#a414b317021cbd30bff4061be50da7c9a">CircuitConstraint</a>(<a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html">CpModelProto</a>.<a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder.html">Builder</a> builder) {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> super(builder);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> }</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#aea3bfbd77c2bab12efb56854c2e9395d"> 36</a></span> <span class="keyword">public</span> <a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html">CircuitConstraint</a> <a class="code hl_function" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#aea3bfbd77c2bab12efb56854c2e9395d">addArc</a>(<span class="keywordtype">int</span> tail, <span class="keywordtype">int</span> head, <a class="code hl_interface" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a> literal) {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto.html">CircuitConstraintProto</a>.<a class="code hl_class" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder.html">Builder</a> circuit = <a class="code hl_function" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a745f45cacfc19026a06b544c914a773d">getBuilder</a>().getCircuitBuilder();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> circuit.addTails(tail);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> circuit.addHeads(head);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> circuit.addLiterals(literal.<a class="code hl_function" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>());</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">return</span> <span class="keyword">this</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>}</div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder.html">com.google.ortools.sat.CircuitConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00494">CircuitConstraintProto.java:497</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto.html">com.google.ortools.sat.CircuitConstraintProto</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00020">CircuitConstraintProto.java:23</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html">com.google.ortools.sat.CircuitConstraint</a></div><div class="ttdoc">Specialized circuit constraint.</div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraint_8java_source.html#l00024">CircuitConstraint.java:24</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint_html_a414b317021cbd30bff4061be50da7c9a"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#a414b317021cbd30bff4061be50da7c9a">com.google.ortools.sat.CircuitConstraint.CircuitConstraint</a></div><div class="ttdeci">CircuitConstraint(CpModelProto.Builder builder)</div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraint_8java_source.html#l00025">CircuitConstraint.java:25</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint_html_aea3bfbd77c2bab12efb56854c2e9395d"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html#aea3bfbd77c2bab12efb56854c2e9395d">com.google.ortools.sat.CircuitConstraint.addArc</a></div><div class="ttdeci">CircuitConstraint addArc(int tail, int head, Literal literal)</div><div class="ttdoc">Add an arc to the graph of the circuit constraint.</div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraint_8java_source.html#l00036">CircuitConstraint.java:36</a></div></div>
<div class="ttc" id="aclasscom_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="aclasscom_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="aclasscom_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:1032</a></div></div>
<div class="ttc" id="aclasscom_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:16</a></div></div>
<div class="ttc" id="ainterfacecom_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="ainterfacecom_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><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink