58 lines
19 KiB
HTML
58 lines
19 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="doxygen.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.1@</span>
|
|
</div>
|
|
</div>
|
|
<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="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_afbb39f66221aac28bbdefd1dca2b2b0.html">constraint_solver</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">routing_index_manager.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="routing__index__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2010-2018 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a 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 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 name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div><div class="line"><a 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_INDEX_MANAGER_H_</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_INDEX_MANAGER_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <tuple></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "ortools/base/int_type_indexed_vector.h"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "ortools/base/logging.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="routing__types_8h.html">ortools/constraint_solver/routing_types.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Manager for any NodeIndex <-> variable index conversion. The routing solver</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// uses variable indices internally and through its API. These variable indices</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// are tricky to manage directly because one Node can correspond to a multitude</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// of variables, depending on the number of times they appear in the model, and</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// if they're used as start and/or end points. This class aims to simplify</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// variable index usage, allowing users to use NodeIndex instead.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">//</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Usage:</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// auto starts_ends = ...; // These are NodeIndex.</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a144750b8ec3f03decd898cc08c6b2894"> 35</a></span> <span class="comment">// RoutingIndexManager manager(/*nodes*/10, /*vehicles*/4, starts_ends);</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// RoutingModel model(manager);</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ad86181cc5dff70e9ce3bfa1f8393cb6a"> 38</a></span> <span class="comment">// Then, use 'manager.NodeToIndex(node)' whenever 'model' requires a variable</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// index.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>RoutingIndexManager {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">typedef</span> RoutingNodeIndex NodeIndex;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keyword">const</span> int64 kUnassigned;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Creates a NodeIndex to variable index mapping for a problem containing</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// 'num_nodes', 'num_vehicles' and the given starts and ends for each vehicle.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// If used, any start/end arrays have to have exactly 'num_vehicles' elements.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  RoutingIndexManager(<span class="keywordtype">int</span> num_nodes, <span class="keywordtype">int</span> num_vehicles, NodeIndex depot);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  RoutingIndexManager(<span class="keywordtype">int</span> num_nodes, <span class="keywordtype">int</span> num_vehicles,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> std::vector<NodeIndex>& starts,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> std::vector<NodeIndex>& ends);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  RoutingIndexManager(</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> num_nodes, <span class="keywordtype">int</span> num_vehicles,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> std::vector<std::pair<NodeIndex, NodeIndex> >& <a class="code" href="namespaceoperations__research.html#a144750b8ec3f03decd898cc08c6b2894">starts_ends</a>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  ~RoutingIndexManager() {}</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> num_nodes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_nodes_; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> num_vehicles()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_vehicles_; }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> num_indices()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> index_to_node_.size(); }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  int64 GetStartIndex(<span class="keywordtype">int</span> vehicle)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> vehicle_to_start_[vehicle]; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  int64 GetEndIndex(<span class="keywordtype">int</span> vehicle)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> vehicle_to_end_[vehicle]; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  int64 <a class="code" href="namespaceoperations__research.html#a891fd91407acbbeb1c47d22be7991b3f">NodeToIndex</a>(NodeIndex node)<span class="keyword"> const </span>{</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  DCHECK_GE(node.value(), 0);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  DCHECK_LT(node.value(), node_to_index_.size());</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> node_to_index_[node];</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::vector<int64> NodesToIndices(<span class="keyword">const</span> std::vector<NodeIndex>& <a class="code" href="routing_8h.html#a0f38add802397fef1f57b7d90ccd5aef">nodes</a>) <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  NodeIndex IndexToNode(int64 index)<span class="keyword"> const </span>{</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  DCHECK_GE(index, 0);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  DCHECK_LT(index, index_to_node_.size());</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> index_to_node_[index];</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// TODO(user): Remove when removal of NodeIndex from RoutingModel is</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// complete.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> num_unique_depots()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> num_unique_depots_; }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::vector<NodeIndex> GetIndexToNodeMap()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> index_to_node_; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  gtl::ITIVector<NodeIndex, int64> GetNodeToIndexMap()<span class="keyword"> const </span>{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> node_to_index_;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> Initialize(</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> num_nodes, <span class="keywordtype">int</span> num_vehicles,</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> std::vector<std::pair<NodeIndex, NodeIndex> >& <a class="code" href="namespaceoperations__research.html#a144750b8ec3f03decd898cc08c6b2894">starts_ends</a>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::vector<NodeIndex> index_to_node_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  gtl::ITIVector<NodeIndex, int64> node_to_index_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::vector<int64> vehicle_to_start_;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  std::vector<int64> vehicle_to_end_;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">int</span> num_nodes_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">int</span> num_vehicles_;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">int</span> num_unique_depots_;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <span class="comment">// namespace operations_research</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif // OR_TOOLS_CONSTRAINT_SOLVER_ROUTING_INDEX_MANAGER_H_</span></div><div class="ttc" id="routing__types_8h_html"><div class="ttname"><a href="routing__types_8h.html">routing_types.h</a></div></div>
|
|
<div class="ttc" id="routing_8h_html_a0f38add802397fef1f57b7d90ccd5aef"><div class="ttname"><a href="routing_8h.html#a0f38add802397fef1f57b7d90ccd5aef">nodes</a></div><div class="ttdeci">int nodes() const</div><div class="ttdoc">Sizes and indices Returns the number of nodes in the model.</div><div class="ttdef"><b>Definition:</b> <a href="routing_8h_source.html#l01180">routing.h:1180</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in c...</div><div class="ttdef"><b>Definition:</b> <a href="constraint__solver_8h_source.html#l00093">constraint_solver.h:93</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_a891fd91407acbbeb1c47d22be7991b3f"><div class="ttname"><a href="namespaceoperations__research.html#a891fd91407acbbeb1c47d22be7991b3f">operations_research::NodeToIndex</a></div><div class="ttdeci">use manager NodeToIndex(node)' whenever 'model' requires a variable *index. */class RoutingIndexManager</div><div class="ttdef"><b>Definition:</b> <a href="routing__index__manager_8h_source.html#l00038">routing_index_manager.h:38</a></div></div>
|
|
<div class="ttc" id="namespaceoperations__research_html_a144750b8ec3f03decd898cc08c6b2894"><div class="ttname"><a href="namespaceoperations__research.html#a144750b8ec3f03decd898cc08c6b2894">operations_research::starts_ends</a></div><div class="ttdeci">starts_ends</div><div class="ttdef"><b>Definition:</b> <a href="routing__index__manager_8h_source.html#l00035">routing_index_manager.h:35</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|