634 lines
33 KiB
HTML
634 lines
33 KiB
HTML
<!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.8</span>
|
|
</div>
|
|
</div>
|
|
<div id="content" style="width: 100%; overflow: hidden;">
|
|
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
|
<h2>C++ Reference</h2>
|
|
<ul>
|
|
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
|
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
|
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
|
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
|
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<div align="center">
|
|
<h1 style="color: #145A32;">C++ Reference: Linear solver</h1>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1MPVariable.html">MPVariable</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classoperations__research_1_1MPVariable-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">MPVariable</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The class for variables of a Mathematical Programming (MP) model. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01050">1050</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.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:ad8227ba86a01f26e4f173cd5e219d5d1"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#ad8227ba86a01f26e4f173cd5e219d5d1">name</a> () const</td></tr>
|
|
<tr class="memdesc:ad8227ba86a01f26e4f173cd5e219d5d1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the variable. <a href="classoperations__research_1_1MPVariable.html#ad8227ba86a01f26e4f173cd5e219d5d1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad8227ba86a01f26e4f173cd5e219d5d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94743823a7ad3c565902fcf7956d4ae2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a94743823a7ad3c565902fcf7956d4ae2">SetInteger</a> (bool <a class="el" href="classoperations__research_1_1MPVariable.html#abc6bcaac179c603ad3386fa7449c86a7">integer</a>)</td></tr>
|
|
<tr class="memdesc:a94743823a7ad3c565902fcf7956d4ae2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the integrality requirement of the variable. <a href="classoperations__research_1_1MPVariable.html#a94743823a7ad3c565902fcf7956d4ae2">More...</a><br /></td></tr>
|
|
<tr class="separator:a94743823a7ad3c565902fcf7956d4ae2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc6bcaac179c603ad3386fa7449c86a7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#abc6bcaac179c603ad3386fa7449c86a7">integer</a> () const</td></tr>
|
|
<tr class="memdesc:abc6bcaac179c603ad3386fa7449c86a7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the integrality requirement of the variable. <a href="classoperations__research_1_1MPVariable.html#abc6bcaac179c603ad3386fa7449c86a7">More...</a><br /></td></tr>
|
|
<tr class="separator:abc6bcaac179c603ad3386fa7449c86a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf1a0cc6a3736f3db9880392efe02f0e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#adf1a0cc6a3736f3db9880392efe02f0e">solution_value</a> () const</td></tr>
|
|
<tr class="memdesc:adf1a0cc6a3736f3db9880392efe02f0e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the variable in the current solution. <a href="classoperations__research_1_1MPVariable.html#adf1a0cc6a3736f3db9880392efe02f0e">More...</a><br /></td></tr>
|
|
<tr class="separator:adf1a0cc6a3736f3db9880392efe02f0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acca41811e8aaab0112b987749c0ecb93"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#acca41811e8aaab0112b987749c0ecb93">index</a> () const</td></tr>
|
|
<tr class="memdesc:acca41811e8aaab0112b987749c0ecb93"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the variable in the MPSolver::variables_. <a href="classoperations__research_1_1MPVariable.html#acca41811e8aaab0112b987749c0ecb93">More...</a><br /></td></tr>
|
|
<tr class="separator:acca41811e8aaab0112b987749c0ecb93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accc4f1882f13ad57ef6bbe8fbe5d365d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#accc4f1882f13ad57ef6bbe8fbe5d365d">lb</a> () const</td></tr>
|
|
<tr class="memdesc:accc4f1882f13ad57ef6bbe8fbe5d365d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the lower bound. <a href="classoperations__research_1_1MPVariable.html#accc4f1882f13ad57ef6bbe8fbe5d365d">More...</a><br /></td></tr>
|
|
<tr class="separator:accc4f1882f13ad57ef6bbe8fbe5d365d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a570e7e2c973cc96bedb0db08f5e062e3"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a570e7e2c973cc96bedb0db08f5e062e3">ub</a> () const</td></tr>
|
|
<tr class="memdesc:a570e7e2c973cc96bedb0db08f5e062e3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the upper bound. <a href="classoperations__research_1_1MPVariable.html#a570e7e2c973cc96bedb0db08f5e062e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a570e7e2c973cc96bedb0db08f5e062e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad90797a6c268fa29b515bdb5972c7bfb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#ad90797a6c268fa29b515bdb5972c7bfb">SetLB</a> (double <a class="el" href="classoperations__research_1_1MPVariable.html#accc4f1882f13ad57ef6bbe8fbe5d365d">lb</a>)</td></tr>
|
|
<tr class="memdesc:ad90797a6c268fa29b515bdb5972c7bfb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the lower bound. <a href="classoperations__research_1_1MPVariable.html#ad90797a6c268fa29b515bdb5972c7bfb">More...</a><br /></td></tr>
|
|
<tr class="separator:ad90797a6c268fa29b515bdb5972c7bfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4584733ca3a135bb0e29e7b29988901d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a4584733ca3a135bb0e29e7b29988901d">SetUB</a> (double <a class="el" href="classoperations__research_1_1MPVariable.html#a570e7e2c973cc96bedb0db08f5e062e3">ub</a>)</td></tr>
|
|
<tr class="memdesc:a4584733ca3a135bb0e29e7b29988901d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the upper bound. <a href="classoperations__research_1_1MPVariable.html#a4584733ca3a135bb0e29e7b29988901d">More...</a><br /></td></tr>
|
|
<tr class="separator:a4584733ca3a135bb0e29e7b29988901d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02bfb5cd5deeb2d5149f6976ee0456d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a02bfb5cd5deeb2d5149f6976ee0456d6">SetBounds</a> (double <a class="el" href="classoperations__research_1_1MPVariable.html#accc4f1882f13ad57ef6bbe8fbe5d365d">lb</a>, double <a class="el" href="classoperations__research_1_1MPVariable.html#a570e7e2c973cc96bedb0db08f5e062e3">ub</a>)</td></tr>
|
|
<tr class="memdesc:a02bfb5cd5deeb2d5149f6976ee0456d6"><td class="mdescLeft"> </td><td class="mdescRight">Sets both the lower and upper bounds. <a href="classoperations__research_1_1MPVariable.html#a02bfb5cd5deeb2d5149f6976ee0456d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a02bfb5cd5deeb2d5149f6976ee0456d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a087c614accae43de9e770a7731d09892"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a087c614accae43de9e770a7731d09892">unrounded_solution_value</a> () const</td></tr>
|
|
<tr class="memdesc:a087c614accae43de9e770a7731d09892"><td class="mdescLeft"> </td><td class="mdescRight">Advanced usage: unrounded solution value. <a href="classoperations__research_1_1MPVariable.html#a087c614accae43de9e770a7731d09892">More...</a><br /></td></tr>
|
|
<tr class="separator:a087c614accae43de9e770a7731d09892"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a302239fbb1f938a513636a6c7a3e2d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a7a302239fbb1f938a513636a6c7a3e2d">reduced_cost</a> () const</td></tr>
|
|
<tr class="memdesc:a7a302239fbb1f938a513636a6c7a3e2d"><td class="mdescLeft"> </td><td class="mdescRight">Advanced usage: returns the reduced cost of the variable in the current solution (only available for continuous problems). <a href="classoperations__research_1_1MPVariable.html#a7a302239fbb1f938a513636a6c7a3e2d">More...</a><br /></td></tr>
|
|
<tr class="separator:a7a302239fbb1f938a513636a6c7a3e2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecd5fee61b6013b1207c2ea622c849b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1MPSolver.html#afd922eb2bef96597c426557a8056f76d">MPSolver::BasisStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#aecd5fee61b6013b1207c2ea622c849b5">basis_status</a> () const</td></tr>
|
|
<tr class="memdesc:aecd5fee61b6013b1207c2ea622c849b5"><td class="mdescLeft"> </td><td class="mdescRight">Advanced usage: returns the basis status of the variable in the current solution (only available for continuous problems). <a href="classoperations__research_1_1MPVariable.html#aecd5fee61b6013b1207c2ea622c849b5">More...</a><br /></td></tr>
|
|
<tr class="separator:aecd5fee61b6013b1207c2ea622c849b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bf24627eb5f1b609cd2704bddc3750d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a2bf24627eb5f1b609cd2704bddc3750d">branching_priority</a> () const</td></tr>
|
|
<tr class="memdesc:a2bf24627eb5f1b609cd2704bddc3750d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the branching priority, or 0 if it was not set. <a href="classoperations__research_1_1MPVariable.html#a2bf24627eb5f1b609cd2704bddc3750d">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bf24627eb5f1b609cd2704bddc3750d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c4f59b6127589d61780ecaa2acdab76"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a3c4f59b6127589d61780ecaa2acdab76">SetBranchingPriority</a> (int priority)</td></tr>
|
|
<tr class="memdesc:a3c4f59b6127589d61780ecaa2acdab76"><td class="mdescLeft"> </td><td class="mdescRight">Advanced usage: Certain MIP solvers (e.g. <a href="classoperations__research_1_1MPVariable.html#a3c4f59b6127589d61780ecaa2acdab76">More...</a><br /></td></tr>
|
|
<tr class="separator:a3c4f59b6127589d61780ecaa2acdab76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9d8831eb4c3951cb8f39aa9deb7568bd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a9d8831eb4c3951cb8f39aa9deb7568bd">MPVariable</a> (int <a class="el" href="classoperations__research_1_1MPVariable.html#acca41811e8aaab0112b987749c0ecb93">index</a>, double <a class="el" href="classoperations__research_1_1MPVariable.html#accc4f1882f13ad57ef6bbe8fbe5d365d">lb</a>, double <a class="el" href="classoperations__research_1_1MPVariable.html#a570e7e2c973cc96bedb0db08f5e062e3">ub</a>, bool <a class="el" href="classoperations__research_1_1MPVariable.html#abc6bcaac179c603ad3386fa7449c86a7">integer</a>, const std::string &<a class="el" href="classoperations__research_1_1MPVariable.html#ad8227ba86a01f26e4f173cd5e219d5d1">name</a>, <a class="el" href="classoperations__research_1_1MPSolverInterface.html">MPSolverInterface</a> *const interface_in)</td></tr>
|
|
<tr class="separator:a9d8831eb4c3951cb8f39aa9deb7568bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3977d5bfced39e6ccd075056317bbb3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#a3977d5bfced39e6ccd075056317bbb3a">set_solution_value</a> (double value)</td></tr>
|
|
<tr class="separator:a3977d5bfced39e6ccd075056317bbb3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab88dd6ee21935e6f7ce99012f9c467a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1MPVariable.html#ab88dd6ee21935e6f7ce99012f9c467a4">set_reduced_cost</a> (double <a class="el" href="classoperations__research_1_1MPVariable.html#a7a302239fbb1f938a513636a6c7a3e2d">reduced_cost</a>)</td></tr>
|
|
<tr class="separator:ab88dd6ee21935e6f7ce99012f9c467a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9d8831eb4c3951cb8f39aa9deb7568bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d8831eb4c3951cb8f39aa9deb7568bd">◆ </a></span>MPVariable()</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_1MPVariable.html">MPVariable</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>lb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>ub</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>integer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classoperations__research_1_1MPSolverInterface.html">MPSolverInterface</a> *const </td>
|
|
<td class="paramname"><em>interface_in</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01144">1144</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aecd5fee61b6013b1207c2ea622c849b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecd5fee61b6013b1207c2ea622c849b5">◆ </a></span>basis_status()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classoperations__research_1_1MPSolver.html#afd922eb2bef96597c426557a8056f76d">MPSolver::BasisStatus</a> basis_status </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Advanced usage: returns the basis status of the variable in the current solution (only available for continuous problems). </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classoperations__research_1_1MPSolver.html#afd922eb2bef96597c426557a8056f76d" title="Advanced usage: possible basis status values for a variable and the slack variable of a linear constr...">MPSolver::BasisStatus</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bf24627eb5f1b609cd2704bddc3750d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bf24627eb5f1b609cd2704bddc3750d">◆ </a></span>branching_priority()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int branching_priority </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>Returns the branching priority, or 0 if it was not set. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01111">1111</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acca41811e8aaab0112b987749c0ecb93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acca41811e8aaab0112b987749c0ecb93">◆ </a></span>index()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int index </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>Returns the index of the variable in the MPSolver::variables_. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01071">1071</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc6bcaac179c603ad3386fa7449c86a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc6bcaac179c603ad3386fa7449c86a7">◆ </a></span>integer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool integer </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>Returns the integrality requirement of the variable. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01059">1059</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="accc4f1882f13ad57ef6bbe8fbe5d365d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#accc4f1882f13ad57ef6bbe8fbe5d365d">◆ </a></span>lb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double lb </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>Returns the lower bound. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01074">1074</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8227ba86a01f26e4f173cd5e219d5d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8227ba86a01f26e4f173cd5e219d5d1">◆ </a></span>name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& name </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>Returns the name of the variable. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01053">1053</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a302239fbb1f938a513636a6c7a3e2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a302239fbb1f938a513636a6c7a3e2d">◆ </a></span>reduced_cost()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double reduced_cost </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Advanced usage: returns the reduced cost of the variable in the current solution (only available for continuous problems). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab88dd6ee21935e6f7ce99012f9c467a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab88dd6ee21935e6f7ce99012f9c467a4">◆ </a></span>set_reduced_cost()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void set_reduced_cost </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>reduced_cost</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01156">1156</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3977d5bfced39e6ccd075056317bbb3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3977d5bfced39e6ccd075056317bbb3a">◆ </a></span>set_solution_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void set_solution_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01155">1155</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02bfb5cd5deeb2d5149f6976ee0456d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02bfb5cd5deeb2d5149f6976ee0456d6">◆ </a></span>SetBounds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetBounds </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>lb</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>ub</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets both the lower and upper bounds. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c4f59b6127589d61780ecaa2acdab76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c4f59b6127589d61780ecaa2acdab76">◆ </a></span>SetBranchingPriority()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetBranchingPriority </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>priority</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Advanced usage: Certain MIP solvers (e.g. </p>
|
|
<p>Gurobi or SCIP) allow you to set a per-variable priority for determining which variable to branch on.</p>
|
|
<p>A value of 0 is treated as default, and is equivalent to not setting the branching priority. The solver looks first to branch on fractional variables in higher priority levels. As of 2019-05, only Gurobi and SCIP support setting branching priority; all other solvers will simply ignore this annotation. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94743823a7ad3c565902fcf7956d4ae2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94743823a7ad3c565902fcf7956d4ae2">◆ </a></span>SetInteger()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetInteger </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>integer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the integrality requirement of the variable. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad90797a6c268fa29b515bdb5972c7bfb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad90797a6c268fa29b515bdb5972c7bfb">◆ </a></span>SetLB()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetLB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>lb</em></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>Sets the lower bound. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01080">1080</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4584733ca3a135bb0e29e7b29988901d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4584733ca3a135bb0e29e7b29988901d">◆ </a></span>SetUB()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SetUB </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>ub</em></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>Sets the upper bound. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01083">1083</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf1a0cc6a3736f3db9880392efe02f0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf1a0cc6a3736f3db9880392efe02f0e">◆ </a></span>solution_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double solution_value </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the value of the variable in the current solution. </p>
|
|
<p>If the variable is integer, then the value will always be an integer (the underlying solver handles floating-point values only, but this function automatically rounds it to the nearest integer; see: man 3 round). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a570e7e2c973cc96bedb0db08f5e062e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a570e7e2c973cc96bedb0db08f5e062e3">◆ </a></span>ub()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double ub </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>Returns the upper bound. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="linear__solver_8h_source.html#l01077">1077</a> of file <a class="el" href="linear__solver_8h_source.html">linear_solver.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a087c614accae43de9e770a7731d09892"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a087c614accae43de9e770a7731d09892">◆ </a></span>unrounded_solution_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double unrounded_solution_value </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Advanced usage: unrounded solution value. </p>
|
|
<p>The returned value won't be rounded to the nearest integer even if the variable is integer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="linear__solver_8h_source.html">linear_solver.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|