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

112 lines
14 KiB
HTML
Raw Normal View History

Update java doc
2020-01-31 17:05:16 +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"/>-->
<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.5</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>
Update doc
2020-04-23 15:34:43 +02:00
<!-- Generated by Doxygen 1.8.16 -->
Update java doc
2020-01-31 17:05:16 +01:00
<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_fd73d91b70701748781c9404941baa63.html">java</a></li><li class="navelem"><a class="el" href="dir_a564db54e4252fbd4e4cd0fe58816985.html">com</a></li><li class="navelem"><a class="el" href="dir_265fd14d4e9a0ce57ad38de5d64bb540.html">google</a></li><li class="navelem"><a class="el" href="dir_a1e24e541e9f26a83a2ba9a841f0bcf8.html">ortools</a></li><li class="navelem"><a class="el" href="dir_0070805acb68ef04688e7c31a1e72654.html">sat</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ScalProd.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="ScalProd_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_1ScalProd.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_1ScalProd.html">ScalProd</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; <span class="keyword">private</span> <span class="keyword">final</span> <span class="keywordtype">long</span>[] coefficients;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</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_1ScalProd.html#ad38a2e57e12f75971eabe15e083b42ef"> 21</a></span>&#160; <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#ad38a2e57e12f75971eabe15e083b42ef">ScalProd</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] variables, <span class="keywordtype">long</span>[] coefficients) {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; assert (variables.length == coefficients.length);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; this.variables = variables;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; this.coefficients = coefficients;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; }</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; @Override</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a59f9cb76db051cd784a42f38220f896d"> 28</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_1ScalProd.html#a59f9cb76db051cd784a42f38220f896d">numElements</a>() {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">return</span> variables.length;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; @Override</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#aff988e01e71c0dd3c11e6f970a209520"> 33</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_1ScalProd.html#aff988e01e71c0dd3c11e6f970a209520">getVariable</a>(<span class="keywordtype">int</span> index) {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; assert (index &gt;= 0);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; assert (index &lt; variables.length);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> variables[index];</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; @Override</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a2c77626134edecc47b69efe661ea1904"> 40</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_1ScalProd.html#a2c77626134edecc47b69efe661ea1904">getCoefficient</a>(<span class="keywordtype">int</span> index) {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; assert (index &gt;= 0);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; assert (index &lt; coefficients.length);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> coefficients[index];</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_a59f9cb76db051cd784a42f38220f896d"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a59f9cb76db051cd784a42f38220f896d">com.google.ortools.sat.ScalProd.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="ScalProd_8java_source.html#l00028">ScalProd.java:28</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html">com.google.ortools.sat.ScalProd</a></div><div class="ttdoc">A linear expression interface that can be parsed.</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00017">ScalProd.java:17</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_a2c77626134edecc47b69efe661ea1904"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a2c77626134edecc47b69efe661ea1904">com.google.ortools.sat.ScalProd.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="ScalProd_8java_source.html#l00040">ScalProd.java:40</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_ad38a2e57e12f75971eabe15e083b42ef"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#ad38a2e57e12f75971eabe15e083b42ef">com.google.ortools.sat.ScalProd.ScalProd</a></div><div class="ttdeci">ScalProd(IntVar[] variables, long[] coefficients)</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00021">ScalProd.java:21</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_aff988e01e71c0dd3c11e6f970a209520"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#aff988e01e71c0dd3c11e6f970a209520">com.google.ortools.sat.ScalProd.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="ScalProd_8java_source.html#l00033">ScalProd.java:33</a></div></div>
<div class="ttc" id="aclasscom_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="java_2com_2google_2ortools_2sat_2IntVar_8java_source.html#l00021">java/com/google/ortools/sat/IntVar.java:21</a></div></div>
<div class="ttc" id="ainterfacecom_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>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink