ogdf::davidson_harel::PlanarityGrid Class Reference

#include <ogdf/energybased/davidson_harel/PlanarityGrid.h>

Inheritance diagram for ogdf::davidson_harel::PlanarityGrid:

Public Member Functions
	PlanarityGrid (GraphAttributes &AG)
	~PlanarityGrid ()
void	computeEnergy () override
	computes energy for the layout at the beginning of the optimization process
Public Member Functions inherited from ogdf::davidson_harel::EnergyFunction
	EnergyFunction (const string &funcname, GraphAttributes &AG)
	Initializes data dtructures to speed up later computations.
virtual	~EnergyFunction ()
void	candidateTaken ()
	Changes m_currentX and m_currentY by setting the position of m_testNode to m_testX and m_testY. Sets m_energy to m_candidateEnergy. Computes the energy of the layout stored in AG.
double	computeCandidateEnergy (const node v, const DPoint &newPos)
	sets m_testNode, m_testX and m_testY and computes the energy for the new configuration (vertex v moves to newPos)
double	energy () const
string	getName () const
	prints the name of the energy function

Private Member Functions
void	compCandEnergy () override
	computes the energy if m_testNode changes position to m_testX and m_testY, sets the value of m_candidateEnergy.
void	internalCandidateTaken () override
	changes the data of a specific energy function if the candidate was taken

Private Attributes
UniformGrid *	m_candidateGrid
UniformGrid *	m_currentGrid
const GraphAttributes &	m_layout

Additional Inherited Members
Protected Member Functions inherited from ogdf::davidson_harel::EnergyFunction
DPoint	currentPos (const node v) const
	returns the current position of vertex v
node	testNode () const
	returns the vertex that is under consideration in the current step
DPoint	testPos ()
	returns candidate position for the node to be moved
Protected Attributes inherited from ogdf::davidson_harel::EnergyFunction
double	m_candidateEnergy
	the energy of the layout if the candidate layout is chosen
double	m_energy
	energy of the current layout
const Graph &	m_G
	the graph that should be drawn
const string	m_name
	name of the energy function

Detailed Description

Definition at line 44 of file PlanarityGrid.h.

Constructor & Destructor Documentation

PlanarityGrid()

ogdf::davidson_harel::PlanarityGrid::PlanarityGrid ( GraphAttributes &  AG )

explicit

~PlanarityGrid()

ogdf::davidson_harel::PlanarityGrid::~PlanarityGrid

(

)

Member Function Documentation

compCandEnergy()

void ogdf::davidson_harel::PlanarityGrid::compCandEnergy ( )

overrideprivatevirtual

computes the energy if m_testNode changes position to m_testX and m_testY, sets the value of m_candidateEnergy.

Implements ogdf::davidson_harel::EnergyFunction.

computeEnergy()

void ogdf::davidson_harel::PlanarityGrid::computeEnergy ( )

overridevirtual

computes energy for the layout at the beginning of the optimization process

Implements ogdf::davidson_harel::EnergyFunction.

internalCandidateTaken()

void ogdf::davidson_harel::PlanarityGrid::internalCandidateTaken ( )

overrideprivatevirtual

changes the data of a specific energy function if the candidate was taken

Implements ogdf::davidson_harel::EnergyFunction.

Member Data Documentation

m_candidateGrid

UniformGrid* ogdf::davidson_harel::PlanarityGrid::m_candidateGrid

private

Definition at line 62 of file PlanarityGrid.h.

m_currentGrid

UniformGrid* ogdf::davidson_harel::PlanarityGrid::m_currentGrid

private

Definition at line 61 of file PlanarityGrid.h.

m_layout

const GraphAttributes& ogdf::davidson_harel::PlanarityGrid::m_layout

private

Definition at line 60 of file PlanarityGrid.h.

---

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

• include/ogdf/energybased/davidson_harel/PlanarityGrid.h