ogdf::planar_separators::Ring Struct Reference

A closed ring of nodes. More...

#include <ogdf/graphalg/SeparatorHarPeled.h>

Public Member Functions
	Ring ()
	Constructor. More...
	Ring (node n)
	Constructor for degenerate rings. More...
	Ring (node startNode, node endNode, adjEntry outPointer, const SeparatorHarPeled &separator)
	Constructor for a full ring. More...
int	getFaces () const
List< adjEntry >	getSectionInSeparator (bool firstSection) const
	Returns a section of this ring, either the first one from in to out, or the second one from out to in. More...
int	getSize () const

Public Attributes
List< adjEntry >	entries
int	faces
node	in
	Crossing points with the main separator S: in is where S enters, out is where S leaves. More...
bool	isDegenerate = false
	A degenerate ring contains only one node. More...
List< node >	nodes
	Nodes and adjEntries that form the border of the ring. More...
node	out

Detailed Description

A closed ring of nodes.

A representation of the border of a closed region containing the root node.

Definition at line 297 of file SeparatorHarPeled.h.

Constructor & Destructor Documentation

Ring() [1/3]

ogdf::planar_separators::Ring::Ring ( )

inline

Constructor.

Definition at line 314 of file SeparatorHarPeled.h.

Ring() [2/3]

ogdf::planar_separators::Ring::Ring ( node  n )

inline

Constructor for degenerate rings.

Parameters

n	the only node on the ring

Definition at line 321 of file SeparatorHarPeled.h.

Ring() [3/3]

ogdf::planar_separators::Ring::Ring ( node  startNode, node  endNode, adjEntry  outPointer, const SeparatorHarPeled &  separator  )

inline

Constructor for a full ring.

Constructs a ring by following the border edges of the region on the inside. If a complicated node is encountered, we take the next clockwise out-edge of that node.

Parameters

startNode	first node on the ring, also intersection point of ring and separator
endNode	second intersection point of ring and separator
outPointer	next adjEntry in the separator that points from startnode in the direction of psi
separator	the separator that uses this ring

Definition at line 333 of file SeparatorHarPeled.h.

Member Function Documentation

getFaces()

int ogdf::planar_separators::Ring::getFaces ( ) const

inline

Returns

the number of faces inside this ring

Definition at line 381 of file SeparatorHarPeled.h.

getSectionInSeparator()

List<adjEntry> ogdf::planar_separators::Ring::getSectionInSeparator ( bool  firstSection ) const

inline

Returns a section of this ring, either the first one from in to out, or the second one from out to in.

Parameters

firstSection

whether to return the first (true) or second (false) section

Returns

a ring section

Definition at line 394 of file SeparatorHarPeled.h.

getSize()

int ogdf::planar_separators::Ring::getSize ( ) const

inline

Returns

size (=number of nodes) of this ring

Definition at line 386 of file SeparatorHarPeled.h.

Member Data Documentation

entries

List<adjEntry> ogdf::planar_separators::Ring::entries

Definition at line 300 of file SeparatorHarPeled.h.

faces

int ogdf::planar_separators::Ring::faces

Definition at line 306 of file SeparatorHarPeled.h.

in

node ogdf::planar_separators::Ring::in

Crossing points with the main separator S: in is where S enters, out is where S leaves.

Definition at line 303 of file SeparatorHarPeled.h.

isDegenerate

bool ogdf::planar_separators::Ring::isDegenerate = false

A degenerate ring contains only one node.

Definition at line 309 of file SeparatorHarPeled.h.

nodes

List<node> ogdf::planar_separators::Ring::nodes

Nodes and adjEntries that form the border of the ring.

Definition at line 299 of file SeparatorHarPeled.h.

out

node ogdf::planar_separators::Ring::out

Definition at line 304 of file SeparatorHarPeled.h.

---

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

• include/ogdf/graphalg/SeparatorHarPeled.h