FlowCompaction.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_FLOW_COMPACTION_H
#define OGDF_FLOW_COMPACTION_H


#include <ogdf/orthogonal/OrthoRep.h>
#include <ogdf/planarity/PlanRep.h>
#include <ogdf/internal/orthogonal/RoutingChannel.h>
#include <ogdf/orthogonal/MinimumEdgeDistances.h>
#include <ogdf/basic/GridLayoutMapped.h>


namespace ogdf {

    template<class ATYPE> class CompactionConstraintGraph;
    class OGDF_EXPORT Layout;


class OGDF_EXPORT FlowCompaction
{
public:
    FlowCompaction(int maxImprovementSteps = 0,
        int costGen = 1, 
        int costAssoc = 1);

    void constructiveHeuristics(
        PlanRep &PG,
        OrthoRep &OR,
        const RoutingChannel<int> &rc,
        GridLayoutMapped &drawing);


    void improvementHeuristics(
        PlanRep &PG,
        OrthoRep &OR,
        const RoutingChannel<int> &rc,
        GridLayoutMapped &drawing);

    void improvementHeuristics(
        PlanRep &PG,
        OrthoRep &OR,
        //const 
        MinimumEdgeDistances<int> &minDist,
        GridLayoutMapped &drawing,
        int originalSeparation //the input value before multiplication test for compaction improvement
        );

    //
    // options

    void maxImprovementSteps(int maxSteps) {
        m_maxImprovementSteps = maxSteps;
    }

    int maxImprovementSteps() const {
        return m_maxImprovementSteps;
    }

    void costGen(int c) {
        m_costGen = c;
    }

    int costGen() const {
        return m_costGen;
    }

    void costAssoc(int c) {
        m_costAssoc = c;
    }

    int costAssoc() const {
        return m_costAssoc;
    }

    void scalingSteps(int sc) {m_scalingSteps = sc;}

    void align(bool b) {m_align = b;}


private:
    void computeCoords(
        CompactionConstraintGraph<int> &D,
        NodeArray<int> &pos,
        bool fixZeroLength = false,
        bool fixVertexSize = false,
        bool improvementHeuristics = false,
        bool onlyGen = false);
    void dfsAssignPos(
        NodeArray<bool> &visited,
        NodeArray<int> &pos,
        node v,
        int x);

    // options
    int m_maxImprovementSteps; 
    int m_costGen;   
    int m_costAssoc; 
    bool m_cageExpense; 
    //int m_costCage; //!< preliminary: Carsten uses 10
    int m_numGenSteps; 
    int m_scalingSteps; 
    bool m_align; 


    EdgeArray<edge> m_dualEdge;
    EdgeArray<int>  m_flow;
};


} // end namespace ogdf


#endif