CombinatorialEmbedding.h File Reference

Declaration of CombinatorialEmbedding and face. More...

#include <ogdf/basic/AdjEntryArray.h>

Go to the source code of this file.

Classes
class	ogdf::CombinatorialEmbedding
	Combinatorial embeddings of planar graphs with modification functionality. More...
class	ogdf::ConstCombinatorialEmbedding
	Combinatorial embeddings of planar graphs. More...
class	ogdf::FaceElement
	Faces in a combinatorial embedding. More...

Namespaces
namespace	ogdf
	The namespace for all OGDF objects.

Macros
#define	forall_face_adj(adj, f)   for((adj)=(f)->firstAdj(); (adj); (adj)=(f)->nextFaceEdge(adj))
	Iteration over all adjacency entries adj of the face f.
#define	forall_faces(f, E)   for((f)=(E).firstFace(); (f); (f)=(f)->succ())
	Iteration over all faces f of the combinatorial embedding E.
#define	forall_rev_faces(f, E)   for((f)=(E).lastFace(); (f); (f)=(f)->pred())
	Iteration over all faces f of the combinatorial embedding E (in reverse order).
#define	OGDF_COMBINATORIAL_EMBEDDING_H

Typedefs
typedef FaceElement *	ogdf::face

---

Detailed Description

Declaration of CombinatorialEmbedding and face.

Enriches graph by the notion of faces

Author:

Carsten Gutwenger

License:

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

Copyright (C)
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; see the file LICENSE.txt included in the packaging of this file for details.

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 CombinatorialEmbedding.h.

---

Macro Definition Documentation

#define forall_face_adj	(		adj,
			f
	)		for((adj)=(f)->firstAdj(); (adj); (adj)=(f)->nextFaceEdge(adj))

Iteration over all adjacency entries adj of the face f.

A faster version for this iteration demonstrates the following code snippet:

   adjEntry adj1 = f->firstAdj(), adj = adj1;
   do {
       ...
       adj = adj->faceCycleSucc();
   } while (adj != adj1);

Definition at line 478 of file CombinatorialEmbedding.h.

#define forall_faces	(		f,
			E
	)		for((f)=(E).firstFace(); (f); (f)=(f)->succ())

Iteration over all faces f of the combinatorial embedding E.

Definition at line 460 of file CombinatorialEmbedding.h.

#define forall_rev_faces	(		f,
			E
	)		for((f)=(E).lastFace(); (f); (f)=(f)->pred())

Iteration over all faces f of the combinatorial embedding E (in reverse order).

Definition at line 464 of file CombinatorialEmbedding.h.

#define OGDF_COMBINATORIAL_EMBEDDING_H

Definition at line 50 of file CombinatorialEmbedding.h.