ogdf::FaceElement Class Reference

Faces in a combinatorial embedding. More...

#include <ogdf/basic/CombinatorialEmbedding.h>

Inheritance diagram for ogdf::FaceElement:

Public Member Functions
const ConstCombinatorialEmbedding *	embeddingOf () const
adjEntry	firstAdj () const
	Returns the first adjacency element in the face. More...
int	index () const
	Returns the index of the face. More...
adjEntry	nextFaceEdge (adjEntry adj) const
	Returns the successor of adj in the list of all adjacency elements in the face. More...
face	pred () const
	Returns the predecessor in the list of all faces. More...
int	size () const
	Returns the size of the face, i.e., the number of edges in the face. More...
face	succ () const
	Returns the successor in the list of all faces. More...

Static Public Member Functions
static int	compare (const FaceElement &x, const FaceElement &y)
	Standard Comparer. More...

Public Attributes
internal::FaceAdjContainer	entries
	Container maintaining the adjacency entries in the face. More...

Private Member Functions
	FaceElement (const ConstCombinatorialEmbedding *pEmbedding, adjEntry adjFirst, int id)
	Creates a face with given first adjacency element adjFirst, face index id and keeps track of the owner pEmbedding for debugging. More...

Private Attributes
int	m_id
	The index of the face. More...
const ConstCombinatorialEmbedding *	m_pEmbedding
int	m_size
	The size of the face. More...
Private Attributes inherited from ogdf::internal::GraphElement
GraphElement *	m_next = nullptr
	The successor in the list. More...
GraphElement *	m_prev = nullptr
	The predecessor in the list. More...

Friends
class	CombinatorialEmbedding
class	ConstCombinatorialEmbedding
class	internal::GraphList< FaceElement >

Detailed Description

Faces in a combinatorial embedding.

Definition at line 109 of file CombinatorialEmbedding.h.

Constructor & Destructor Documentation

FaceElement()

ogdf::FaceElement::FaceElement ( const ConstCombinatorialEmbedding *  pEmbedding, adjEntry  adjFirst, int  id  )

inlineprivate

Creates a face with given first adjacency element adjFirst, face index id and keeps track of the owner pEmbedding for debugging.

Definition at line 124 of file CombinatorialEmbedding.h.

Member Function Documentation

compare()

static int ogdf::FaceElement::compare ( const FaceElement &  x, const FaceElement &  y  )

inlinestatic

Standard Comparer.

Definition at line 161 of file CombinatorialEmbedding.h.

embeddingOf()

const ConstCombinatorialEmbedding* ogdf::FaceElement::embeddingOf ( ) const

inline

Definition at line 157 of file CombinatorialEmbedding.h.

firstAdj()

adjEntry ogdf::FaceElement::firstAdj ( ) const

inline

Returns the first adjacency element in the face.

Definition at line 139 of file CombinatorialEmbedding.h.

index()

int ogdf::FaceElement::index ( ) const

inline

Returns the index of the face.

Definition at line 136 of file CombinatorialEmbedding.h.

nextFaceEdge()

adjEntry ogdf::FaceElement::nextFaceEdge ( adjEntry  adj ) const

inline

Returns the successor of adj in the list of all adjacency elements in the face.

Definition at line 151 of file CombinatorialEmbedding.h.

pred()

face ogdf::FaceElement::pred ( ) const

inline

Returns the predecessor in the list of all faces.

Definition at line 148 of file CombinatorialEmbedding.h.

size()

int ogdf::FaceElement::size ( ) const

inline

Returns the size of the face, i.e., the number of edges in the face.

Definition at line 142 of file CombinatorialEmbedding.h.

succ()

face ogdf::FaceElement::succ ( ) const

inline

Returns the successor in the list of all faces.

Definition at line 145 of file CombinatorialEmbedding.h.

Friends And Related Function Documentation

CombinatorialEmbedding

friend class CombinatorialEmbedding

friend

Definition at line 111 of file CombinatorialEmbedding.h.

ConstCombinatorialEmbedding

friend class ConstCombinatorialEmbedding

friend

Definition at line 110 of file CombinatorialEmbedding.h.

internal::GraphList< FaceElement >

friend class internal::GraphList< FaceElement >

friend

Definition at line 112 of file CombinatorialEmbedding.h.

Member Data Documentation

entries

internal::FaceAdjContainer ogdf::FaceElement::entries

Container maintaining the adjacency entries in the face.

Definition at line 133 of file CombinatorialEmbedding.h.

m_id

int ogdf::FaceElement::m_id

private

The index of the face.

Definition at line 115 of file CombinatorialEmbedding.h.

m_pEmbedding

const ConstCombinatorialEmbedding* ogdf::FaceElement::m_pEmbedding

private

Definition at line 119 of file CombinatorialEmbedding.h.

m_size

int ogdf::FaceElement::m_size

private

The size of the face.

Definition at line 116 of file CombinatorialEmbedding.h.

---

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

• include/ogdf/basic/CombinatorialEmbedding.h