#include <ogdf/energybased/dtree/DTreeEmbedder.h>

Classes
struct	NodeInfo
	node state More...

Public Member Functions
	DTreeEmbedder (const Graph &graph)
	constructor with a given graph, allocates memory and does initialization

virtual	~DTreeEmbedder ()
	destructor

void	centerNodesAt (double centerBBox[Dim])
	computes the bounding box and all nodes are translated such that bbox center is at centerBBox

template<typename AttrForceFunc , bool UseForcePrime>
void	computeEdgeForces (AttrForceFunc attrForceFunc)
	computes the edge forces for one iteration

template<typename ForceFunc , bool UseForcePrime>
void	computeRepForces (ForceFunc forceFunc)
	computes the repulsive forces

template<typename ForceFunc , bool UseForcePrime>
void	computeRepForcesApprox (ForceFunc forceFunc)
	uses the tree code to approximate the repulsive forces in O(nlogn) for one iteration

template<typename ForceFunc , bool UseForcePrime>
void	computeRepForcesExact (ForceFunc forceFunc)
	computes the repulsive forces for one iteration in O(n^2)

template<typename RepForceFunc , typename AttrForceFunc >
void	doIterationsNewton (int numIterations, double epsilon, RepForceFunc repForceFunc, AttrForceFunc attrForceFunc)

template<typename RepForceFunc , typename AttrForceFunc >
void	doIterationsStandard (int numIterations, double epsilon, RepForceFunc repForceFunc, AttrForceFunc attrForceFunc)

template<typename RepForceFunc , typename AttrForceFunc , bool UseForcePrime>
void	doIterationsTempl (int numIterations, double epsilon, RepForceFunc repForceFunc, AttrForceFunc attrForceFunc)
	does multiple iterations using the given repulsive force function

double	edgeWeight (edge e) const
	returns the edge weight

const Graph &	graph () const
	returns the graph

double	mass (node v) const
	returns the mass of node v

double	moveNodes (double timeStep)
	moves the nodes by the computed force vector

double	moveNodesByForcePrime ()

double	position (node v, int d) const
	returns the d-th coordinate of node v

void	resetForces ()
	sets the forces of all nodes to 0

void	scaleNodes (double scaleFactor)
	changes the position of nodes according to a given scale factor

void	setEdgeWeight (edge e, double weight)
	sets the weight of an edge

void	setMass (node v, double mass)
	sets the mass of a node v

void	setPosition (node v, int d, double coord)
	sets the d-th coordinate of node v to coord

Private Attributes
double	m_defaultTimeStep

EdgeArray< double >	m_edgeWeight
	the weight of the edges

const Graph &	m_graph
	the graph

int	m_maxNumNodesExactRepForces

NodeArray< NodeInfo >	m_nodeInfo
	node states of all nodes

DTreeForce< Dim > *	m_pTreeForce
	the tree force approx

Detailed Description

template<int Dim>
class ogdf::energybased::dtree::DTreeEmbedder< Dim >

Definition at line 44 of file DTreeEmbedder.h.

Constructor & Destructor Documentation

◆ DTreeEmbedder()

template<int Dim>

ogdf::energybased::dtree::DTreeEmbedder< Dim >::DTreeEmbedder ( const Graph & graph )

explicit

constructor with a given graph, allocates memory and does initialization

Definition at line 179 of file DTreeEmbedder.h.

◆ ~DTreeEmbedder()

template<int Dim>

ogdf::energybased::dtree::DTreeEmbedder< Dim >::~DTreeEmbedder ( )

virtual

destructor

Definition at line 192 of file DTreeEmbedder.h.

Member Function Documentation

◆ centerNodesAt()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::centerNodesAt ( double centerBBox[Dim] )

computes the bounding box and all nodes are translated such that bbox center is at centerBBox

Definition at line 715 of file DTreeEmbedder.h.

◆ computeEdgeForces()

template<int Dim>

template<typename AttrForceFunc , bool UseForcePrime>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::computeEdgeForces ( AttrForceFunc attrForceFunc )

computes the edge forces for one iteration

Definition at line 351 of file DTreeEmbedder.h.

◆ computeRepForces()

template<int Dim>

template<typename ForceFunc , bool UseForcePrime>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::computeRepForces ( ForceFunc forceFunc )

computes the repulsive forces

Definition at line 328 of file DTreeEmbedder.h.

◆ computeRepForcesApprox()

template<int Dim>

template<typename ForceFunc , bool UseForcePrime>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::computeRepForcesApprox ( ForceFunc forceFunc )

uses the tree code to approximate the repulsive forces in O(nlogn) for one iteration

Definition at line 255 of file DTreeEmbedder.h.

◆ computeRepForcesExact()

template<int Dim>

template<typename ForceFunc , bool UseForcePrime>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::computeRepForcesExact ( ForceFunc forceFunc )

computes the repulsive forces for one iteration in O(n^2)

Definition at line 198 of file DTreeEmbedder.h.

◆ doIterationsNewton()

template<int Dim>

template<typename RepForceFunc , typename AttrForceFunc >

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::doIterationsNewton	(	int	numIterations,
		double	epsilon,
		RepForceFunc	repForceFunc,
		AttrForceFunc	attrForceFunc
	)

Definition at line 708 of file DTreeEmbedder.h.

◆ doIterationsStandard()

template<int Dim>

template<typename RepForceFunc , typename AttrForceFunc >

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::doIterationsStandard	(	int	numIterations,
		double	epsilon,
		RepForceFunc	repForceFunc,
		AttrForceFunc	attrForceFunc
	)

Definition at line 700 of file DTreeEmbedder.h.

◆ doIterationsTempl()

template<int Dim>

template<typename RepForceFunc , typename AttrForceFunc , bool UseForcePrime>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::doIterationsTempl	(	int	numIterations,
		double	epsilon,
		RepForceFunc	repForceFunc,
		AttrForceFunc	attrForceFunc
	)

does multiple iterations using the given repulsive force function

Definition at line 661 of file DTreeEmbedder.h.

◆ edgeWeight()

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::edgeWeight ( edge e ) const

returns the edge weight

Definition at line 784 of file DTreeEmbedder.h.

◆ graph()

template<int Dim>

const Graph & ogdf::energybased::dtree::DTreeEmbedder< Dim >::graph ( ) const

returns the graph

Definition at line 774 of file DTreeEmbedder.h.

◆ mass()

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::mass ( node v ) const

returns the mass of node v

Definition at line 764 of file DTreeEmbedder.h.

◆ moveNodes()

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::moveNodes ( double timeStep )

moves the nodes by the computed force vector

Definition at line 531 of file DTreeEmbedder.h.

◆ moveNodesByForcePrime()

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::moveNodesByForcePrime ( )

Definition at line 507 of file DTreeEmbedder.h.

◆ position()

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::position	(	node	v,
		int	d
	)		const

returns the d-th coordinate of node v

Definition at line 754 of file DTreeEmbedder.h.

◆ resetForces()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::resetForces ( )

sets the forces of all nodes to 0

Definition at line 556 of file DTreeEmbedder.h.

◆ scaleNodes()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::scaleNodes ( double scaleFactor )

changes the position of nodes according to a given scale factor

Definition at line 745 of file DTreeEmbedder.h.

◆ setEdgeWeight()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::setEdgeWeight	(	edge	e,
		double	weight
	)

sets the weight of an edge

Definition at line 779 of file DTreeEmbedder.h.

◆ setMass()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::setMass	(	node	v,
		double	mass
	)

sets the mass of a node v

Definition at line 769 of file DTreeEmbedder.h.

◆ setPosition()

template<int Dim>

void ogdf::energybased::dtree::DTreeEmbedder< Dim >::setPosition	(	node	v,
		int	d,
		double	coord
	)

sets the d-th coordinate of node v to coord

Definition at line 759 of file DTreeEmbedder.h.

Member Data Documentation

◆ m_defaultTimeStep

template<int Dim>

double ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_defaultTimeStep

private

Definition at line 172 of file DTreeEmbedder.h.

◆ m_edgeWeight

template<int Dim>

EdgeArray<double> ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_edgeWeight

private

the weight of the edges

Definition at line 165 of file DTreeEmbedder.h.

◆ m_graph

template<int Dim>

const Graph& ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_graph

private

the graph

Definition at line 159 of file DTreeEmbedder.h.

◆ m_maxNumNodesExactRepForces

template<int Dim>

int ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_maxNumNodesExactRepForces

private

Definition at line 170 of file DTreeEmbedder.h.

◆ m_nodeInfo

template<int Dim>

NodeArray<NodeInfo> ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_nodeInfo

private

node states of all nodes

Definition at line 162 of file DTreeEmbedder.h.

◆ m_pTreeForce

template<int Dim>

DTreeForce<Dim>* ogdf::energybased::dtree::DTreeEmbedder< Dim >::m_pTreeForce

private

the tree force approx

Definition at line 168 of file DTreeEmbedder.h.

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

include/ogdf/energybased/dtree/DTreeEmbedder.h

OpenGraph DrawingFramework

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DTreeEmbedder()

◆ ~DTreeEmbedder()

Member Function Documentation

◆ centerNodesAt()

◆ computeEdgeForces()

◆ computeRepForces()

◆ computeRepForcesApprox()

◆ computeRepForcesExact()

◆ doIterationsNewton()

◆ doIterationsStandard()

◆ doIterationsTempl()

◆ edgeWeight()

◆ graph()

◆ mass()

◆ moveNodes()

◆ moveNodesByForcePrime()

◆ position()

◆ resetForces()

◆ scaleNodes()

◆ setEdgeWeight()

◆ setMass()

◆ setPosition()

Member Data Documentation

◆ m_defaultTimeStep

◆ m_edgeWeight

◆ m_graph

◆ m_maxNumNodesExactRepForces

◆ m_nodeInfo

◆ m_pTreeForce

Open
Graph Drawing
Framework