ext/OGDF/ogdf/simultaneous/TwoLayerCrossMinSimDraw.h

   1 /*
   2  * $Revision: 2583 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-12 01:02:21 +0200 (Do, 12. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of interface for two-layer crossing
  11  *        minimization algorithms for Simultaneous Drawing.
  12  *
  13  * \author Michael Schulz
  14  *
  15  * \par License:
  16  * This file is part of the Open Graph Drawing Framework (OGDF).
  17  *
  18  * \par
  19  * Copyright (C)<br>
  20  * See README.txt in the root directory of the OGDF installation for details.
  21  *
  22  * \par
  23  * This program is free software; you can redistribute it and/or
  24  * modify it under the terms of the GNU General Public License
  25  * Version 2 or 3 as published by the Free Software Foundation;
  26  * see the file LICENSE.txt included in the packaging of this file
  27  * for details.
  28  *
  29  * \par
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * \par
  36  * You should have received a copy of the GNU General Public
  37  * License along with this program; if not, write to the Free
  38  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  39  * Boston, MA 02110-1301, USA.
  40  *
  41  * \see  http://www.gnu.org/copyleft/gpl.html
  42  ***************************************************************/
  43
  44
  45 #ifdef _MSC_VER
  46 #pragma once
  47 #endif
  48
  49 #ifndef OGDF_TWO_LAYER_CROSS_MIN_SIMDRAW_H
  50 #define OGDF_TWO_LAYER_CROSS_MIN_SIMDRAW_H
  51
  52
  53 #include <ogdf/module/TwoLayerCrossMin.h>
  54
  55
  56 namespace ogdf {
  57
  58
  59         class OGDF_EXPORT TwoLayerCrossMinSimDraw : public TwoLayerCrossMin
  60         {
  61         public:
  62                 //! Initializes a two-layer crossing minimization module.
  63                 TwoLayerCrossMinSimDraw() : TwoLayerCrossMin() { }
  64
  65                 /**
  66                 * \brief Performs crossing minimization for level \a L.
  67                 *
  68                 * @param L is the level in the hierarchy on which nodes are permuted; the
  69                 *        neighbor level (fixed level) is determined by the hierarchy.
  70                 * @param esg points to an edge array which specifies to which subgraphs
  71                 *        an edge belongs; there are up to 32 possible subgraphs each of which
  72                 *        is represented by a bit of an <code>unsigned int</code>.
  73                 */
  74                 virtual void call(Level &L, const EdgeArray<unsigned int> *esg) = 0;
  75         };
  76
  77
  78 } // end namespace ogdf
  79
  80
  81 #endif