Files
ortools-clone/docs/cpp_routing/routing__parameters_8h_source.html
Laurent Perron 5615fe9c61 regenerate docs
2022-01-17 21:42:14 +01:00

134 lines
12 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"/>-->
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 9.2</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: Routing</h1>
</div>
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('routing__parameters_8h_source.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="headertitle"><div class="title">routing_parameters.h</div></div>
</div><!--header-->
<div class="contents">
<a href="routing__parameters_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_PARAMETERS_H_</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_PARAMETERS_H_</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &quot;<a class="code" href="routing__parameters_8pb_8h.html">ortools/constraint_solver/routing_parameters.pb.h</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#aa388c8707db255ae7742c04046bdd613"> 23</a></span><a class="code hl_class" href="classoperations__research_1_1_routing_model_parameters.html">RoutingModelParameters</a> <a class="code hl_function" href="namespaceoperations__research.html#aa388c8707db255ae7742c04046bdd613">DefaultRoutingModelParameters</a>();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#adcac4a11f1e4d36ceb47f7251461487d"> 24</a></span><a class="code hl_class" href="classoperations__research_1_1_routing_search_parameters.html">RoutingSearchParameters</a> <a class="code hl_function" href="namespaceoperations__research.html#adcac4a11f1e4d36ceb47f7251461487d">DefaultRoutingSearchParameters</a>();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ae2e060e8ee4ea901dc4df260b3385eac"> 28</a></span>std::string <a class="code hl_function" href="namespaceoperations__research.html#ae2e060e8ee4ea901dc4df260b3385eac">FindErrorInRoutingSearchParameters</a>(</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">const</span> <a class="code hl_class" href="classoperations__research_1_1_routing_search_parameters.html">RoutingSearchParameters</a>&amp; search_parameters);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>} <span class="comment">// namespace operations_research</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_PARAMETERS_H_</span></div>
<div class="ttc" id="aclassoperations__research_1_1_routing_model_parameters_html"><div class="ttname"><a href="classoperations__research_1_1_routing_model_parameters.html">operations_research::RoutingModelParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="routing__parameters_8pb_8h_source.html#l01449">routing_parameters.pb.h:1450</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_routing_search_parameters_html"><div class="ttname"><a href="classoperations__research_1_1_routing_search_parameters.html">operations_research::RoutingSearchParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="routing__parameters_8pb_8h_source.html#l00767">routing_parameters.pb.h:768</a></div></div>
<div class="ttc" id="anamespaceoperations__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="constraint__solver_8h_source.html#l00109">constraint_solver.h:109</a></div></div>
<div class="ttc" id="anamespaceoperations__research_html_aa388c8707db255ae7742c04046bdd613"><div class="ttname"><a href="namespaceoperations__research.html#aa388c8707db255ae7742c04046bdd613">operations_research::DefaultRoutingModelParameters</a></div><div class="ttdeci">RoutingModelParameters DefaultRoutingModelParameters()</div></div>
<div class="ttc" id="anamespaceoperations__research_html_adcac4a11f1e4d36ceb47f7251461487d"><div class="ttname"><a href="namespaceoperations__research.html#adcac4a11f1e4d36ceb47f7251461487d">operations_research::DefaultRoutingSearchParameters</a></div><div class="ttdeci">RoutingSearchParameters DefaultRoutingSearchParameters()</div></div>
<div class="ttc" id="anamespaceoperations__research_html_ae2e060e8ee4ea901dc4df260b3385eac"><div class="ttname"><a href="namespaceoperations__research.html#ae2e060e8ee4ea901dc4df260b3385eac">operations_research::FindErrorInRoutingSearchParameters</a></div><div class="ttdeci">std::string FindErrorInRoutingSearchParameters(const RoutingSearchParameters &amp;search_parameters)</div><div class="ttdoc">Returns an empty std::string if the routing search parameters are valid, and a non-empty,...</div></div>
<div class="ttc" id="arouting__parameters_8pb_8h_html"><div class="ttname"><a href="routing__parameters_8pb_8h.html">routing_parameters.pb.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>