File: order.hpp

package info (click to toggle)
pgrouting 4.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,332 kB
  • sloc: cpp: 21,315; sql: 10,419; ansic: 9,795; perl: 1,142; sh: 919; javascript: 314; xml: 182; makefile: 29
file content (187 lines) | stat: -rw-r--r-- 4,321 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*PGR-GNU*****************************************************************
File: order.hpp

Copyright (c) 2016-2026 pgRouting developers
Mail: project@pgrouting.org

------

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

 ********************************************************************PGR-GNU*/

/*! @file */

#ifndef INCLUDE_VRP_ORDER_HPP_
#define INCLUDE_VRP_ORDER_HPP_
#pragma once


#include <iosfwd>
#include <cstdint>

#include "cpp_common/identifier.hpp"
#include "cpp_common/identifiers.hpp"
#include "vrp/vehicle_node.hpp"

namespace pgrouting {
namespace vrp {


class Order : public Identifier {
 public:
     /*! @name Constructors
      * @{
      */
     Order(size_t p_id, int64_t p_idx,
             const Vehicle_node &p_pickup,
             const Vehicle_node &p_deliver);
     /*!@}*/


     /*! @name Accessors
      * @{
      */


     /*! The delivery node identifier
      *
      * It hold's the idx of the node
      */
     const Vehicle_node& delivery() const;

     /*! The delivery node identifier
      *
      * It hold's the idx of the node
      */
     const Vehicle_node& pickup() const;

     /*! Get a subset of the orders that can be placed after @b this order

      @dot
      digraph G {
      graph [rankdir=LR];
      this [color=green];
      this -> "this.J * J";
      }
      @enddot

      * @param[in] J set of orders
      * @result ithe set intersection of the @b J orders with the @b compatible_J orders of @b this order
      */
     Identifiers<size_t> subsetJ(const Identifiers<size_t> &J) const;
     Identifiers<size_t> subsetI(const Identifiers<size_t> &I) const;
     /*!@}*/


     /*! @name Modifiers
      * @{
      */

     void set_compatibles(const Order order, double speed);
     /*!@}*/

     /*! @name To be or not to be
      * @{
      */

     /*! @brief validate a pickup/delivery order
      *
      * An order is valid when:
      *   - The pickup is well formed
      *   - The delivery is well formed
      *   - isCompatibleIJ to go to delivery after immediately visiting pickup
      */
     bool is_valid(double speed) const;


     /*! @brief Can order @b I be placed before @b this order?
      *

      @dot
      digraph G {
      graph [rankdir=LR];
      this [color=green];
      "I" -> this;
      }
      @enddot

      @param[in] I order
      @param[in] speed to be used for evaluating the order

      @returns true when order @b I can be placed before @b this order
      */
     bool isCompatibleIJ(const Order &I, double speed) const;
     /*!@}*/



     /*! @name Friends
      * @{
      */

     friend std::ostream& operator << (std::ostream&, const Order &);
     /*!@}*/

 private:
     /*! The pick up node identifier
      *
      * It hold's the idx of the node
      */

     Vehicle_node m_pickup;

     /*! The delivery node identifier
      *
      * It hold's the idx of the node
      */
     Vehicle_node m_delivery;

     /*! Stores all the orders that can be placed after this order
      *

      @dot
      digraph G {
      graph [rankdir=LR];
      this [color=green];
      this -> "{J}";
      }
      @enddot

      @todo TODO
      - compatibility changes based on the speed this is not taking that into account (here)
      - check where is it talking that into account
      */
     Identifiers<size_t> m_compatibleJ;

     /*! Stores all the orders that can be placed before this order
      *

      @dot
      digraph G {
      graph [rankdir=LR];
      this [color=green];
      "{I}" -> this;
      }
      @enddot

      */
     Identifiers<size_t> m_compatibleI;
};

}  //  namespace vrp
}  //  namespace pgrouting

#endif  // INCLUDE_VRP_ORDER_HPP_