ClusterGraph.h File Reference

Derived class of GraphObserver providing additional functionality to handle clustered graphs. More...

#include <ogdf/basic/NodeArray.h>
#include <ogdf/basic/Stack.h>
#include <ogdf/basic/GraphObserver.h>

Go to the source code of this file.

Classes
class	ogdf::ClusterElement
	Representation of clusters in a clustered graph. More...
class	ogdf::ClusterGraph
	Representation of clustered graphs. More...
Namespaces
namespace	ogdf
	The namespace for all OGDF objects.
Defines
#define	forall_cluster_adj(adj, c)
#define	forall_cluster_rev_adj(adj, c)
#define	forall_cluster_adj_edges(e, c)
#define	forall_clusters(c, C)   for((c)=(C).firstCluster(); (c); (c)=(c)->succ())
	Iteration over all clusters c of cluster graph C.
#define	forall_postOrderClusters(c, C)   for((c)=(C).firstPostOrderCluster(); (c); (c)=(c)->pSucc())
	Iteration over all clusters c of cluster graph C (in postorder).
Typedefs
typedef ClusterElement *	ogdf::cluster
	The type of clusters.
Functions
bool	ogdf::test_forall_adj_entries_of_cluster (ListIterator< adjEntry > &it, adjEntry &adj)
bool	ogdf::test_forall_adj_edges_of_cluster (ListIterator< adjEntry > &it, edge &e)
bool	ogdf::test_forall_adj_edges_of_cluster (adjEntry &adj, edge &e)
ostream &	ogdf::operator<< (ostream &os, ogdf::cluster c)

---

Detailed Description

Derived class of GraphObserver providing additional functionality to handle clustered graphs.

Author:

Sebastian Leipert, Karsten Klein

License:

This file is part of the Open Graph Drawing Framework (OGDF).

Copyright (C). All rights reserved. See README.txt in the root directory of the OGDF installation for details.

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 and appearing in the files LICENSE_GPL_v2.txt and LICENSE_GPL_v3.txt included in the packaging of this file.

In addition, as a special exception, you have permission to link this software with the libraries of the COIN-OR Osi project (http://www.coin-or.org/projects/Osi.xml), all libraries required by Osi, and all LP-solver libraries directly supported by the COIN-OR Osi project, and distribute executables, as long as you follow the requirements of the GNU General Public License in regard to all of the software in the executable aside from these third-party libraries.

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.

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 also:

http://www.gnu.org/copyleft/gpl.html

Definition in file ClusterGraph.h.

---

Define Documentation

#define forall_cluster_adj	(		adj,
			c
	)

Value:

for(ogdf::ListIterator<adjEntry> ogdf_loop_var=(c)->firstAdj();\
    ogdf::test_forall_adj_entries_of_cluster(ogdf_loop_var,(adj));\
    ogdf_loop_var=ogdf_loop_var.succ())

Definition at line 205 of file ClusterGraph.h.

#define forall_cluster_adj_edges	(		e,
			c
	)

Value:

for(ogdf::ListIterator<adjEntry> ogdf_loop_var=(c)->firstAdj();\
    ogdf::test_forall_adj_edges_of_cluster(ogdf_loop_var,(e));\
    ogdf_loop_var=ogdf_loop_var.succ())

Definition at line 215 of file ClusterGraph.h.

#define forall_cluster_rev_adj	(		adj,
			c
	)

Value:

for(ogdf::ListIterator<adjEntry> ogdf_loop_var=(c)->lastAdj();\
    ogdf::test_forall_adj_entries_of_cluster(ogdf_loop_var,(adj));\
    ogdf_loop_var=ogdf_loop_var.pred())

Definition at line 210 of file ClusterGraph.h.

#define forall_clusters	(		c,
			C
	)			for((c)=(C).firstCluster(); (c); (c)=(c)->succ())

Iteration over all clusters c of cluster graph C.

Definition at line 250 of file ClusterGraph.h.

#define forall_postOrderClusters	(		c,
			C
	)			for((c)=(C).firstPostOrderCluster(); (c); (c)=(c)->pSucc())

Iteration over all clusters c of cluster graph C (in postorder).

Definition at line 252 of file ClusterGraph.h.