A template for the base class that holds the functionality that exists in common between the EbertGraph<> template and the ForwardEbertGraph<> template.
This template is for internal use only, and this is enforced by making all constructors for this class template protected. Clients should use one of the two derived-class templates. Most clients will not even use those directly, but will use the StarGraph and ForwardStarGraph typenames declared above.
The DerivedGraph template argument must be the type of the class (typically itself built from a template) that:
Definition at line 948 of file ebert_graph.h.
Classes | |
| class | CycleHandlerForAnnotatedArcs |
Public Member Functions | |
| bool | Reserve (NodeIndexType new_max_num_nodes, ArcIndexType new_max_num_arcs) |
| Reserves memory needed for max_num_nodes nodes and max_num_arcs arcs. More... | |
| ArcIndexType | AddArc (NodeIndexType tail, NodeIndexType head) |
| Adds an arc to the graph and returns its index. More... | |
| template<typename ArcIndexTypeStrictWeakOrderingFunctor > | |
| void | GroupForwardArcsByFunctor (const ArcIndexTypeStrictWeakOrderingFunctor &compare, PermutationCycleHandler< ArcIndexType > *annotation_handler) |
| ArcIndexType | end_arc_index () const |
| Returns one more than the largest index of an extant direct arc. More... | |
| bool | IsNodeValid (NodeIndexType node) const |
| Utility function to check that a node index is within the bounds AND different from kNilNode. More... | |
| NodeIndexType | num_nodes () const |
| Returns the number of nodes in the graph. More... | |
| ArcIndexType | num_arcs () const |
| Returns the number of original arcs in the graph (The ones with positive indices.) More... | |
| NodeIndexType | end_node_index () const |
| Returns one more than the largest index of an extant node, meaning a node that is mentioned as the head or tail of some arc in the graph. More... | |
| ArcIndexType | end_arc_index () const |
| Returns one more than the largest index of an extant direct arc. More... | |
| NodeIndexType | max_num_nodes () const |
| Returns the maximum possible number of nodes in the graph. More... | |
| ArcIndexType | max_num_arcs () const |
| Returns the maximum possible number of original arcs in the graph. More... | |
| NodeIndexType | max_end_node_index () const |
| Returns one more than the largest valid index of a node. More... | |
| ArcIndexType | max_end_arc_index () const |
| Returns one more than the largest valid index of a direct arc. More... | |
| bool | IsNodeValid (NodeIndexType node) const |
| Utility function to check that a node index is within the bounds AND different from kNilNode. More... | |
| ArcIndexType | LookUpArc (const NodeIndexType tail, const NodeIndexType head) const |
| Returns the first arc going from tail to head, if it exists, or kNilArc if such an arc does not exist. More... | |
| NodeIndexType | Head (const ArcIndexType arc) const |
| Returns the head or end-node of arc. More... | |
| std::string | NodeDebugString (const NodeIndexType node) const |
| std::string | ArcDebugString (const ArcIndexType arc) const |
Static Public Attributes | |
| static const ArcIndexType | kFirstArc |
| The index of the first arc in the graph. More... | |
| static const NodeIndexType | kFirstNode |
| The index of the first node in the graph. More... | |
| static const ArcIndexType | kMaxNumArcs |
| The maximum possible number of arcs in the graph. More... | |
| static const NodeIndexType | kMaxNumNodes |
| The maximum possible number of nodes in the graph. More... | |
| static const ArcIndexType | kNilArc |
| The index of the 'nil' arc in the graph. More... | |
| static const NodeIndexType | kNilNode |
| The index of the 'nil' node in the graph. More... | |
Protected Member Functions | |
| EbertGraphBase () | |
| ~EbertGraphBase () | |
| void | Initialize (NodeIndexType max_num_nodes, ArcIndexType max_num_arcs) |
| ArcIndexType | FirstOutgoingOrOppositeIncomingArc (const NodeIndexType node) const |
| Returns the first arc in node's incidence list. More... | |
| ArcIndexType | NextAdjacentArc (const ArcIndexType arc) const |
| Returns the next arc following the passed argument in its adjacency list. More... | |
| ArcIndexType | NextOutgoingArc (const NodeIndexType unused_node, const ArcIndexType arc) const |
| Returns the outgoing arc following the argument in the adjacency list. More... | |
| NodeIndexType | StartNode (NodeIndexType node) const |
| Returns kNilNode if the graph has no nodes or node if it has at least one node. More... | |
| ArcIndexType | StartArc (ArcIndexType arc) const |
| Returns kNilArc if the graph has no arcs arc if it has at least one arc. More... | |
| NodeIndexType | NextNode (const NodeIndexType node) const |
| Returns the node following the argument in the graph. More... | |
| ArcIndexType | NextArc (const ArcIndexType arc) const |
| Returns the arc following the argument in the graph. More... | |
| ArcIndexType | FirstOutgoingArc (const NodeIndexType node) const |
| Returns the first outgoing arc for node. More... | |
Protected Attributes | |
| ZVector< ArcIndexType > | next_adjacent_arc_ |
| Array of next indices. More... | |
| bool | representation_clean_ |
| Flag to indicate that BuildRepresentation() needs to be called before the adjacency lists are examined. More... | |
| ZVector< ArcIndexType > | first_incident_arc_ |
| Array of arc indices. More... | |
| ZVector< NodeIndexType > | head_ |
| Array of node indices. head_[i] contains the head node of arc i. More... | |
| ArcIndexType | max_num_arcs_ |
| The maximum number of arcs that the graph can hold. More... | |
| NodeIndexType | max_num_nodes_ |
| The maximum number of nodes that the graph can hold. More... | |
| ArcIndexType | num_arcs_ |
| The current number of arcs held by the graph. More... | |
| NodeIndexType | num_nodes_ |
| The maximum index of the node currently held by the graph. More... | |
Friends | |
| class | StarGraphBase< NodeIndexType, ArcIndexType, DerivedGraph > |
|
inlineprotected |
Definition at line 1108 of file ebert_graph.h.
|
inlineprotected |
Definition at line 1110 of file ebert_graph.h.
|
inline |
Adds an arc to the graph and returns its index.
Returns kNilArc if the arc could not be added.
Definition at line 1001 of file ebert_graph.h.
|
inlineinherited |
Definition at line 310 of file ebert_graph.h.
|
inlineinherited |
Returns one more than the largest index of an extant direct arc.
To be used as a helper when clients need to dimension or iterate over arrays of arc annotation information.
Definition at line 252 of file ebert_graph.h.
|
inline |
Returns one more than the largest index of an extant direct arc.
To be used as a helper when clients need to dimension or iterate over arrays of arc annotation information.
Definition at line 252 of file ebert_graph.h.
|
inlineinherited |
Returns one more than the largest index of an extant node, meaning a node that is mentioned as the head or tail of some arc in the graph.
To be used as a helper when clients need to dimension or iterate over arrays of node annotation information.
Definition at line 247 of file ebert_graph.h.
|
inlineprotectedinherited |
Returns the first outgoing arc for node.
Definition at line 479 of file ebert_graph.h.
|
inlineprotected |
Returns the first arc in node's incidence list.
Definition at line 1123 of file ebert_graph.h.
|
inline |
Determine the permutation that groups arcs by their tail nodes.
Start with the identity permutation.
Now we actually permute the head_ array and the scaled_arc_cost_ array according to the sorting permutation.
Finally, rebuild the graph from its permuted head_ array.
Definition at line 1022 of file ebert_graph.h.
|
inlineinherited |
Returns the head or end-node of arc.
Definition at line 297 of file ebert_graph.h.
|
inlineprotected |
Definition at line 1112 of file ebert_graph.h.
|
inlineinherited |
Utility function to check that a node index is within the bounds AND different from kNilNode.
Returns true if node is in the range [kFirstNode .. max_num_nodes_). It is exported so that users of the DerivedGraph class can use it. To be used in a DCHECK; also used internally to validate arguments passed to our methods from clients (e.g., AddArc()).
Definition at line 279 of file ebert_graph.h.
|
inline |
Utility function to check that a node index is within the bounds AND different from kNilNode.
Returns true if node is in the range [kFirstNode .. max_num_nodes_). It is exported so that users of the DerivedGraph class can use it. To be used in a DCHECK; also used internally to validate arguments passed to our methods from clients (e.g., AddArc()).
Definition at line 279 of file ebert_graph.h.
|
inlineinherited |
Returns the first arc going from tail to head, if it exists, or kNilArc if such an arc does not exist.
Definition at line 285 of file ebert_graph.h.
|
inlineinherited |
Returns one more than the largest valid index of a direct arc.
To be used as a helper when clients need to dimension or iterate over arrays of arc annotation information.
Definition at line 271 of file ebert_graph.h.
|
inlineinherited |
Returns one more than the largest valid index of a node.
To be used as a helper when clients need to dimension or iterate over arrays of node annotation information.
Definition at line 264 of file ebert_graph.h.
|
inlineinherited |
Returns the maximum possible number of original arcs in the graph.
(The ones with positive indices.)
Definition at line 259 of file ebert_graph.h.
|
inlineinherited |
Returns the maximum possible number of nodes in the graph.
Definition at line 255 of file ebert_graph.h.
|
inlineprotected |
Returns the next arc following the passed argument in its adjacency list.
Definition at line 1131 of file ebert_graph.h.
|
inlineprotectedinherited |
Returns the arc following the argument in the graph.
Returns kNilArc (= end) if the range of arcs has been exhausted. It is called by ArcIterator::Next() and as such does not expect to be passed an argument equal to kNilArc. This is why the return line is simplified from return ( arc == kNilArc || next_arc >= num_arcs_) ? kNilArc : next_arc; to return next_arc < num_arcs_ ? next_arc : kNilArc;
Definition at line 472 of file ebert_graph.h.
|
inlineprotectedinherited |
Returns the node following the argument in the graph.
Returns kNilNode (= end) if the range of nodes has been exhausted. It is called by NodeIterator::Next() and as such does not expect to be passed an argument equal to kNilNode. This is why the return line is simplified from return (node == kNilNode || next_node >= num_nodes_) ? kNilNode : next_node; to return next_node < num_nodes_ ? next_node : kNilNode;
Definition at line 458 of file ebert_graph.h.
|
inlineprotected |
Returns the outgoing arc following the argument in the adjacency list.
Definition at line 1138 of file ebert_graph.h.
|
inlineinherited |
Definition at line 302 of file ebert_graph.h.
|
inlineinherited |
Returns the number of original arcs in the graph (The ones with positive indices.)
Definition at line 241 of file ebert_graph.h.
|
inlineinherited |
Returns the number of nodes in the graph.
Definition at line 237 of file ebert_graph.h.
|
inline |
Reserves memory needed for max_num_nodes nodes and max_num_arcs arcs.
Returns false if the parameters passed are not OK. It can be used to enlarge the graph, but does not shrink memory if called with smaller values.
Definition at line 978 of file ebert_graph.h.
|
inlineprotectedinherited |
Returns kNilArc if the graph has no arcs arc if it has at least one arc.
Useful for initializing iterators correctly in the case of empty graphs.
Definition at line 445 of file ebert_graph.h.
|
inlineprotectedinherited |
Returns kNilNode if the graph has no nodes or node if it has at least one node.
Useful for initializing iterators correctly in the case of empty graphs.
Definition at line 439 of file ebert_graph.h.
|
friend |
Definition at line 951 of file ebert_graph.h.
|
protected |
Array of arc indices.
first_incident_arc_[i] contains the first arc incident to node i.
Definition at line 502 of file ebert_graph.h.
|
protected |
Array of node indices. head_[i] contains the head node of arc i.
Definition at line 498 of file ebert_graph.h.
|
static |
The index of the first arc in the graph.
Definition at line 225 of file ebert_graph.h.
|
static |
The index of the first node in the graph.
Definition at line 222 of file ebert_graph.h.
|
static |
The maximum possible number of arcs in the graph.
(The maximum index is kMaxNumArcs-1, since indices start at 0. Unfortunately we waste a value representing this and the max_num_arcs_ member.)
(The maximum index is kMaxNumArcs-1, since indices start at 0.)
Definition at line 235 of file ebert_graph.h.
|
static |
The maximum possible number of nodes in the graph.
The maximum possible node index in the graph.
(The maximum index is kMaxNumNodes-1, since indices start at 0. Unfortunately we waste a value representing this and the max_num_nodes_ member.)
Definition at line 230 of file ebert_graph.h.
|
static |
The index of the 'nil' arc in the graph.
Definition at line 219 of file ebert_graph.h.
|
static |
The index of the 'nil' node in the graph.
Definition at line 216 of file ebert_graph.h.
|
protected |
The maximum number of arcs that the graph can hold.
Definition at line 489 of file ebert_graph.h.
|
protected |
The maximum number of nodes that the graph can hold.
Definition at line 486 of file ebert_graph.h.
|
protected |
Array of next indices.
next_adjacent_arc_[i] contains the next arc in the adjacency list of arc i.
Definition at line 1147 of file ebert_graph.h.
|
protected |
The current number of arcs held by the graph.
Definition at line 495 of file ebert_graph.h.
|
protected |
The maximum index of the node currently held by the graph.
Definition at line 492 of file ebert_graph.h.
|
protected |
Flag to indicate that BuildRepresentation() needs to be called before the adjacency lists are examined.
Only for DCHECK in debug builds.
Definition at line 1152 of file ebert_graph.h.