ogdf::planar_separators::Cycle::Iterator Class Reference

Special iterator to walk over the inward-pointing edges of the cycle. More...

Public Member Functions
	Iterator (const Cycle *cyc)
	Constructor.
	Iterator (const Cycle *cyc, bool clockwise)
	Constructor.
bool	isOutEdge ()
	Checks whether the current adjEntry is the one that leads up to the root.
adjEntry	operator* () const
Iterator &	operator++ ()
Iterator	operator++ (int)

Private Member Functions
adjEntry	next (adjEntry current) const
	Yields the next adjEntry, given the current one (internal use only).

Private Attributes
const Cycle *	cycle
const bool	isClockwise
adjEntry	m_current

Friends
bool	operator!= (const Iterator &a, const Iterator &b)
bool	operator== (const Iterator &a, const Iterator &b)

Detailed Description

Special iterator to walk over the inward-pointing edges of the cycle.

Definition at line 659 of file PlanarSeparatorModule.h.

Constructor & Destructor Documentation

Iterator() [1/2]

ogdf::planar_separators::Cycle::Iterator::Iterator ( const Cycle *  cyc, bool  clockwise  )

inline

Constructor.

Standard constructor that starts at the first clockwise adjEntry within the cycle.

Parameters

cyc	the cycle to which this iterator belongs
clockwise	whether the cycle is clockwise

Definition at line 700 of file PlanarSeparatorModule.h.

Iterator() [2/2]

ogdf::planar_separators::Cycle::Iterator::Iterator ( const Cycle *  cyc )

inline

Constructor.

Constructs a dead Iterator, as returned by Cycle.end().

Parameters

cyc	the cycle this iterator belongs to

Definition at line 710 of file PlanarSeparatorModule.h.

Member Function Documentation

isOutEdge()

bool ogdf::planar_separators::Cycle::Iterator::isOutEdge ( )

inline

Checks whether the current adjEntry is the one that leads up to the root.

Returns

true if current adjEntry leads to root

Definition at line 716 of file PlanarSeparatorModule.h.

next()

adjEntry ogdf::planar_separators::Cycle::Iterator::next ( adjEntry  current ) const

inlineprivate

Yields the next adjEntry, given the current one (internal use only).

Parameters

current

the current AdjEntry

Returns

the next one

Definition at line 671 of file PlanarSeparatorModule.h.

operator*()

adjEntry ogdf::planar_separators::Cycle::Iterator::operator* ( ) const

inline

Definition at line 721 of file PlanarSeparatorModule.h.

operator++() [1/2]

Iterator & ogdf::planar_separators::Cycle::Iterator::operator++ ( )

inline

Definition at line 723 of file PlanarSeparatorModule.h.

operator++() [2/2]

Iterator ogdf::planar_separators::Cycle::Iterator::operator++ ( int  )

inline

Definition at line 732 of file PlanarSeparatorModule.h.

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const Iterator &  a, const Iterator &  b  )

friend

Definition at line 742 of file PlanarSeparatorModule.h.

operator==

bool operator== ( const Iterator &  a, const Iterator &  b  )

friend

Definition at line 738 of file PlanarSeparatorModule.h.

Member Data Documentation

cycle

const Cycle* ogdf::planar_separators::Cycle::Iterator::cycle

private

Definition at line 661 of file PlanarSeparatorModule.h.

isClockwise

const bool ogdf::planar_separators::Cycle::Iterator::isClockwise

private

Definition at line 663 of file PlanarSeparatorModule.h.

m_current

adjEntry ogdf::planar_separators::Cycle::Iterator::m_current

private

Definition at line 662 of file PlanarSeparatorModule.h.

---

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

• include/ogdf/graphalg/PlanarSeparatorModule.h