EnergyFunction.h

Go to the documentation of this file.

/*
 * $Revision: 2299 $
 * 
 * last checkin:
 *   $Author: gutwenger $ 
 *   $Date: 2012-05-07 15:57:08 +0200 (Mon, 07 May 2012) $ 
 ***************************************************************/
 
#ifdef _MSC_VER
#pragma once
#endif

#ifndef OGDF_ENERGY_FUNCTION_H
#define OGDF_ENERGY_FUNCTION_H


#include <ogdf/basic/GraphAttributes.h>


namespace ogdf {


class EnergyFunction {
public:
    EnergyFunction(const String &funcname, GraphAttributes &AG);
    virtual ~EnergyFunction() { }
    
    virtual void computeEnergy()=0;
    double computeCandidateEnergy(
        const node v,
        const DPoint &newPos);
    String getName() const {return m_name;}
    void candidateTaken();
#ifdef OGDF_DEBUG

    void printStatus() const;
#endif
    double energy() const {return m_energy;}
protected:
    const Graph &m_G;
    const String m_name;
    double m_candidateEnergy;
    double m_energy;

    DPoint testPos() {return m_testPos;}
    DPoint currentPos(const node v) const {return DPoint(m_AG.x(v),m_AG.y(v));}
    node testNode() const {return m_testNode;}
    virtual void internalCandidateTaken() = 0;
    virtual void compCandEnergy()=0;
#ifdef OGDF_DEBUG
    virtual void printInternalData() const = 0;
#endif
private:
    EnergyFunction(const EnergyFunction &e):m_G(e.m_G),m_name(e.m_name),m_AG(e.m_AG) {};
    EnergyFunction& operator=(const EnergyFunction &e);
    GraphAttributes& m_AG;  
    node m_testNode;
    DPoint m_testPos;
};

}// end namespace
#endif