The interface for energy functions for the Davidson Harel graph drawing method.
More...
#include <ogdf/energybased/davidson_harel/EnergyFunction.h>
|
| | 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)
|
| |
| virtual void | computeEnergy ()=0 |
| | computes energy for the layout at the beginning of the optimization process
|
| |
| double | energy () const |
| |
| string | getName () const |
| | prints the name of the energy function
|
| |
| void | printStatus () const |
| | prints status information for debugging
|
| |
|
| virtual void | compCandEnergy ()=0 |
| | computes the energy if m_testNode changes position to m_testX and m_testY, sets the value of m_candidateEnergy.
|
| |
| DPoint | currentPos (const node v) const |
| | returns the current position of vertex v
|
| |
| virtual void | internalCandidateTaken ()=0 |
| | changes the data of a specific energy function if the candidate was taken
|
| |
| virtual void | printInternalData () const =0 |
| |
| 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
|
| |
|
| 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
|
| |
|
| GraphAttributes & | m_AG |
| | This stores the graph with its graphical attributes and the current positions for the vertices.
|
| |
| node | m_testNode |
| | The node that changed position in the candidate.
|
| |
| DPoint | m_testPos |
| | New candidate positions for m_testNode.
|
| |
The interface for energy functions for the Davidson Harel graph drawing method.
It is used in the class DavidsonHarel.
Definition at line 52 of file EnergyFunction.h.
◆ EnergyFunction() [1/2]
| ogdf::davidson_harel::EnergyFunction::EnergyFunction |
( |
const string & |
funcname, |
|
|
GraphAttributes & |
AG |
|
) |
| |
Initializes data dtructures to speed up later computations.
◆ ~EnergyFunction()
| virtual ogdf::davidson_harel::EnergyFunction::~EnergyFunction |
( |
| ) |
|
|
inlinevirtual |
◆ EnergyFunction() [2/2]
| ogdf::davidson_harel::EnergyFunction::EnergyFunction |
( |
const EnergyFunction & |
e | ) |
|
|
inlineprivate |
the copy constructor is fake and can not be used.
Definition at line 107 of file EnergyFunction.h.
◆ candidateTaken()
| void ogdf::davidson_harel::EnergyFunction::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.
◆ compCandEnergy()
| virtual void ogdf::davidson_harel::EnergyFunction::compCandEnergy |
( |
| ) |
|
|
protectedpure virtual |
◆ computeCandidateEnergy()
| double ogdf::davidson_harel::EnergyFunction::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)
◆ computeEnergy()
| virtual void ogdf::davidson_harel::EnergyFunction::computeEnergy |
( |
| ) |
|
|
pure virtual |
◆ currentPos()
| DPoint ogdf::davidson_harel::EnergyFunction::currentPos |
( |
const node |
v | ) |
const |
|
inlineprotected |
◆ energy()
| double ogdf::davidson_harel::EnergyFunction::energy |
( |
| ) |
const |
|
inline |
◆ getName()
| string ogdf::davidson_harel::EnergyFunction::getName |
( |
| ) |
const |
|
inline |
◆ internalCandidateTaken()
| virtual void ogdf::davidson_harel::EnergyFunction::internalCandidateTaken |
( |
| ) |
|
|
protectedpure virtual |
◆ operator=()
the assignment operator is fake and can not be used.
◆ printInternalData()
| virtual void ogdf::davidson_harel::EnergyFunction::printInternalData |
( |
| ) |
const |
|
protectedpure virtual |
◆ printStatus()
| void ogdf::davidson_harel::EnergyFunction::printStatus |
( |
| ) |
const |
prints status information for debugging
◆ testNode()
| node ogdf::davidson_harel::EnergyFunction::testNode |
( |
| ) |
const |
|
inlineprotected |
returns the vertex that is under consideration in the current step
Definition at line 93 of file EnergyFunction.h.
◆ testPos()
| DPoint ogdf::davidson_harel::EnergyFunction::testPos |
( |
| ) |
|
|
inlineprotected |
returns candidate position for the node to be moved
Definition at line 87 of file EnergyFunction.h.
◆ m_AG
This stores the graph with its graphical attributes and the current positions for the vertices.
Definition at line 112 of file EnergyFunction.h.
◆ m_candidateEnergy
| double ogdf::davidson_harel::EnergyFunction::m_candidateEnergy |
|
protected |
the energy of the layout if the candidate layout is chosen
Definition at line 83 of file EnergyFunction.h.
◆ m_energy
| double ogdf::davidson_harel::EnergyFunction::m_energy |
|
protected |
◆ m_G
| const Graph& ogdf::davidson_harel::EnergyFunction::m_G |
|
protected |
◆ m_name
| const string ogdf::davidson_harel::EnergyFunction::m_name |
|
protected |
◆ m_testNode
| node ogdf::davidson_harel::EnergyFunction::m_testNode |
|
private |
The node that changed position in the candidate.
Definition at line 113 of file EnergyFunction.h.
◆ m_testPos
| DPoint ogdf::davidson_harel::EnergyFunction::m_testPos |
|
private |
The documentation for this class was generated from the following file:
Inheritance diagram for ogdf::davidson_harel::EnergyFunction:
