Skip to content

Q
qgroundcontrol
Switch branch/tag
Find file
Normal viewHistoryPermalink
Constraint_8java_source.html 16.2 KB
Newer Older
Valentin Platzgummer's avatar
or-tools src added
b443244f
 
Valentin Platzgummer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 
<!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.3</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.16 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_ed7866a075c77e634cb451a432014e49.html">com</a></li><li class="navelem"><a class="el" href="dir_ed93e231cce03906e5c9f1a0e4259679.html">google</a></li><li class="navelem"><a class="el" href="dir_e79f93676144f0f6b8f1180b80d43c5b.html">ortools</a></li><li class="navelem"><a class="el" href="dir_e5ee533e9c8def55a36155ecb53c6410.html">sat</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Constraint.java</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Constraint_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-2018 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"><a class="line" href="namespacecom_1_1google_1_1ortools_1_1sat.html">   14</a></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_1ConstraintProto.html">ConstraintProto</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_1CpModelProto.html">CpModelProto</a>;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html">   25</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_1Constraint.html">Constraint</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a601e550712da80f5cac45a0324859c1b">   26</a></span>&#160;  <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a601e550712da80f5cac45a0324859c1b">Constraint</a>(CpModelProto.Builder builder) {</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    this.constraintIndex = builder.getConstraintsCount();</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    this.constraintBuilder = builder.addConstraintsBuilder();</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  }</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#ae49c1e99145157c8aa8cce5897e6a6bc">   32</a></span>&#160;  <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#ae49c1e99145157c8aa8cce5897e6a6bc">onlyEnforceIf</a>(<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a> lit) {</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    constraintBuilder.addEnforcementLiteral(lit.<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>());</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  }</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a443931feaa4af1c0249968deaef92a11">   37</a></span>&#160;  <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a443931feaa4af1c0249968deaef92a11">onlyEnforceIf</a>(<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a>[] lits) {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordflow">for</span> (<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a> lit : lits) {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      constraintBuilder.addEnforcementLiteral(lit.getIndex());</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    }</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  }</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a59d053c950ff1e9f8a004d493f34e754">   44</a></span>&#160;  <span class="keyword">public</span> <span class="keywordtype">int</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>() {</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordflow">return</span> constraintIndex;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  }</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a745f45cacfc19026a06b544c914a773d">   49</a></span>&#160;  <span class="keyword">public</span> ConstraintProto.Builder <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a745f45cacfc19026a06b544c914a773d">getBuilder</a>() {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordflow">return</span> constraintBuilder;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  }</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keyword">private</span> <span class="keyword">final</span> <span class="keywordtype">int</span> constraintIndex;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <span class="keyword">private</span> <span class="keyword">final</span> ConstraintProto.Builder constraintBuilder;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_a601e550712da80f5cac45a0324859c1b"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a601e550712da80f5cac45a0324859c1b">com.google.ortools.sat.Constraint.Constraint</a></div><div class="ttdeci">Constraint(CpModelProto.Builder builder)</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8java_source.html#l00026">Constraint.java:26</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="Constraint_8java_source.html#l00025">Constraint.java:25</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_a59d053c950ff1e9f8a004d493f34e754"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a59d053c950ff1e9f8a004d493f34e754">com.google.ortools.sat.Constraint.getIndex</a></div><div class="ttdeci">int getIndex()</div><div class="ttdoc">Returns the index of the constraint in the model.</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8java_source.html#l00044">Constraint.java:44</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="Constraint_8java_source.html#l00049">Constraint.java:49</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_ae49c1e99145157c8aa8cce5897e6a6bc"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#ae49c1e99145157c8aa8cce5897e6a6bc">com.google.ortools.sat.Constraint.onlyEnforceIf</a></div><div class="ttdeci">void onlyEnforceIf(Literal lit)</div><div class="ttdoc">Adds a literal to the constraint.</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8java_source.html#l00032">Constraint.java:32</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ConstraintProto.html">ConstraintProto</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_a443931feaa4af1c0249968deaef92a11"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#a443931feaa4af1c0249968deaef92a11">com.google.ortools.sat.Constraint.onlyEnforceIf</a></div><div class="ttdeci">void onlyEnforceIf(Literal[] lits)</div><div class="ttdoc">Adds a list of literals to the constraint.</div><div class="ttdef"><b>Definition:</b> <a href="Constraint_8java_source.html#l00037">Constraint.java:37</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="anamespacecom_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="Constraint_8java_source.html#l00014">Constraint.java:14</a></div></div>
<div class="ttc" id="anamespacecom_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="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 class="ttc" id="anamespacecom_1_1google_html"><div class="ttname"><a href="namespacecom_1_1google.html">com.google</a></div></div>
<div class="ttc" id="anamespacecom_html"><div class="ttname"><a href="namespacecom.html">com</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">CpModelProto</a></div></div>
        </div>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>