Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::HyperedgeElement Class Reference

Class for the representation of hyperedges. More...

#include <ogdf/hypergraph/Hypergraph.h>

+ Inheritance diagram for ogdf::HyperedgeElement:

Public Member Functions

template<class NODELIST >
void allHypernodes (NODELIST &hypernodes) const
 Returns a list with all incident hypernodes of the hyperedge. More...
 
int cardinality () const
 Returns the number of incident hypernodes. More...
 
adjHypergraphEntry firstAdj () const
 Returns the first entry in the adjaceny list. More...
 
Hypergraphhypergraph () const
 Returns the hypergraph containing the hyperedge. More...
 
bool incident (hypernode v) const
 Returns true iff v is incident to the hyperedge. More...
 
internal::GraphList< AdjHypergraphElementincidentHypernodes () const
 Returns the incident hypernodes of the hyperedge. More...
 
int index () const
 Returns the index of a hyperedge. More...
 
adjHypergraphEntry lastAdj () const
 Returns the last entry in the adjacency list. More...
 
bool operator== (const hyperedge e) const
 Equality operator. More...
 
hyperedge pred () const
 Returns the predecessor in the list of all hyperedges. More...
 
hyperedge succ () const
 Returns the successor in the list of all hyperedges. More...
 

Public Attributes

 OGDF_NEW_DELETE
 

Private Member Functions

 HyperedgeElement (int pIndex)
 Constructs an hyperedge element between hypernodes. More...
 

Private Attributes

internal::GraphList< AdjHypergraphElementm_adjHypernodes
 The adjacency list of the hyperedge. More...
 
int m_cardinality
 The number of incidend hypernodes. More...
 
Hypergraphm_hypergraph
 The hypergraph containing the hyperedge (if any). More...
 
int m_index
 The (unique) index of the hyperedge. More...
 
- Private Attributes inherited from ogdf::internal::GraphElement
GraphElementm_next = nullptr
 The successor in the list. More...
 
GraphElementm_prev = nullptr
 The predecessor in the list. More...
 

Friends

class GraphListBase
 
class Hypergraph
 
class internal::GraphList< HyperedgeElement >
 
std::ostream & operator<< (std::ostream &os, ogdf::hyperedge e)
 

Detailed Description

Class for the representation of hyperedges.

Definition at line 155 of file Hypergraph.h.

Constructor & Destructor Documentation

◆ HyperedgeElement()

ogdf::HyperedgeElement::HyperedgeElement ( int  pIndex)
inlineexplicitprivate

Constructs an hyperedge element between hypernodes.

Parameters
pIndexis the index of the hyperedge.

Definition at line 179 of file Hypergraph.h.

Member Function Documentation

◆ allHypernodes()

template<class NODELIST >
void ogdf::HyperedgeElement::allHypernodes ( NODELIST &  hypernodes) const
inline

Returns a list with all incident hypernodes of the hyperedge.

Definition at line 221 of file Hypergraph.h.

◆ cardinality()

int ogdf::HyperedgeElement::cardinality ( ) const
inline

Returns the number of incident hypernodes.

Definition at line 191 of file Hypergraph.h.

◆ firstAdj()

adjHypergraphEntry ogdf::HyperedgeElement::firstAdj ( ) const
inline

Returns the first entry in the adjaceny list.

Definition at line 203 of file Hypergraph.h.

◆ hypergraph()

Hypergraph* ogdf::HyperedgeElement::hypergraph ( ) const
inline

Returns the hypergraph containing the hyperedge.

Definition at line 197 of file Hypergraph.h.

◆ incident()

bool ogdf::HyperedgeElement::incident ( hypernode  v) const
inline

Returns true iff v is incident to the hyperedge.

Definition at line 229 of file Hypergraph.h.

◆ incidentHypernodes()

internal::GraphList<AdjHypergraphElement> ogdf::HyperedgeElement::incidentHypernodes ( ) const
inline

Returns the incident hypernodes of the hyperedge.

Definition at line 215 of file Hypergraph.h.

◆ index()

int ogdf::HyperedgeElement::index ( ) const
inline

Returns the index of a hyperedge.

Definition at line 185 of file Hypergraph.h.

◆ lastAdj()

adjHypergraphEntry ogdf::HyperedgeElement::lastAdj ( ) const
inline

Returns the last entry in the adjacency list.

Definition at line 209 of file Hypergraph.h.

◆ operator==()

bool ogdf::HyperedgeElement::operator== ( const hyperedge  e) const
inline

Equality operator.

Definition at line 252 of file Hypergraph.h.

◆ pred()

hyperedge ogdf::HyperedgeElement::pred ( ) const
inline

Returns the predecessor in the list of all hyperedges.

Definition at line 246 of file Hypergraph.h.

◆ succ()

hyperedge ogdf::HyperedgeElement::succ ( ) const
inline

Returns the successor in the list of all hyperedges.

Definition at line 240 of file Hypergraph.h.

Friends And Related Function Documentation

◆ GraphListBase

friend class GraphListBase
friend

Definition at line 158 of file Hypergraph.h.

◆ Hypergraph

friend class Hypergraph
friend

Definition at line 157 of file Hypergraph.h.

◆ internal::GraphList< HyperedgeElement >

friend class internal::GraphList< HyperedgeElement >
friend

Definition at line 159 of file Hypergraph.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
ogdf::hyperedge  e 
)
friend

Member Data Documentation

◆ m_adjHypernodes

internal::GraphList<AdjHypergraphElement> ogdf::HyperedgeElement::m_adjHypernodes
private

The adjacency list of the hyperedge.

Definition at line 164 of file Hypergraph.h.

◆ m_cardinality

int ogdf::HyperedgeElement::m_cardinality
private

The number of incidend hypernodes.

Definition at line 170 of file Hypergraph.h.

◆ m_hypergraph

Hypergraph* ogdf::HyperedgeElement::m_hypergraph
private

The hypergraph containing the hyperedge (if any).

Definition at line 173 of file Hypergraph.h.

◆ m_index

int ogdf::HyperedgeElement::m_index
private

The (unique) index of the hyperedge.

Definition at line 167 of file Hypergraph.h.

◆ OGDF_NEW_DELETE

ogdf::HyperedgeElement::OGDF_NEW_DELETE

Definition at line 259 of file Hypergraph.h.


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