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

115 lines
30 KiB
HTML
Raw Normal View History

2022-01-15 22:53:18 +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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 9.2</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>
2022-01-16 18:02:36 +01:00
<!-- Generated by Doxygen 1.8.15 -->
2022-01-15 22:53:18 +01:00
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2022-01-15 22:53:18 +01:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-01-15 22:53:18 +01:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-16 18:02:36 +01:00
/* @license-end */</script>
2022-01-15 22:53:18 +01:00
<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">
</div>
</div>
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('LinearExprBuilder_8java_source.html','');});
2022-01-15 22:53:18 +01: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>
<div class="header">
2022-01-16 18:02:36 +01:00
<div class="headertitle">
<div class="title">LinearExprBuilder.java</div> </div>
2022-01-15 22:53:18 +01:00
</div><!--header-->
<div class="contents">
2022-01-16 18:02:36 +01:00
<a href="LinearExprBuilder_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="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">import</span> java.util.Map;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">import</span> java.util.TreeMap;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</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_1LinearExprBuilder.html"> 20</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_1LinearExprBuilder.html">LinearExprBuilder</a> <span class="keyword">implements</span> <a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument.html">LinearArgument</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">private</span> <span class="keyword">final</span> TreeMap&lt;Integer, Long&gt; coefficients;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">private</span> <span class="keywordtype">long</span> offset;</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; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html">LinearExprBuilder</a>() {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; this.coefficients = <span class="keyword">new</span> TreeMap&lt;&gt;();</div><div class="line"><a name="l0
<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 (sum (ai * xi) + b).</div><div class="ttdef"><b>Definition:</b> <a href="LinearExpr_8java_source.html#l00019">LinearExpr.java:19</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_a2c70f59efda303efeda6f70ab143b207"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#a2c70f59efda303efeda6f70ab143b207">com.google.ortools.sat.LinearExprBuilder.addWeightedSum</a></div><div class="ttdeci">LinearExprBuilder addWeightedSum(LinearArgument[] exprs, int[] coeffs)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00063">LinearExprBuilder.java:63</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1AffineExpression_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1AffineExpression.html">com.google.ortools.sat.AffineExpression</a></div><div class="ttdoc">A specialized linear expression: a * x + b.</div><div class="ttdef"><b>Definition:</b> <a href="AffineExpression_8java_source.html#l00017">AffineExpression.java:17</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_a8b0bfdf007047172f6ea068e994202a5"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#a8b0bfdf007047172f6ea068e994202a5">com.google.ortools.sat.LinearExprBuilder.addWeightedSum</a></div><div class="ttdeci">LinearExprBuilder addWeightedSum(LinearArgument[] exprs, long[] coeffs)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00056">LinearExprBuilder.java:56</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_a3d4b62aa437c974536b45891324e5802"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#a3d4b62aa437c974536b45891324e5802">com.google.ortools.sat.LinearExprBuilder.addSum</a></div><div class="ttdeci">LinearExprBuilder addSum(LinearArgument[] exprs)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00049">LinearExprBuilder.java:49</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr_html_aa7d6a5c7e69f4efdc6a44b85bbe22f1a"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html#aa7d6a5c7e69f4efdc6a44b85bbe22f1a">com.google.ortools.sat.LinearExpr.getOffset</a></div><div class="ttdeci">long getOffset()</div><div class="ttdoc">Returns the constant part of the expression.</div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr_html_ae9592a449a7c3bdebd04b8ea4f174871"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html#ae9592a449a7c3bdebd04b8ea4f174871">com.google.ortools.sat.LinearExpr.getVariableIndex</a></div><div class="ttdeci">int getVariableIndex(int index)</div><div class="ttdoc">Returns the index of the ith variable.</div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1ConstantExpression_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1ConstantExpression.html">com.google.ortools.sat.ConstantExpression</a></div><div class="ttdoc">A specialized constant linear expression.</div><div class="ttdef"><b>Definition:</b> <a href="ConstantExpression_8java_source.html#l00017">ConstantExpression.java:17</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument_html"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument.html">com.google.ortools.sat.LinearArgument</a></div><div class="ttdoc">A object that can build a LinearExpr object.</div><div class="ttdef"><b>Definition:</b> <a href="LinearArgument_8java_source.html#l00021">LinearArgument.java:21</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_af4a6d36519b2db4a0f2a8042c6183662"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#af4a6d36519b2db4a0f2a8042c6183662">com.google.ortools.sat.LinearExprBuilder.add</a></div><div class="ttdeci">LinearExprBuilder add(long constant)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00034">LinearExprBuilder.java:34</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr_html_a59f9cb76db051cd784a42f38220f896d"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html#a59f9cb76db051cd784a42f38220f896d">com.google.ortools.sat.LinearExpr.numElements</a></div><div class="ttdeci">int numElements()</div><div class="ttdoc">Returns the number of terms (excluding the constant one) in this expression.</div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_a458d9c3d5df42b8769911ca874434378"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#a458d9c3d5df42b8769911ca874434378">com.google.ortools.sat.LinearExprBuilder.add</a></div><div class="ttdeci">LinearExprBuilder add(LinearArgument expr)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00029">LinearExprBuilder.java:29</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_a68a038d4ae2f7cf74dfa8e8fe21c4feb"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#a68a038d4ae2f7cf74dfa8e8fe21c4feb">com.google.ortools.sat.LinearExprBuilder.build</a></div><div class="ttdeci">LinearExpr build()</div><div class="ttdoc">Builds a linear expression.</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00071">LinearExprBuilder.java:71</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html">com.google.ortools.sat.LinearExprBuilder</a></div><div class="ttdoc">Builder class for the LinearExpr container.</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00020">LinearExprBuilder.java:20</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument_html_a68a038d4ae2f7cf74dfa8e8fe21c4feb"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument.html#a68a038d4ae2f7cf74dfa8e8fe21c4feb">com.google.ortools.sat.LinearArgument.build</a></div><div class="ttdeci">LinearExpr build()</div><div class="ttdoc">Builds a linear expression.</div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder_html_afe458481a51c77d39c76ba6876235659"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html#afe458481a51c77d39c76ba6876235659">com.google.ortools.sat.LinearExprBuilder.addTerm</a></div><div class="ttdeci">LinearExprBuilder addTerm(LinearArgument expr, long coeff)</div><div class="ttdef"><b>Definition:</b> <a href="LinearExprBuilder_8java_source.html#l00039">LinearExprBuilder.java:39</a></div></div>
<div class="ttc" id="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr_html_a2c77626134edecc47b69efe661ea1904"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html#a2c77626134edecc47b69efe661ea1904">com.google.ortools.sat.LinearExpr.getCoefficient</a></div><div class="ttdeci">long getCoefficient(int index)</div><div class="ttdoc">Returns the ith coefficient.</div></div>
2022-01-15 22:53:18 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>