IntervalVar_8java_source.html 18 KB
Newer Older
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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
<!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">IntervalVar.java</div>  </div>
</div><!--header-->
<div class="contents">
<a href="IntervalVar_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">   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_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;<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_1IntervalConstraintProto.html">IntervalConstraintProto</a>;</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html">   21</a></span>&#160;<span class="keyword">public</span> <span class="keyword">final</span> <span class="keyword">class </span><a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html">IntervalVar</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;  <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html">IntervalVar</a>(</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;      CpModelProto.Builder builder, <span class="keywordtype">int</span> startIndex, <span class="keywordtype">int</span> sizeIndex, <span class="keywordtype">int</span> endIndex, String name) {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    this.modelBuilder = builder;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    this.constraintIndex = modelBuilder.getConstraintsCount();</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    ConstraintProto.Builder ct = modelBuilder.addConstraintsBuilder();</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    ct.setName(name);</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    this.intervalBuilder = ct.getIntervalBuilder();</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    this.intervalBuilder.setStart(startIndex);</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    this.intervalBuilder.setSize(sizeIndex);</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    this.intervalBuilder.setEnd(endIndex);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  }</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html">IntervalVar</a>(CpModelProto.Builder builder, <span class="keywordtype">int</span> startIndex, <span class="keywordtype">int</span> sizeIndex, <span class="keywordtype">int</span> endIndex,</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;      <span class="keywordtype">int</span> isPresentIndex, String name) {</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    this.modelBuilder = builder;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    this.constraintIndex = modelBuilder.getConstraintsCount();</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    ConstraintProto.Builder ct = modelBuilder.addConstraintsBuilder();</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    ct.setName(name);</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    ct.addEnforcementLiteral(isPresentIndex);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    this.intervalBuilder = ct.getIntervalBuilder();</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    this.intervalBuilder.setStart(startIndex);</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    this.intervalBuilder.setSize(sizeIndex);</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    this.intervalBuilder.setEnd(endIndex);</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  }</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;  @Override</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#ad146fa8579a5f8a876c4688cc5a68520">   48</a></span>&#160;  <span class="keyword">public</span> String <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#ad146fa8579a5f8a876c4688cc5a68520">toString</a>() {</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordflow">return</span> modelBuilder.getConstraints(constraintIndex).toString();</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  }</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a59d053c950ff1e9f8a004d493f34e754">   53</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_1IntervalVar.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>() {</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordflow">return</span> constraintIndex;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  }</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a40e0e83064a13e7852e226b42a339e18">   58</a></span>&#160;  <span class="keyword">public</span> IntervalConstraintProto.Builder <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a40e0e83064a13e7852e226b42a339e18">getBuilder</a>() {</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordflow">return</span> intervalBuilder;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  }</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a78ee178b6a73658d65ca60da4d1e6683">   63</a></span>&#160;  <span class="keyword">public</span> String <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a>() {</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">return</span> modelBuilder.getConstraints(constraintIndex).getName();</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  }</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  <span class="keyword">private</span> <span class="keyword">final</span> CpModelProto.Builder modelBuilder;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="keyword">private</span> <span class="keyword">final</span> <span class="keywordtype">int</span> constraintIndex;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keyword">private</span> <span class="keyword">final</span> IntervalConstraintProto.Builder intervalBuilder;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntervalVar_html_ad146fa8579a5f8a876c4688cc5a68520"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#ad146fa8579a5f8a876c4688cc5a68520">com.google.ortools.sat.IntervalVar.toString</a></div><div class="ttdeci">String toString()</div><div class="ttdef"><b>Definition:</b> <a href="IntervalVar_8java_source.html#l00048">IntervalVar.java:48</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_1IntervalVar_html_a40e0e83064a13e7852e226b42a339e18"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a40e0e83064a13e7852e226b42a339e18">com.google.ortools.sat.IntervalVar.getBuilder</a></div><div class="ttdeci">IntervalConstraintProto.Builder getBuilder()</div><div class="ttdoc">Returns the interval builder.</div><div class="ttdef"><b>Definition:</b> <a href="IntervalVar_8java_source.html#l00058">IntervalVar.java:58</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntervalVar_html_a59d053c950ff1e9f8a004d493f34e754"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a59d053c950ff1e9f8a004d493f34e754">com.google.ortools.sat.IntervalVar.getIndex</a></div><div class="ttdeci">int getIndex()</div><div class="ttdoc">Returns the index of the interval constraint in the model.</div><div class="ttdef"><b>Definition:</b> <a href="IntervalVar_8java_source.html#l00053">IntervalVar.java:53</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="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntervalVar_html_a78ee178b6a73658d65ca60da4d1e6683"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html#a78ee178b6a73658d65ca60da4d1e6683">com.google.ortools.sat.IntervalVar.getName</a></div><div class="ttdeci">String getName()</div><div class="ttdoc">Returns the name passed in the constructor.</div><div class="ttdef"><b>Definition:</b> <a href="IntervalVar_8java_source.html#l00063">IntervalVar.java:63</a></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_1IntervalVar_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html">com.google.ortools.sat.IntervalVar</a></div><div class="ttdoc">An interval variable.</div><div class="ttdef"><b>Definition:</b> <a href="IntervalVar_8java_source.html#l00021">IntervalVar.java:21</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 class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntervalConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalConstraintProto.html">IntervalConstraintProto</a></div></div>
        </div>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>