ogdf::planar_separators::BFSTree Class Reference

Abstract description of a Breadth First Search tree. More...

#include <ogdf/graphalg/PlanarSeparatorModule.h>

Inheritance diagram for ogdf::planar_separators::BFSTree:

Public Member Functions
virtual	~BFSTree ()=default
virtual adjEntry	getAdjToParent (node n) const =0
	Returns the adjEntry that leads up to the parent of n. More...
virtual List< node >	getChildrenOfNode (node n) const =0
	Returns all (immediate) children of a node. More...
virtual int	getDescendantsOfNode (node n) const =0
	Returns the total number of children, grandchildren etc. More...
virtual GraphCopy *	getGraph () const =0
	Allows access to a copy of the graph. More...
virtual int	getGraphSize () const =0
	Gets the number of nodes of the graph. More...
virtual int	getLevelOfNode (node n) const =0
	Returns the level (=depth in the tree) for a node. More...
virtual node	getParentOfNode (node n) const =0
	Returns the node that is the parent of n in the tree. More...
virtual node	getRoot () const =0
	Gets the current root node of the tree. More...
virtual bool	isInTree (edge e) const =0
	Checks if an edge is a tree-edge. More...

Detailed Description

Abstract description of a Breadth First Search tree.

Definition at line 58 of file PlanarSeparatorModule.h.

Constructor & Destructor Documentation

~BFSTree()

virtual ogdf::planar_separators::BFSTree::~BFSTree ( )

virtualdefault

Member Function Documentation

getAdjToParent()

virtual adjEntry ogdf::planar_separators::BFSTree::getAdjToParent ( node  n ) const

pure virtual

Returns the adjEntry that leads up to the parent of n.

Parameters

n

the node

Returns

the adjEntry to parent

Implemented in ogdf::planar_separators::ArrayBFSTree.

getChildrenOfNode()

virtual List<node> ogdf::planar_separators::BFSTree::getChildrenOfNode ( node  n ) const

pure virtual

Returns all (immediate) children of a node.

Parameters

n

the node

Returns

a list of all children of n

Implemented in ogdf::planar_separators::ArrayBFSTree.

getDescendantsOfNode()

virtual int ogdf::planar_separators::BFSTree::getDescendantsOfNode ( node  n ) const

pure virtual

Returns the total number of children, grandchildren etc.

in the subtree rooted at n.

Parameters

n

the node

Returns

the total number of children

Implemented in ogdf::planar_separators::ArrayBFSTree.

getGraph()

virtual GraphCopy* ogdf::planar_separators::BFSTree::getGraph ( ) const

pure virtual

Allows access to a copy of the graph.

Returns

the GraphCopy

Implemented in ogdf::planar_separators::ArrayBFSTree.

getGraphSize()

virtual int ogdf::planar_separators::BFSTree::getGraphSize ( ) const

pure virtual

Gets the number of nodes of the graph.

Returns

the graph size

Implemented in ogdf::planar_separators::ArrayBFSTree.

getLevelOfNode()

virtual int ogdf::planar_separators::BFSTree::getLevelOfNode ( node  n ) const

pure virtual

Returns the level (=depth in the tree) for a node.

Parameters

n

the node

Returns

the depth of n in the tree

Implemented in ogdf::planar_separators::ArrayBFSTree.

getParentOfNode()

virtual node ogdf::planar_separators::BFSTree::getParentOfNode ( node  n ) const

pure virtual

Returns the node that is the parent of n in the tree.

Parameters

n	the child node

Returns

the parent node

Implemented in ogdf::planar_separators::ArrayBFSTree.

getRoot()

virtual node ogdf::planar_separators::BFSTree::getRoot ( ) const

pure virtual

Gets the current root node of the tree.

Returns

the root node

Implemented in ogdf::planar_separators::ArrayBFSTree.

isInTree()

virtual bool ogdf::planar_separators::BFSTree::isInTree ( edge  e ) const

pure virtual

Checks if an edge is a tree-edge.

Parameters

e	the edge to be checked

Returns

if the edge is in the tree

Implemented in ogdf::planar_separators::ArrayBFSTree.

---

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

• include/ogdf/graphalg/PlanarSeparatorModule.h