273 lines
14 KiB
HTML
273 lines
14 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">OR-Tools 7.2</span>
|
|
</div>
|
|
</div>
|
|
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<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><!-- 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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classoperations__research_1_1SimpleBoundCosts.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classoperations__research_1_1SimpleBoundCosts-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">operations_research::SimpleBoundCosts Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A structure meant to store soft bounds and associated violation constants. </p>
|
|
<p>It is 'Simple' because it has one <a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> per element, in contrast to 'Multiple'. Design notes:</p><ul>
|
|
<li>it is meant to store model information to be shared through pointers, so it disallows copy and assign to avoid accidental duplication.</li>
|
|
<li>it keeps soft bounds as an array of structs to help cache, because code that uses such bounds typically use both bound and cost.</li>
|
|
<li>soft bounds are named pairs, prevents some mistakes.</li>
|
|
<li>using operator[] to access elements is not interesting, because the structure will be accessed through pointers, moreover having to type bound_cost reminds the user of the order if they do a copy assignment of the element. </li>
|
|
</ul>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="routing_8h_source.html#l01984">1984</a> of file <a class="el" href="routing_8h_source.html">routing.h</a>.</p>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a6ec9098d43f8ccbd6f7b5b6dfb047e78"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#a6ec9098d43f8ccbd6f7b5b6dfb047e78">SimpleBoundCosts</a> (int num_bounds, <a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> default_bound_cost)</td></tr>
|
|
<tr class="separator:a6ec9098d43f8ccbd6f7b5b6dfb047e78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35969473ece3e5d19884346b0ffc3044"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#a35969473ece3e5d19884346b0ffc3044">bound_cost</a> (int element)</td></tr>
|
|
<tr class="separator:a35969473ece3e5d19884346b0ffc3044"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad07f030289731fbe799ec1a315b40ca9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#ad07f030289731fbe799ec1a315b40ca9">bound_cost</a> (int element) const</td></tr>
|
|
<tr class="separator:ad07f030289731fbe799ec1a315b40ca9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7257d43ea91bd77ebb30817a6cb80928"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#a7257d43ea91bd77ebb30817a6cb80928">Size</a> ()</td></tr>
|
|
<tr class="separator:a7257d43ea91bd77ebb30817a6cb80928"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86f1488546e3c969059a0da1cf632a31"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#a86f1488546e3c969059a0da1cf632a31">SimpleBoundCosts</a> (const <a class="el" href="classoperations__research_1_1SimpleBoundCosts.html">SimpleBoundCosts</a> &)=delete</td></tr>
|
|
<tr class="separator:a86f1488546e3c969059a0da1cf632a31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25cbaaa77d5d9c0ded3f786b3634f71b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html">SimpleBoundCosts</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SimpleBoundCosts.html#a25cbaaa77d5d9c0ded3f786b3634f71b">operator=</a> (const <a class="el" href="classoperations__research_1_1SimpleBoundCosts.html">SimpleBoundCosts</a> &)=delete</td></tr>
|
|
<tr class="separator:a25cbaaa77d5d9c0ded3f786b3634f71b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6ec9098d43f8ccbd6f7b5b6dfb047e78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ec9098d43f8ccbd6f7b5b6dfb047e78">◆ </a></span>SimpleBoundCosts() <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">operations_research::SimpleBoundCosts::SimpleBoundCosts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>num_bounds</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> </td>
|
|
<td class="paramname"><em>default_bound_cost</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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="routing_8h_source.html#l01990">1990</a> of file <a class="el" href="routing_8h_source.html">routing.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86f1488546e3c969059a0da1cf632a31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86f1488546e3c969059a0da1cf632a31">◆ </a></span>SimpleBoundCosts() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">operations_research::SimpleBoundCosts::SimpleBoundCosts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleBoundCosts.html">SimpleBoundCosts</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a35969473ece3e5d19884346b0ffc3044"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35969473ece3e5d19884346b0ffc3044">◆ </a></span>bound_cost() <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="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a>& operations_research::SimpleBoundCosts::bound_cost </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>element</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="routing_8h_source.html#l01992">1992</a> of file <a class="el" href="routing_8h_source.html">routing.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad07f030289731fbe799ec1a315b40ca9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad07f030289731fbe799ec1a315b40ca9">◆ </a></span>bound_cost() <span class="overload">[2/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="structoperations__research_1_1SimpleBoundCosts_1_1BoundCost.html">BoundCost</a> operations_research::SimpleBoundCosts::bound_cost </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>element</em></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="routing_8h_source.html#l01993">1993</a> of file <a class="el" href="routing_8h_source.html">routing.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25cbaaa77d5d9c0ded3f786b3634f71b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25cbaaa77d5d9c0ded3f786b3634f71b">◆ </a></span>operator=()</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_1SimpleBoundCosts.html">SimpleBoundCosts</a> operations_research::SimpleBoundCosts::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classoperations__research_1_1SimpleBoundCosts.html">SimpleBoundCosts</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7257d43ea91bd77ebb30817a6cb80928"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7257d43ea91bd77ebb30817a6cb80928">◆ </a></span>Size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int operations_research::SimpleBoundCosts::Size </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="routing_8h_source.html#l01994">1994</a> of file <a class="el" href="routing_8h_source.html">routing.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="routing_8h_source.html">routing.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|