1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
|
/*
* $Revision: 2523 $
*
* last checkin:
* $Author: gutwenger $
* $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
***************************************************************/
/** \file
* \brief Declaration of class DynamicSkeleton.
*
* \author Jan Papenfuß
*
* \par License:
* This file is part of the Open Graph Drawing Framework (OGDF).
*
* \par
* Copyright (C)<br>
* See README.txt in the root directory of the OGDF installation for details.
*
* \par
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* Version 2 or 3 as published by the Free Software Foundation;
* see the file LICENSE.txt included in the packaging of this file
* for details.
*
* \par
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* \par
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* \see http://www.gnu.org/copyleft/gpl.html
***************************************************************/
#ifdef _MSC_VER
#pragma once
#endif
#ifndef OGDF_DYNAMIC_SKELETON_H
#define OGDF_DYNAMIC_SKELETON_H
#include <ogdf/decomposition/Skeleton.h>
namespace ogdf {
class DynamicSPQRTree;
//! %Skeleton graphs of nodes in a dynamic SPQR-tree.
/**
* The class DynamicSkeleton maintains the skeleton \a S of a node \a vT in a dynamic SPQR-tree
* \a T. We call \a T the owner tree of \a S and \a vT the corresponding tree node. Let
* \a G be the original graph of \a T.
*
* \a S consists of an undirected multi-graph \a M. If the owner tree of \a S is
* a PlanarSPQRTree, then \a M represents a combinatorial embedding.
* The vertices in \a M correspond to vertices in \a G. The edges in \a M are of
* two types: Real edges correspond to edges in \a G and virtual edges correspond
* to tree-edges in \a T having \a vT as an endpoint.
*
* Let \a e in \a M be a virtual edge and \a eT be the corresponding tree-edge.
* Then there exists exactly one edge \a e' in another skeleton \a S' of \a T that
* corresponds to \a eT as well. We call \a e' the twin edge of \a e.
*/
class OGDF_EXPORT DynamicSkeleton : public Skeleton
{
friend class DynamicSPQRTree;
public:
// constructor
//! Creates a skeleton \a S with owner tree \a T and corresponding node \a vT.
/**
* \pre \a vT is a node in \a T
*
* \remarks Skeletons are created by the constructor of DynamicSPQRTree
* and can be accessed with the skeleton() function of DynamicSPQRTree.
*/
DynamicSkeleton(const DynamicSPQRTree *T, node vT);
// destructor
~DynamicSkeleton() { }
//! Returns the owner tree \a T.
const SPQRTree &owner() const;
//! Returns the vertex in the original graph \a G that corresponds to \a v.
/**
* \pre \a v is a node in \a M.
*/
node original (node v) const;
//! Returns the real edge that corresponds to skeleton edge \a e
/**
* If \a e is virtual edge, then 0 is returned.
* \pre \a e is an edge in \a M
*/
edge realEdge (edge e) const;
//! Returns true iff \a e is a virtual edge.
/**
* \pre \a e is an edge in \a M
*/
bool isVirtual (edge e) const {
return !realEdge(e);
}
//! Returns the twin edge of skeleton edge \a e.
/**
* If \a e is not a virtual edge, then 0 is returned.
* \pre \a e is an edge in \a M
*/
edge twinEdge (edge e) const;
//! Returns the tree node in T containing the twin edge of skeleton edge \a e.
/**
* If \a e is not a virtual edge, then 0 is returned.
* \pre \a e is an edge in \a M
*/
node twinTreeNode (edge e) const;
OGDF_NEW_DELETE
protected:
const DynamicSPQRTree *m_owner; //!< owner tree
NodeArray<node> m_origNode; //!< corresp. original node
EdgeArray<edge> m_origEdge; //!< corresp. original edge
};
} // end namespace ogdf
#endif
|