Files
ortools-clone/docs/cpp/linear__expr_8h_source.html

138 lines
36 KiB
HTML
Raw Normal View History

2020-09-02 09:42:51 +02:00
<!-- HTML header for doxygen 1.8.18-->
<!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"/>
2022-01-16 18:02:36 +01:00
<meta name="generator" content="Doxygen 1.8.15"/>
2020-09-02 09:42:51 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: linear_expr.h 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
2022-01-16 18:02:36 +01:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
2020-09-02 09:42:51 +02:00
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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="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="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
2021-12-14 13:41:01 +01:00
&#160;<span id="projectnumber">9.2</span>
2020-09-02 09:42:51 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2022-01-16 18:02:36 +01:00
<!-- Generated by Doxygen 1.8.15 -->
2020-09-02 09:42:51 +02: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');
2020-09-02 09:42:51 +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">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2020-09-02 09:42:51 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-16 18:02:36 +01:00
/* @license-end */</script>
2020-09-02 09:42:51 +02: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('linear__expr_8h_source.html','');});
2020-09-02 09:42:51 +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>
<div class="header">
2022-01-16 18:02:36 +01:00
<div class="headertitle">
<div class="title">linear_expr.h</div> </div>
2020-09-02 09:42:51 +02:00
</div><!--header-->
<div class="contents">
2022-01-16 18:02:36 +01:00
<a href="linear__expr_8h.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="preprocessor">#ifndef OR_TOOLS_LINEAR_SOLVER_LINEAR_EXPR_H_</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define OR_TOOLS_LINEAR_SOLVER_LINEAR_EXPR_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#include &lt;ostream&gt;</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#include &quot;absl/container/flat_hash_map.h&quot;</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment">// NOTE(user): forward declaration is necessary due to cyclic dependencies,</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">// MPVariable is defined in linear_solver.h, which depends on LinearExpr.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keyword">class </span>MPVariable;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00114"></a><span class="line
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a96ffc785b7b2135c7980c985883ffdd3"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a96ffc785b7b2135c7980c985883ffdd3">operations_research::LinearExpr::offset</a></div><div class="ttdeci">double offset() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00142">linear_expr.h:142</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html_a9748ce3280b2d4c16a2cd38a480b9c7c"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html#a9748ce3280b2d4c16a2cd38a480b9c7c">operations_research::LinearRange::lower_bound</a></div><div class="ttdeci">double lower_bound() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00205">linear_expr.h:205</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a8bf5a8a9a39766ad2665df3918fa16f5"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a8bf5a8a9a39766ad2665df3918fa16f5">operations_research::LinearExpr::operator+=</a></div><div class="ttdeci">LinearExpr &amp; operator+=(const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00032">linear_expr.cc:32</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a118de93231a6290e4f98ce5d981fd903"><div class="ttname"><a href="namespaceoperations__research.html#a118de93231a6290e4f98ce5d981fd903">operations_research::operator+</a></div><div class="ttdeci">LinearExpr operator+(LinearExpr lhs, const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00146">linear_expr.cc:146</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_ae161405d349af5d521fa0fd25c3b6f83"><div class="ttname"><a href="namespaceoperations__research.html#ae161405d349af5d521fa0fd25c3b6f83">operations_research::operator==</a></div><div class="ttdeci">LinearRange operator==(const LinearExpr &amp;lhs, const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00180">linear_expr.cc:180</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a1953d5ae154875095008836cd15ab348"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a1953d5ae154875095008836cd15ab348">operations_research::LinearExpr::SolutionValue</a></div><div class="ttdeci">double SolutionValue() const</div><div class="ttdoc">Evaluates the value of this expression at the solution found.</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00075">linear_expr.cc:75</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html_a32ea297f2577df1857c480c965f0b6b7"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html#a32ea297f2577df1857c480c965f0b6b7">operations_research::LinearRange::LinearRange</a></div><div class="ttdeci">LinearRange()</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00194">linear_expr.h:194</a></div></div>
<div class="ttc" id="classoperations__research_1_1_m_p_variable_html"><div class="ttname"><a href="classoperations__research_1_1_m_p_variable.html">operations_research::MPVariable</a></div><div class="ttdoc">The class for variables of a Mathematical Programming (MP) model.</div><div class="ttdef"><b>Definition:</b> <a href="linear__solver_8h_source.html#l01087">linear_solver.h:1087</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a665001590f89bb9446d0030e2ef8047b"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a665001590f89bb9446d0030e2ef8047b">operations_research::LinearExpr::terms</a></div><div class="ttdeci">const absl::flat_hash_map&lt; const MPVariable *, double &gt; &amp; terms() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00143">linear_expr.h:143</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a5a7f9281983064baa0e2a613de059b67"><div class="ttname"><a href="namespaceoperations__research.html#a5a7f9281983064baa0e2a613de059b67">operations_research::operator *</a></div><div class="ttdeci">LinearExpr operator *(LinearExpr lhs, double rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00154">linear_expr.cc:154</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a19c380b03cea21d7ac7325136a131ff0"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a19c380b03cea21d7ac7325136a131ff0">operations_research::LinearExpr::ToString</a></div><div class="ttdeci">std::string ToString() const</div><div class="ttdoc">A human readable representation of this.</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00119">linear_expr.cc:119</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_aee1f697f95296b131247ba326776671d"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#aee1f697f95296b131247ba326776671d">operations_research::LinearExpr::operator *=</a></div><div class="ttdeci">LinearExpr &amp; operator *=(double rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00048">linear_expr.cc:48</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a708e7b52aae1fa3c440ef7ced3f06cd9"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a708e7b52aae1fa3c440ef7ced3f06cd9">operations_research::LinearExpr::LinearExpr</a></div><div class="ttdeci">LinearExpr()</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00026">linear_expr.cc:26</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_ab7cf6c0298d3fa64034fe8d1eff683f6"><div class="ttname"><a href="namespaceoperations__research.html#ab7cf6c0298d3fa64034fe8d1eff683f6">operations_research::operator&gt;=</a></div><div class="ttdeci">LinearRange operator&gt;=(const LinearExpr &amp;lhs, const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00183">linear_expr.cc:183</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a81b3f73c470d398ce42791b85964e90f"><div class="ttname"><a href="namespaceoperations__research.html#a81b3f73c470d398ce42791b85964e90f">operations_research::operator/</a></div><div class="ttdeci">LinearExpr operator/(LinearExpr lhs, double rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00158">linear_expr.cc:158</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html_a5158072d27a176fc38524893183d6527"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html#a5158072d27a176fc38524893183d6527">operations_research::LinearRange::upper_bound</a></div><div class="ttdeci">double upper_bound() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00207">linear_expr.h:207</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html">operations_research::LinearExpr</a></div><div class="ttdoc">LinearExpr models a quantity that is linear in the decision variables (MPVariable) of an optimization...</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00114">linear_expr.h:114</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a8e15a84c5f3a2689174372cc15e62848"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a8e15a84c5f3a2689174372cc15e62848">operations_research::LinearExpr::operator-=</a></div><div class="ttdeci">LinearExpr &amp; operator-=(const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00040">linear_expr.cc:40</a></div></div>
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a51e0728b2f50b8aa26f3115138b8ff1b"><div class="ttname"><a href="namespaceoperations__research.html#a51e0728b2f50b8aa26f3115138b8ff1b">operations_research::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, const Assignment &amp;assignment)</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_2assignment_8cc_source.html#l01094">constraint_solver/assignment.cc:1094</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html_ac94f6b1a6cc64b35da3b2a250e0c606d"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html#ac94f6b1a6cc64b35da3b2a250e0c606d">operations_research::LinearRange::linear_expr</a></div><div class="ttdeci">const LinearExpr &amp; linear_expr() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00206">linear_expr.h:206</a></div></div>
<div class="ttc" id="expr__array_8cc_html_a472a99923cbe11ae7b5a5d157d9ad465"><div class="ttname"><a href="expr__array_8cc.html#a472a99923cbe11ae7b5a5d157d9ad465">var</a></div><div class="ttdeci">IntVar * var</div><div class="ttdef"><b>Definition:</b> <a href="expr__array_8cc_source.html#l01874">expr_array.cc:1874</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a9a57971e3ced4a836ed66de9dc3b657d"><div class="ttname"><a href="namespaceoperations__research.html#a9a57971e3ced4a836ed66de9dc3b657d">operations_research::operator-</a></div><div class="ttdeci">LinearExpr operator-(LinearExpr lhs, const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00150">linear_expr.cc:150</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_range_html"><div class="ttname"><a href="classoperations__research_1_1_linear_range.html">operations_research::LinearRange</a></div><div class="ttdoc">An expression of the form:</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8h_source.html#l00192">linear_expr.h:192</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_af7090523fa7dfe3329099051940decfc"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#af7090523fa7dfe3329099051940decfc">operations_research::LinearExpr::NotVar</a></div><div class="ttdeci">static LinearExpr NotVar(LinearExpr var)</div><div class="ttdoc">Returns 1-var.</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00069">linear_expr.cc:69</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_ad0e6185e1b4809a4edd6cc31ac00d7e2"><div class="ttname"><a href="namespaceoperations__research.html#ad0e6185e1b4809a4edd6cc31ac00d7e2">operations_research::operator&lt;=</a></div><div class="ttdeci">LinearRange operator&lt;=(const LinearExpr &amp;lhs, const LinearExpr &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00177">linear_expr.cc:177</a></div></div>
<div class="ttc" id="classoperations__research_1_1_linear_expr_html_a32985ab0882c48b374e1d26e0fdf9ce6"><div class="ttname"><a href="classoperations__research_1_1_linear_expr.html#a32985ab0882c48b374e1d26e0fdf9ce6">operations_research::LinearExpr::operator-</a></div><div class="ttdeci">LinearExpr operator-() const</div><div class="ttdef"><b>Definition:</b> <a href="linear__expr_8cc_source.html#l00066">linear_expr.cc:66</a></div></div>
2021-01-26 11:28:50 +01:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2020-09-02 09:42:51 +02:00
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_4d3a5a688e4550f3d7725aaa5ab9c27b.html">linear_solver</a></li><li class="navelem"><a class="el" href="linear__expr_8h.html">linear_expr.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2022-01-16 18:02:36 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2020-09-02 09:42:51 +02:00
</ul>
</div>
</body>
</html>