Files
ortools-clone/docs/java/ScalProd_8java_source.html

112 lines
30 KiB
HTML
Raw Normal View History

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"/>-->
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
2020-09-01 16:00:33 +02:00
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
2020-01-31 17:05:16 +01:00
</head>
<body>
<div id="banner-container">
<div id="banner">
2021-09-20 15:57:27 +02:00
<span id="sfml">Google OR-Tools 9.1</span>
2020-01-31 17:05:16 +01:00
</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>
2021-09-20 15:57:27 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-09-20 15:57:27 +02:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2020-09-01 16:00:33 +02:00
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
2020-01-31 17:05:16 +01:00
</div>
</div>
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-09-20 15:57:27 +02:00
$(document).ready(function(){initNavTree('ScalProd_8java_source.html','');});
2020-09-01 16:00:33 +02:00
/* @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>
2020-01-31 17:05:16 +01:00
<div class="header">
<div class="headertitle">
<div class="title">ScalProd.java</div> </div>
</div><!--header-->
<div class="contents">
2021-09-20 15:57:27 +02:00
<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-2021 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; <span class="keyword">private</span> <span class="keywordtype">long</span> offset;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#ad38a2e57e12f75971eabe15e083b42ef"> 22</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><di
<div class="ttc" id="classcom_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="classcom_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#l00086">ScalProd.java:86</a></div></div>
<div class="ttc" id="classcom_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#l00099">ScalProd.java:99</a></div></div>
<div class="ttc" id="classcom_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#l00091">ScalProd.java:91</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_a44d2a6541bd74945219f137627bb4be9"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a44d2a6541bd74945219f137627bb4be9">com.google.ortools.sat.ScalProd.ScalProd</a></div><div class="ttdeci">ScalProd(Literal[] literals, long[] coefficients)</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00028">ScalProd.java:28</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_aa276db95d91159511af9a159e935be49"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#aa276db95d91159511af9a159e935be49">com.google.ortools.sat.ScalProd.ScalProd</a></div><div class="ttdeci">ScalProd(IntVar var, long coefficient, long offset)</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00048">ScalProd.java:48</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_aa7d6a5c7e69f4efdc6a44b85bbe22f1a"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#aa7d6a5c7e69f4efdc6a44b85bbe22f1a">com.google.ortools.sat.ScalProd.getOffset</a></div><div class="ttdeci">long getOffset()</div><div class="ttdoc">Returns the constant part of the expression.</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00107">ScalProd.java:107</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html_a9e2c0b0299cf2164e32a7fbc543a7ea6"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a9e2c0b0299cf2164e32a7fbc543a7ea6">com.google.ortools.sat.Literal.not</a></div><div class="ttdeci">Literal not()</div><div class="ttdoc">Returns the Boolean negation of the current literal.</div></div>
<div class="ttc" id="interfacecom_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="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_a2ff48665bf063083523bb71540efa6e2"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a2ff48665bf063083523bb71540efa6e2">com.google.ortools.sat.ScalProd.ScalProd</a></div><div class="ttdeci">ScalProd(Literal[] literals)</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00066">ScalProd.java:66</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="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="interfacecom_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="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd_html_a432f3c9d076249dade933538b700708e"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ScalProd.html#a432f3c9d076249dade933538b700708e">com.google.ortools.sat.ScalProd.ScalProd</a></div><div class="ttdeci">ScalProd(Literal lit, long coefficient, long offset)</div><div class="ttdef"><b>Definition:</b> <a href="ScalProd_8java_source.html#l00054">ScalProd.java:54</a></div></div>
<div class="ttc" id="classcom_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#l00022">ScalProd.java:22</a></div></div>
2021-01-26 11:28:50 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2020-01-31 17:05:16 +01:00
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>