Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs > Class Template Reference

Base class of all Graphs implemented here. More...

#include <graph.h>

Collaboration diagram for util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >:
Collaboration graph
[legend]

Public Types

typedef NodeIndexType NodeIndex
 Typedef so you can use Graph::NodeIndex and Graph::ArcIndex to be generic but also to improve the readability of your code. More...
 
typedef ArcIndexType ArcIndex
 

Public Member Functions

 BaseGraph ()
 
virtual ~BaseGraph ()
 
NodeIndexType num_nodes () const
 Returns the number of valid nodes in the graph. More...
 
ArcIndexType num_arcs () const
 Returns the number of valid arcs in the graph. More...
 
IntegerRange< NodeIndex > AllNodes () const
 Allows nice range-based for loop: for (const NodeIndex node : graph.AllNodes()) { ... More...
 
IntegerRange< ArcIndex > AllForwardArcs () const
 
bool IsNodeValid (NodeIndexType node) const
 Returns true if the given node is a valid node of the graph. More...
 
bool IsArcValid (ArcIndexType arc) const
 Returns true if the given arc is a valid arc of the graph. More...
 
NodeIndexType node_capacity () const
 Capacity reserved for future nodes, always >= num_nodes_. More...
 
ArcIndexType arc_capacity () const
 Capacity reserved for future arcs, always >= num_arcs_. More...
 
virtual void ReserveNodes (NodeIndexType bound)
 Changes the graph capacities. More...
 
virtual void ReserveArcs (ArcIndexType bound)
 
void Reserve (NodeIndexType node_capacity, ArcIndexType arc_capacity)
 
void FreezeCapacities ()
 FreezeCapacities() makes any future attempt to change the graph capacities crash in DEBUG mode. More...
 
template<typename A , typename B >
void GroupForwardArcsByFunctor (const A &a, B *b)
 
ArcIndexType max_end_arc_index () const
 

Static Public Attributes

static const NodeIndexType kNilNode
 Constants that will never be a valid node or arc. More...
 
static const ArcIndexType kNilArc
 

Protected Member Functions

void ComputeCumulativeSum (std::vector< ArcIndexType > *v)
 Functions commented when defined because they are implementation details. More...
 
void BuildStartAndForwardHead (SVector< NodeIndexType > *head, std::vector< ArcIndexType > *start, std::vector< ArcIndexType > *permutation)
 Given the tail of arc #i in (*head)[i] and the head of arc #i in (*head)[~i]. More...
 

Protected Attributes

NodeIndexType num_nodes_
 
NodeIndexType node_capacity_
 
ArcIndexType num_arcs_
 
ArcIndexType arc_capacity_
 
bool const_capacities_
 

Detailed Description

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
class util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >

Base class of all Graphs implemented here.

The default value for the graph index types is int32 since allmost all graphs that fit into memory do not need bigger indices.

Note
The type can be unsigned, except for the graphs with reverse arcs where the ArcIndexType must be signed, but not necessarly the NodeIndexType.

Definition at line 184 of file graph.h.

Member Typedef Documentation

◆ ArcIndex

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
typedef ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::ArcIndex

Definition at line 190 of file graph.h.

◆ NodeIndex

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
typedef NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::NodeIndex

Typedef so you can use Graph::NodeIndex and Graph::ArcIndex to be generic but also to improve the readability of your code.

We also recommend that you define a typedef ... Graph; for readability.

Definition at line 189 of file graph.h.

Constructor & Destructor Documentation

◆ BaseGraph()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::BaseGraph ( )
inline

Definition at line 192 of file graph.h.

◆ ~BaseGraph()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
virtual util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::~BaseGraph ( )
inlinevirtual

Definition at line 198 of file graph.h.

Member Function Documentation

◆ AllForwardArcs()

template<typename NodeIndexType , typename ArcIndexType , bool HasReverseArcs>
IntegerRange< ArcIndexType > util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::AllForwardArcs ( ) const

Definition at line 935 of file graph.h.

◆ AllNodes()

template<typename NodeIndexType , typename ArcIndexType , bool HasReverseArcs>
IntegerRange< NodeIndexType > util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::AllNodes ( ) const

Allows nice range-based for loop: for (const NodeIndex node : graph.AllNodes()) { ...

BaseGraph implementation -------------------------------------------------—.

} for (const ArcIndex arc : graph.AllForwardArcs()) { ... }

Definition at line 929 of file graph.h.

◆ arc_capacity()

template<typename NodeIndexType , typename ArcIndexType , bool HasReverseArcs>
ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::arc_capacity ( ) const

Capacity reserved for future arcs, always >= num_arcs_.

Todo:
(user): Same questions as the ones in node_capacity().

Definition at line 959 of file graph.h.

◆ BuildStartAndForwardHead()

template<typename NodeIndexType, typename ArcIndexType, bool HasReverseArcs>
void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::BuildStartAndForwardHead ( SVector< NodeIndexType > *  head,
std::vector< ArcIndexType > *  start,
std::vector< ArcIndexType > *  permutation 
)
protected

Given the tail of arc #i in (*head)[i] and the head of arc #i in (*head)[~i].

  • Reorder the arc by increasing tail.
  • Put the head of the new arc #i in (*head)[i].
  • Put in start[i] the index of the first arc with tail >= i.
  • Update "permutation" to reflect the change, unless it is NULL.

Computes the outgoing degree of each nodes and check if we need to permute something or not. Note that the tails are currently stored in the positive range of the SVector head.

Abort early if we do not need the permutation: we only need to put the heads in the positive range.

Computes the forward arc permutation.

Note
this temporarily alters the start vector.

Restore in (*start)[i] the index of the first arc with tail >= i.

Permutes the head into their final position in head. We do not need the tails anymore at this point.

Definition at line 995 of file graph.h.

◆ ComputeCumulativeSum()

template<typename NodeIndexType , typename ArcIndexType, bool HasReverseArcs>
void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::ComputeCumulativeSum ( std::vector< ArcIndexType > *  v)
protected

Functions commented when defined because they are implementation details.

Computes the cummulative sum of the entry in v.

We only use it with in/out degree distribution, hence the Check() at the end.

Definition at line 978 of file graph.h.

◆ FreezeCapacities()

template<typename NodeIndexType , typename ArcIndexType , bool HasReverseArcs>
void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::FreezeCapacities ( )

FreezeCapacities() makes any future attempt to change the graph capacities crash in DEBUG mode.

Todo:
(user): Only define this in debug mode at the cost of having a lot of ifndef NDEBUG all over the place? remove the function completely ?

Definition at line 966 of file graph.h.

◆ GroupForwardArcsByFunctor()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
template<typename A , typename B >
void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::GroupForwardArcsByFunctor ( const A &  a,
B *  b 
)
inline
Todo:
(user): remove the public functions below.

They are just here during the transition from the old ebert_graph api to this new graph api.

Definition at line 264 of file graph.h.

◆ IsArcValid()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
bool util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::IsArcValid ( ArcIndexType  arc) const
inline

Returns true if the given arc is a valid arc of the graph.

Note
the arc validity range changes for graph with reverse arcs.

Definition at line 219 of file graph.h.

◆ IsNodeValid()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
bool util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::IsNodeValid ( NodeIndexType  node) const
inline

Returns true if the given node is a valid node of the graph.

Definition at line 213 of file graph.h.

◆ max_end_arc_index()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::max_end_arc_index ( ) const
inline

Definition at line 267 of file graph.h.

◆ node_capacity()

template<typename NodeIndexType , typename ArcIndexType , bool HasReverseArcs>
NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::node_capacity ( ) const

Capacity reserved for future nodes, always >= num_nodes_.

Todo:
(user): Is it needed? remove completely? return the real capacities at the cost of having a different implementation for each graphs?

Definition at line 951 of file graph.h.

◆ num_arcs()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::num_arcs ( ) const
inline

Returns the number of valid arcs in the graph.

Definition at line 204 of file graph.h.

◆ num_nodes()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::num_nodes ( ) const
inline

Returns the number of valid nodes in the graph.

Definition at line 201 of file graph.h.

◆ Reserve()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::Reserve ( NodeIndexType  node_capacity,
ArcIndexType  arc_capacity 
)
inline

Definition at line 247 of file graph.h.

◆ ReserveArcs()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
virtual void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::ReserveArcs ( ArcIndexType  bound)
inlinevirtual

Reimplemented in util::ReverseArcMixedGraph< NodeIndexType, ArcIndexType >, util::ReverseArcStaticGraph< NodeIndexType, ArcIndexType >, util::ReverseArcListGraph< NodeIndexType, ArcIndexType >, util::StaticGraph< NodeIndexType, ArcIndexType >, and util::ListGraph< NodeIndexType, ArcIndexType >.

Definition at line 241 of file graph.h.

◆ ReserveNodes()

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
virtual void util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::ReserveNodes ( NodeIndexType  bound)
inlinevirtual

Changes the graph capacities.

The functions will fail in debug mode if:

  • const_capacities_ is true.
  • A valid node does not fall into the new node range.
  • A valid arc does not fall into the new arc range. In non-debug mode, const_capacities_ is ignored and nothing will happen if the new capacity value for the arcs or the nodes is too small.

Reimplemented in util::ReverseArcListGraph< NodeIndexType, ArcIndexType >, util::StaticGraph< NodeIndexType, ArcIndexType >, and util::ListGraph< NodeIndexType, ArcIndexType >.

Definition at line 235 of file graph.h.

Member Data Documentation

◆ arc_capacity_

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::arc_capacity_
protected

Definition at line 279 of file graph.h.

◆ const_capacities_

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
bool util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::const_capacities_
protected

Definition at line 280 of file graph.h.

◆ kNilArc

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
const ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::kNilArc
static
Initial value:
=
std::numeric_limits<ArcIndexType>::max()

Definition at line 259 of file graph.h.

◆ kNilNode

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
const NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::kNilNode
static
Initial value:
=
std::numeric_limits<NodeIndexType>::max()

Constants that will never be a valid node or arc.

They are the maximum possible node and arc capacity.

Definition at line 258 of file graph.h.

◆ node_capacity_

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::node_capacity_
protected

Definition at line 277 of file graph.h.

◆ num_arcs_

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
ArcIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::num_arcs_
protected

Definition at line 278 of file graph.h.

◆ num_nodes_

template<typename NodeIndexType = int32, typename ArcIndexType = int32, bool HasReverseArcs = false>
NodeIndexType util::BaseGraph< NodeIndexType, ArcIndexType, HasReverseArcs >::num_nodes_
protected

Definition at line 276 of file graph.h.

The documentation for this class was generated from the following file: