Public Types | Public Member Functions | Protected Attributes | List of all members
corbo::HyperGraph Class Reference

hyper-graph representation More...

#include <hyper_graph.h>

Public Types

using Ptr = std::shared_ptr< HyperGraph >
 

Public Member Functions

bool checkGraphConsistency ()
 Return number of objective edges. More...
 
OptimizationEdgeSet::Ptr getEdgeSet () const
 
OptimizationEdgeSetgetEdgeSetRaw () const
 
VertexSetInterface::Ptr getVertexSet () const
 
VertexSetInterfacegetVertexSetRaw () const
 
bool hasEdgeSet () const
 
bool hasVertexSet () const
 
 HyperGraph ()
 
 HyperGraph (OptimizationEdgeSet::Ptr edges, VertexSetInterface::Ptr vertices)
 
void setEdgeSet (OptimizationEdgeSet::Ptr edges)
 
void setVertexSet (VertexSetInterface::Ptr vertices)
 
virtual ~HyperGraph ()
 

Protected Attributes

OptimizationEdgeSet::Ptr _edges
 
VertexSetInterface::Ptr _vertices
 

Detailed Description

hyper-graph representation

See also
VertexInterface EdgeInterface BaseEdge DiscretizationGrid
Author
Christoph Rösmann (chris.nosp@m.toph.nosp@m..roes.nosp@m.mann.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)

Definition at line 46 of file hyper_graph.h.

Member Typedef Documentation

◆ Ptr

using corbo::HyperGraph::Ptr = std::shared_ptr<HyperGraph>

Definition at line 49 of file hyper_graph.h.

Constructor & Destructor Documentation

◆ HyperGraph() [1/2]

corbo::HyperGraph::HyperGraph ( )
inline

Definition at line 53 of file hyper_graph.h.

◆ HyperGraph() [2/2]

corbo::HyperGraph::HyperGraph ( OptimizationEdgeSet::Ptr  edges,
VertexSetInterface::Ptr  vertices 
)
inline

Definition at line 59 of file hyper_graph.h.

◆ ~HyperGraph()

virtual corbo::HyperGraph::~HyperGraph ( )
inlinevirtual

Definition at line 65 of file hyper_graph.h.

Member Function Documentation

◆ checkGraphConsistency()

bool corbo::HyperGraph::checkGraphConsistency ( )

Return number of objective edges.

Return number of equality constraint edges Return number of inequality constraint edges Return number of vertices Add a vertex to the graph (without taking ownership) Add objective edge to the graph (and taking ownership) Add equality constraint edge to the graph (and taking ownership) Add inequality constraint edge to the graph (and taking ownership) Precompute the structure of the graph to speed-up later computations Reset hyper-graph structure

Calling this method does only reset flags that capture the state of structure precomputation. Edges and vertices are not touched, otherwise refer to clear() or clearConnectedEdges().Determine, if all vertices that are attached to an edge are part of the hyper graph

Definition at line 50 of file hyper_graph.cpp.

◆ getEdgeSet()

OptimizationEdgeSet::Ptr corbo::HyperGraph::getEdgeSet ( ) const
inline

Definition at line 73 of file hyper_graph.h.

◆ getEdgeSetRaw()

OptimizationEdgeSet* corbo::HyperGraph::getEdgeSetRaw ( ) const
inline

Definition at line 76 of file hyper_graph.h.

◆ getVertexSet()

VertexSetInterface::Ptr corbo::HyperGraph::getVertexSet ( ) const
inline

Definition at line 74 of file hyper_graph.h.

◆ getVertexSetRaw()

VertexSetInterface* corbo::HyperGraph::getVertexSetRaw ( ) const
inline

Definition at line 77 of file hyper_graph.h.

◆ hasEdgeSet()

bool corbo::HyperGraph::hasEdgeSet ( ) const
inline

Definition at line 70 of file hyper_graph.h.

◆ hasVertexSet()

bool corbo::HyperGraph::hasVertexSet ( ) const
inline

Definition at line 71 of file hyper_graph.h.

◆ setEdgeSet()

void corbo::HyperGraph::setEdgeSet ( OptimizationEdgeSet::Ptr  edges)
inline

Definition at line 67 of file hyper_graph.h.

◆ setVertexSet()

void corbo::HyperGraph::setVertexSet ( VertexSetInterface::Ptr  vertices)
inline

Definition at line 68 of file hyper_graph.h.

Member Data Documentation

◆ _edges

OptimizationEdgeSet::Ptr corbo::HyperGraph::_edges
protected

Definition at line 111 of file hyper_graph.h.

◆ _vertices

VertexSetInterface::Ptr corbo::HyperGraph::_vertices
protected

Definition at line 112 of file hyper_graph.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:02