NodePairEnergy.h

Go to the documentation of this file.

 
#pragma once
 
#include <ogdf/basic/AdjacencyOracle.h>
#include <ogdf/basic/Array2D.h>
#include <ogdf/basic/Graph.h>
#include <ogdf/basic/List.h>
#include <ogdf/basic/basic.h>
#include <ogdf/basic/geometry.h>
#include <ogdf/energybased/davidson_harel/EnergyFunction.h>
 
#include <string>
 
namespace ogdf {
class GraphAttributes;
 
namespace davidson_harel {
 
class NodePairEnergy : public EnergyFunction {
public:
    //Initializes data dtructures to speed up later computations
    NodePairEnergy(const string energyname, GraphAttributes& AG);
 
    virtual ~NodePairEnergy() {
        delete m_nodeNums;
        delete m_pairEnergy;
    }
 
    //computes the energy of the initial layout
    void computeEnergy() override;
 
protected:
    virtual double computeCoordEnergy(node, node, const DPoint&, const DPoint&) const = 0;
 
    int nodeNum(node v) const { return (*m_nodeNums)[v]; }
 
    bool adjacent(const node v, const node w) const { return m_adjacentOracle.adjacent(v, w); }
 
    const DIntersectableRect& shape(const node v) const { return m_shape[v]; }
 
#ifdef OGDF_DEBUG
    virtual void printInternalData() const override;
#endif
 
private:
    NodeArray<int>* m_nodeNums; //stores internal number of each vertex
    Array2D<double>* m_pairEnergy; //stores for each pair of vertices its energy
    NodeArray<double> m_candPairEnergy; //stores for each vertex its pair energy with
    //respect to the vertex to be moved if its new position is chosen
    NodeArray<DIntersectableRect> m_shape; //stores the shape of each vertex as
    //a DIntersectableRect
    List<node> m_nonIsolated; //list of vertices with degree greater zero
    const AdjacencyOracle m_adjacentOracle; //structure for constant time adjacency queries
 
    //function computes energy stored in a certain pair of vertices
    double computePairEnergy(const node v, const node w) const;
 
    //computes energy of whole layout if new position of the candidate vertex is chosen
    void compCandEnergy() override;
 
    //If a candidate change is chosen as the new position, this function sets the
    //internal data accordingly
    void internalCandidateTaken() override;
};
 
}
}