Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::davidson_harel::Overlap Class Reference

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

+ Inheritance diagram for ogdf::davidson_harel::Overlap:

Public Member Functions

 Overlap (GraphAttributes &AG)
 
 ~Overlap ()
 
- Public Member Functions inherited from ogdf::davidson_harel::NodePairEnergy
 NodePairEnergy (const string energyname, GraphAttributes &AG)
 
virtual ~NodePairEnergy ()
 
void computeEnergy () override
 computes energy for the layout at the beginning of the optimization process More...
 
- Public Member Functions inherited from ogdf::davidson_harel::EnergyFunction
 EnergyFunction (const string &funcname, GraphAttributes &AG)
 Initializes data dtructures to speed up later computations. More...
 
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. More...
 
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) More...
 
double energy () const
 
string getName () const
 prints the name of the energy function More...
 
void printStatus () const
 prints status information for debugging More...
 

Private Member Functions

double computeCoordEnergy (node, node, const DPoint &, const DPoint &) const override
 Computes the energy stored by a pair of vertices at the given positions. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ogdf::davidson_harel::NodePairEnergy
bool adjacent (const node v, const node w) const
 returns true in constant time if two vertices are adjacent. More...
 
int nodeNum (node v) const
 Returns the internal number given to each vertex. More...
 
virtual void printInternalData () const override
 
const DIntersectableRectshape (const node v) const
 Returns the shape of a vertex v as a DIntersectableRect. More...
 
- Protected Member Functions inherited from ogdf::davidson_harel::EnergyFunction
DPoint currentPos (const node v) const
 returns the current position of vertex v More...
 
node testNode () const
 returns the vertex that is under consideration in the current step More...
 
DPoint testPos ()
 returns candidate position for the node to be moved More...
 
- Protected Attributes inherited from ogdf::davidson_harel::EnergyFunction
double m_candidateEnergy
 the energy of the layout if the candidate layout is chosen More...
 
double m_energy
 energy of the current layout More...
 
const Graphm_G
 the graph that should be drawn More...
 
const string m_name
 name of the energy function More...
 

Detailed Description

Definition at line 45 of file Overlap.h.

Constructor & Destructor Documentation

◆ Overlap()

ogdf::davidson_harel::Overlap::Overlap ( GraphAttributes AG)
explicit

◆ ~Overlap()

ogdf::davidson_harel::Overlap::~Overlap ( )
inline

Definition at line 50 of file Overlap.h.

Member Function Documentation

◆ computeCoordEnergy()

double ogdf::davidson_harel::Overlap::computeCoordEnergy ( node  ,
node  ,
const DPoint ,
const DPoint  
) const
overrideprivatevirtual

Computes the energy stored by a pair of vertices at the given positions.

Implements ogdf::davidson_harel::NodePairEnergy.


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