Files
ortools-clone/docs/java/SumOfVariables_8java_source.html
Laurent Perron b95e6bb4d6 build java doc
2019-06-13 02:45:44 +02:00

72 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: SumOfVariables.java Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<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="ortools.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<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="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</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">SumOfVariables.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="SumOfVariables_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="l00017"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html"> 17</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_1SumOfVariables.html">SumOfVariables</a> <span class="keyword">implements</span> <a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html">LinearExpr</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">private</span> <span class="keyword">final</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] variables;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#aea8757d63c4bf223f25c8952aa5a0920"> 20</a></span>&#160; <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#aea8757d63c4bf223f25c8952aa5a0920">SumOfVariables</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] variables) {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; this.variables = variables;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; }</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; @Override</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#a6de0ea6a3ff3c2a009ccb757690999f8"> 25</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_1SumOfVariables.html#a6de0ea6a3ff3c2a009ccb757690999f8">numElements</a>() {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> variables.length;</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="l00029"></a><span class="lineno"> 29</span>&#160; @Override</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#acab42fcf57beddcd5f5502dc846dff18"> 30</a></span>&#160; <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#acab42fcf57beddcd5f5502dc846dff18">getVariable</a>(<span class="keywordtype">int</span> index) {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; assert (index &gt;= 0);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; assert (index &lt; variables.length);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> variables[index];</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="l00036"></a><span class="lineno"> 36</span>&#160; @Override</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#ac403633082659b7a18b71945b81bea15"> 37</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">long</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#ac403633082659b7a18b71945b81bea15">getCoefficient</a>(<span class="keywordtype">int</span> index) {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div><div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr_html"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html">com.google.ortools.sat.LinearExpr</a></div><div class="ttdoc">A linear expression interface that can be parsed.</div><div class="ttdef"><b>Definition:</b> <a href="LinearExpr_8java_source.html#l00017">LinearExpr.java:17</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables_html_aea8757d63c4bf223f25c8952aa5a0920"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#aea8757d63c4bf223f25c8952aa5a0920">com.google.ortools.sat.SumOfVariables.SumOfVariables</a></div><div class="ttdeci">SumOfVariables(IntVar[] variables)</div><div class="ttdef"><b>Definition:</b> <a href="SumOfVariables_8java_source.html#l00020">SumOfVariables.java:20</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables_html_a6de0ea6a3ff3c2a009ccb757690999f8"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#a6de0ea6a3ff3c2a009ccb757690999f8">com.google.ortools.sat.SumOfVariables.numElements</a></div><div class="ttdeci">int numElements()</div><div class="ttdoc">Returns the number of elements in the interface.</div><div class="ttdef"><b>Definition:</b> <a href="SumOfVariables_8java_source.html#l00025">SumOfVariables.java:25</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">com.google.ortools.sat.IntVar</a></div><div class="ttdoc">An integer variable.</div><div class="ttdef"><b>Definition:</b> <a href="com_2google_2ortools_2sat_2IntVar_8java_source.html#l00021">com/google/ortools/sat/IntVar.java:21</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables_html_acab42fcf57beddcd5f5502dc846dff18"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#acab42fcf57beddcd5f5502dc846dff18">com.google.ortools.sat.SumOfVariables.getVariable</a></div><div class="ttdeci">IntVar getVariable(int index)</div><div class="ttdoc">Returns the ith variable.</div><div class="ttdef"><b>Definition:</b> <a href="SumOfVariables_8java_source.html#l00030">SumOfVariables.java:30</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables_html_ac403633082659b7a18b71945b81bea15"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html#ac403633082659b7a18b71945b81bea15">com.google.ortools.sat.SumOfVariables.getCoefficient</a></div><div class="ttdeci">long getCoefficient(int index)</div><div class="ttdoc">Returns the ith coefficient.</div><div class="ttdef"><b>Definition:</b> <a href="SumOfVariables_8java_source.html#l00037">SumOfVariables.java:37</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SumOfVariables.html">com.google.ortools.sat.SumOfVariables</a></div><div class="ttdoc">A linear expression interface that can be parsed.</div><div class="ttdef"><b>Definition:</b> <a href="SumOfVariables_8java_source.html#l00017">SumOfVariables.java:17</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>