Files
ortools-clone/docs/cpp/classoperations__research_1_1_linear_range.html
2021-04-27 23:00:03 +02:00

290 lines
17 KiB
HTML

<!-- 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"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: LinearRange</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>
<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
&#160;<span id="projectnumber">9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classoperations__research_1_1_linear_range.html',''); initResizable(); });
/* @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">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1_linear_range-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LinearRange</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An expression of the form: </p>
<div class="fragment"><div class="line"><a class="code" href="classoperations__research_1_1_linear_range.html#a9748ce3280b2d4c16a2cd38a480b9c7c">lower_bound</a> &lt;= sum_{i in S} a_i*x_i &lt;= <a class="code" href="classoperations__research_1_1_linear_range.html#a5158072d27a176fc38524893183d6527">upper_bound</a>. </div>
<div class="ttc" id="aclassoperations__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="aclassoperations__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><!-- fragment --><p> The sum is represented as a <a class="el" href="classoperations__research_1_1_linear_expr.html" title="LinearExpr models a quantity that is linear in the decision variables (MPVariable) of an optimization...">LinearExpr</a> with offset 0.</p>
<p>Must be added to model with </p><div class="fragment"><div class="line">MPSolver::AddRowConstraint(<span class="keyword">const</span> <a class="code" href="classoperations__research_1_1_linear_range.html#a32ea297f2577df1857c480c965f0b6b7">LinearRange</a>&amp; range,</div>
<div class="line"> <span class="keyword">const</span> std::string&amp; <a class="code" href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a>);</div>
<div class="ttc" id="aclassoperations__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="adefault__search_8cc_html_ac673bc430bdc3fdaa09f7becf98ef267"><div class="ttname"><a href="default__search_8cc.html#ac673bc430bdc3fdaa09f7becf98ef267">name</a></div><div class="ttdeci">const std::string name</div><div class="ttdef"><b>Definition:</b> <a href="default__search_8cc_source.html#l00813">default_search.cc:813</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="linear__expr_8h_source.html#l00192">192</a> of file <a class="el" href="linear__expr_8h_source.html">linear_expr.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a32ea297f2577df1857c480c965f0b6b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_linear_range.html#a32ea297f2577df1857c480c965f0b6b7">LinearRange</a> ()</td></tr>
<tr class="separator:a32ea297f2577df1857c480c965f0b6b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac594ef42ae702537dd3fcd7dee8742a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_linear_range.html#ac594ef42ae702537dd3fcd7dee8742a2">LinearRange</a> (double <a class="el" href="classoperations__research_1_1_linear_range.html#a9748ce3280b2d4c16a2cd38a480b9c7c">lower_bound</a>, const <a class="el" href="classoperations__research_1_1_linear_expr.html">LinearExpr</a> &amp;<a class="el" href="classoperations__research_1_1_linear_range.html#ac94f6b1a6cc64b35da3b2a250e0c606d">linear_expr</a>, double <a class="el" href="classoperations__research_1_1_linear_range.html#a5158072d27a176fc38524893183d6527">upper_bound</a>)</td></tr>
<tr class="memdesc:ac594ef42ae702537dd3fcd7dee8742a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bounds of the linear range are updated so that they include the offset from "linear_expr", i.e., we form the range: <a href="classoperations__research_1_1_linear_range.html#ac594ef42ae702537dd3fcd7dee8742a2">More...</a><br /></td></tr>
<tr class="separator:ac594ef42ae702537dd3fcd7dee8742a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9748ce3280b2d4c16a2cd38a480b9c7c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_linear_range.html#a9748ce3280b2d4c16a2cd38a480b9c7c">lower_bound</a> () const</td></tr>
<tr class="separator:a9748ce3280b2d4c16a2cd38a480b9c7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac94f6b1a6cc64b35da3b2a250e0c606d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classoperations__research_1_1_linear_expr.html">LinearExpr</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_linear_range.html#ac94f6b1a6cc64b35da3b2a250e0c606d">linear_expr</a> () const</td></tr>
<tr class="separator:ac94f6b1a6cc64b35da3b2a250e0c606d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5158072d27a176fc38524893183d6527"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_linear_range.html#a5158072d27a176fc38524893183d6527">upper_bound</a> () const</td></tr>
<tr class="separator:a5158072d27a176fc38524893183d6527"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a32ea297f2577df1857c480c965f0b6b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32ea297f2577df1857c480c965f0b6b7">&#9670;&nbsp;</a></span>LinearRange() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1_linear_range.html">LinearRange</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__expr_8h_source.html#l00194">194</a> of file <a class="el" href="linear__expr_8h_source.html">linear_expr.h</a>.</p>
</div>
</div>
<a id="ac594ef42ae702537dd3fcd7dee8742a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac594ef42ae702537dd3fcd7dee8742a2">&#9670;&nbsp;</a></span>LinearRange() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classoperations__research_1_1_linear_range.html">LinearRange</a> </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>lower_bound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classoperations__research_1_1_linear_expr.html">LinearExpr</a> &amp;&#160;</td>
<td class="paramname"><em>linear_expr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>upper_bound</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The bounds of the linear range are updated so that they include the offset from "linear_expr", i.e., we form the range: </p>
<div class="fragment"><div class="line"><a class="code" href="classoperations__research_1_1_linear_range.html#a9748ce3280b2d4c16a2cd38a480b9c7c">lower_bound</a> - offset &lt;= <a class="code" href="classoperations__research_1_1_linear_range.html#ac94f6b1a6cc64b35da3b2a250e0c606d">linear_expr</a> - offset &lt;= <a class="code" href="classoperations__research_1_1_linear_range.html#a5158072d27a176fc38524893183d6527">upper_bound</a> - offset.</div>
<div class="ttc" id="aclassoperations__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><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="linear__expr_8cc_source.html#l00167">167</a> of file <a class="el" href="linear__expr_8cc_source.html">linear_expr.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac94f6b1a6cc64b35da3b2a250e0c606d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac94f6b1a6cc64b35da3b2a250e0c606d">&#9670;&nbsp;</a></span>linear_expr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classoperations__research_1_1_linear_expr.html">LinearExpr</a>&amp; linear_expr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__expr_8h_source.html#l00206">206</a> of file <a class="el" href="linear__expr_8h_source.html">linear_expr.h</a>.</p>
</div>
</div>
<a id="a9748ce3280b2d4c16a2cd38a480b9c7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9748ce3280b2d4c16a2cd38a480b9c7c">&#9670;&nbsp;</a></span>lower_bound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double lower_bound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__expr_8h_source.html#l00205">205</a> of file <a class="el" href="linear__expr_8h_source.html">linear_expr.h</a>.</p>
</div>
</div>
<a id="a5158072d27a176fc38524893183d6527"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5158072d27a176fc38524893183d6527">&#9670;&nbsp;</a></span>upper_bound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double upper_bound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__expr_8h_source.html#l00207">207</a> of file <a class="el" href="linear__expr_8h_source.html">linear_expr.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="linear__expr_8h_source.html">linear_expr.h</a></li>
<li><a class="el" href="linear__expr_8cc_source.html">linear_expr.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- 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="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1_linear_range.html">LinearRange</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>