Files
ortools-clone/docs/cpp/classoperations__research_1_1KnapsackGenericSolver.html
2020-09-01 16:01:06 +02:00

445 lines
21 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.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: KnapsackGenericSolver</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">8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<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');
/* @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_1KnapsackGenericSolver.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_1KnapsackGenericSolver-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KnapsackGenericSolver</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8h_source.html#l00608">608</a> of file <a class="el" href="knapsack__solver_8h_source.html">knapsack_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:a2a7bff5cf8a51192eadec54eb0499064"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a2a7bff5cf8a51192eadec54eb0499064">KnapsackGenericSolver</a> (const std::string &amp;solver_name)</td></tr>
<tr class="separator:a2a7bff5cf8a51192eadec54eb0499064"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a25594d97a0a532f9d814bdc6dea380"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a2a25594d97a0a532f9d814bdc6dea380">~KnapsackGenericSolver</a> () override</td></tr>
<tr class="separator:a2a25594d97a0a532f9d814bdc6dea380"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51cac72a6280d047002a1b9bf34d7948"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a51cac72a6280d047002a1b9bf34d7948">Init</a> (const std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &amp;profits, const std::vector&lt; std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &gt; &amp;weights, const std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &amp;capacities) override</td></tr>
<tr class="separator:a51cac72a6280d047002a1b9bf34d7948"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c677592ee5e7312c64475ebae949eab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a5c677592ee5e7312c64475ebae949eab">GetNumberOfItems</a> () const</td></tr>
<tr class="separator:a5c677592ee5e7312c64475ebae949eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35bfa97bc24861491acb8d3d20087306"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a35bfa97bc24861491acb8d3d20087306">GetLowerAndUpperBoundWhenItem</a> (int item_id, bool is_item_in, <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> *lower_bound, <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> *upper_bound) override</td></tr>
<tr class="separator:a35bfa97bc24861491acb8d3d20087306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3df2fc3d96fbcac78a632d7dbf3b8550"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#a3df2fc3d96fbcac78a632d7dbf3b8550">set_master_propagator_id</a> (int master_propagator_id)</td></tr>
<tr class="separator:a3df2fc3d96fbcac78a632d7dbf3b8550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad596c251b64c28e1e5b34e9de44b2dd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#ad596c251b64c28e1e5b34e9de44b2dd7">Solve</a> (<a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *<a class="el" href="cp__model__solver_8cc.html#ac3cf9db02b23ea1455b5ae6955d03e47">time_limit</a>, bool *is_solution_optimal) override</td></tr>
<tr class="separator:ad596c251b64c28e1e5b34e9de44b2dd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfd4cb3faa2f1d6840b8123765fa2fc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1KnapsackGenericSolver.html#abfd4cb3faa2f1d6840b8123765fa2fc4">best_solution</a> (int item_id) const override</td></tr>
<tr class="separator:abfd4cb3faa2f1d6840b8123765fa2fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae194e7bee4a383e5ee6c8ed341b49b7e"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1BaseKnapsackSolver.html#ae194e7bee4a383e5ee6c8ed341b49b7e">GetName</a> () const</td></tr>
<tr class="separator:ae194e7bee4a383e5ee6c8ed341b49b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2a7bff5cf8a51192eadec54eb0499064"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a7bff5cf8a51192eadec54eb0499064">&#9670;&nbsp;</a></span>KnapsackGenericSolver()</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_1KnapsackGenericSolver.html">KnapsackGenericSolver</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>solver_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8cc_source.html#l00336">336</a> of file <a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.cc</a>.</p>
</div>
</div>
<a id="a2a25594d97a0a532f9d814bdc6dea380"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a25594d97a0a532f9d814bdc6dea380">&#9670;&nbsp;</a></span>~KnapsackGenericSolver()</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_1KnapsackGenericSolver.html">KnapsackGenericSolver</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">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8cc_source.html#l00345">345</a> of file <a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abfd4cb3faa2f1d6840b8123765fa2fc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfd4cb3faa2f1d6840b8123765fa2fc4">&#9670;&nbsp;</a></span>best_solution()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool best_solution </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>item_id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classoperations__research_1_1BaseKnapsackSolver.html#af75968e8e76e35de6e7cdfaa0488b131">BaseKnapsackSolver</a>.</p>
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8h_source.html#l00632">632</a> of file <a class="el" href="knapsack__solver_8h_source.html">knapsack_solver.h</a>.</p>
</div>
</div>
<a id="a35bfa97bc24861491acb8d3d20087306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35bfa97bc24861491acb8d3d20087306">&#9670;&nbsp;</a></span>GetLowerAndUpperBoundWhenItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GetLowerAndUpperBoundWhenItem </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>item_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_item_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> *&#160;</td>
<td class="paramname"><em>lower_bound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> *&#160;</td>
<td class="paramname"><em>upper_bound</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classoperations__research_1_1BaseKnapsackSolver.html#a89a48b92823beaaf48f9580ea38c24d1">BaseKnapsackSolver</a>.</p>
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8cc_source.html#l00368">368</a> of file <a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.cc</a>.</p>
</div>
</div>
<a id="ae194e7bee4a383e5ee6c8ed341b49b7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae194e7bee4a383e5ee6c8ed341b49b7e">&#9670;&nbsp;</a></span>GetName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string GetName </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 class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8h_source.html#l00593">593</a> of file <a class="el" href="knapsack__solver_8h_source.html">knapsack_solver.h</a>.</p>
</div>
</div>
<a id="a5c677592ee5e7312c64475ebae949eab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c677592ee5e7312c64475ebae949eab">&#9670;&nbsp;</a></span>GetNumberOfItems()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetNumberOfItems </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="knapsack__solver_8h_source.html#l00617">617</a> of file <a class="el" href="knapsack__solver_8h_source.html">knapsack_solver.h</a>.</p>
</div>
</div>
<a id="a51cac72a6280d047002a1b9bf34d7948"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51cac72a6280d047002a1b9bf34d7948">&#9670;&nbsp;</a></span>Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Init </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>profits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &gt; &amp;&#160;</td>
<td class="paramname"><em>weights</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>capacities</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classoperations__research_1_1BaseKnapsackSolver.html#ac978ac74a7ba1451dd87398ac903234c">BaseKnapsackSolver</a>.</p>
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8cc_source.html#l00347">347</a> of file <a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.cc</a>.</p>
</div>
</div>
<a id="a3df2fc3d96fbcac78a632d7dbf3b8550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3df2fc3d96fbcac78a632d7dbf3b8550">&#9670;&nbsp;</a></span>set_master_propagator_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void set_master_propagator_id </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>master_propagator_id</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 class="definition">Definition at line <a class="el" href="knapsack__solver_8h_source.html#l00625">625</a> of file <a class="el" href="knapsack__solver_8h_source.html">knapsack_solver.h</a>.</p>
</div>
</div>
<a id="ad596c251b64c28e1e5b34e9de44b2dd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad596c251b64c28e1e5b34e9de44b2dd7">&#9670;&nbsp;</a></span>Solve()</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="integral__types_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> Solve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classoperations__research_1_1TimeLimit.html">TimeLimit</a> *&#160;</td>
<td class="paramname"><em>time_limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>is_solution_optimal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classoperations__research_1_1BaseKnapsackSolver.html#a64d6539ac3d0d0cd8c1e6c4ea41dac52">BaseKnapsackSolver</a>.</p>
<p class="definition">Definition at line <a class="el" href="knapsack__solver_8cc_source.html#l00394">394</a> of file <a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="knapsack__solver_8h_source.html">knapsack_solver.h</a></li>
<li><a class="el" href="knapsack__solver_8cc_source.html">knapsack_solver.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_1KnapsackGenericSolver.html">KnapsackGenericSolver</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.8.18 </li>
</ul>
</div>
</body>
</html>