CGAL 4.10  CGAL and the Boost Graph Library

Many geometric data structures can be interpreted as graphs as they consist of vertices and edges. This is the case for the halfedge data structure, for the polyhedral surface, for the arrangement, and for the 2D triangulation classes. With means of duality one can also interpret faces as vertices and edges between adjacent faces as edges of the dual graph.
The scope of CGAL is geometry and not graph algorithms. Nevertheless, this package provides the necessary classes and functions that enable using the algorithms of the Boost Graph Library [2] (Bgl for short) with CGAL data structures.
Furthermore, this package extends the Bgl by introducing concepts such as HalfedgeGraph
and FaceGraph
allowing to handle halfedges and faces. These concepts reflect the design of the halfedge data structure described in Chapter Halfedge Data Structures, with opposite halfedges, and the circular sequence of halfedges around vertices and around faces.
This chapter is organized as follows. Section A Short Introduction to the Boost Graph Library present the ideas of Bgl in a nutshell. Section Header Files, Namespaces, and Naming Conventions explains where to find header files and the chosen naming conventions, as we blend two different libraries. The four following sections give examples for how the surface mesh, the polyhedron, the arrangement, and the 2D triangulation classes are adapted to Bgl. Finally, Section Extensions of the BGL introduces the HalfedgeGraph
which is an extension to the graph concepts of the Bgl.
The algorithms of Bgl operate on models of the various graph concepts. The traits class boost::graph_traits
enable the algorithms determining the types of vertices and edges (similar to std::iterator_traits
for iterators). Free functions that operate on graphs enable the algorithms to obtain, for example, the source vertex of an edge, or all edges incident to a vertex. The algorithms use property maps to associate information with vertices and edges. The algorithms enable visitors to register callbacks that are called later on during the execution of the algorithms. Finally, the graph algorithms use the named parameter mechanism, which enambles passing the arguments in arbitrary order.
Bgl introduces several graph concepts, which have different sets of characteristics and requirements. For example iterating through all vertices or all edges in a graph, obtaining the outgoing edges of a vertex, or also the ingoing edges, inserting vertices and edges into a graph, and removing vertices and edges from a graph.
An algorithm operating on a graph model determines types with the help of the traits class boost::graph_traits. Such types are the vertex_descriptor
, which is similar to a vertex handle in CGAL data structures, the edge_descriptor
which is similar to the halfedge handle in the halfedge data structure and to the type Edge
in 2D triangulations. There are also iterators, such as the vertex_iterator
, which is similar to a vertex iterator in CGAL data structures, and the out_edge_iterator
, which is similar to the edge circulator; it enables to iterate through the edges incident to a vertex. The iterators are similar and not equivalent, because their value type is a vertex_descriptor
, whereas in CGAL handles, iterators, and circulators all have the same value type, namely the vertex or edge type. Given a graph type G
the definition of a vertex descriptor looks as follows:
The algorithms obtain incidence information with the help of global functions such as:
std::pair<vertex_iterator,vertex_iterator> vertices(const Graph& g);
for obtaining an iterator range providing access to all the vertices, orint num_vertices(const Graph&);
for obtaining the number of vertices of a graph, orvertex_descriptor source(edge_descriptor, const Graph&);
for obtaining the source vertex of an edge.Note, that the way we have written the types is a simplification, that is in reality the signature of the first of the above functions is
Another feature extensively used in Bgl is the property map, which is offered by the Boost Property Map Library. Property maps are a general purpose interface for mapping key objects to corresponding value objects.
Bgl uses property maps to associate information with vertices and edges. This mechanism uses a traits class (boost::property_traits
) and free functions for obtaining (get
) and writing (put
) information in vertices, edges, and also halfedges and faces for models of the CGAL graph concepts. For example, Bgl Dijksta's shortest path algorithm writes the predecessor of each vertex, as well as the distance to the source in such a property map.
Some default property maps are associated with the graph types. They are called internal property maps and can be retrieved using an overload of the function get()
. For example, pm = get(boost::vertex_index, g) returns a property map that associates an index in the range [0, num_vertices(g))
with each vertex of the graph. This reduces the number of parameters to pass. The data itself may be stored in the vertex or the edge, or it may be stored in an external data structure, or it may be computed on the fly. This is an implementation detail of a particular property map.
See also the Chapter CGAL and Boost Property Maps.
Visitors are objects that provide functions that are called at specified event points by the algorithm they visit.
The functions as well as the event points are algorithm specific. Examples of event points in graph algorithms are when a vertex is traversed the first time, or when all outgoing edges of a vertex are traversed.
See also Section Visitor Concepts in the Bgl manual.
The algorithms of Bgl often have many parameters with default values that are appropriate for most cases. In general, when no special treatment is applied, the values of such parameters are passed as a sequence. Deviating from the default for a certain parameter requires the user to explicitly pass values for all preceding parameters. The solution to this problem is to first write a tag and then the parameter, which for Dijkstra's shortest path algorithm might look as follows:
In the Bgl manual this is called named parameters. The named parameters in the example use the tags predecessor_map
and distance_map
and they are concatenated with the dot operator.
Partial specializations of the boost::graph_traits<Graph>
for the CGAL package PACKAGE
are in the namespace boost
and in the header file CGAL/boost/graph/graph_traits_PACKAGE.h
. The free functions are in the namespace CGAL
, as the compiler uses argument dependent lookup to find them. The Euler operations are in the namespace CGAL::Euler
, as the function remove_face()
is at the same time a low level and an Euler operation. Concerning the naming conventions we have to use those of Bgl, as we have to fulfill the requirements of the concepts defined in Bgl.
The class Surface_mesh
is a model of most of Bgl graph concepts as well as the concepts provided by CGAL. A full list can be found in the documentation of boost::graph_traits
. The examples show how to use some of the Bgl algorithms with Surface_mesh
and show how to use the concepts provided by CGAL to implement a simple algorithm.
The following example program computes the minimum spanning tree on a surface mesh. More examples can be found in the chapters Triangulated Surface Mesh Simplification, Triangulated Surface Mesh Segmentation, and Triangulated Surface Mesh Deformation.
The surface mesh class uses integer indices to address vertices and edges, and it comes with a builtin property mechanism that maps nicely on the Bgl.
File BGL_surface_mesh/prim.cpp
The class Polyhedron_3
is a model of most of Bgl graph concepts as well as the concepts provided by CGAL. A full list can be found in the documentation of boost::graph_traits
. The examples show how to use some of the Bgl algorithms with Polyhedron_3
and show how to use the concepts provided by CGAL to implement a simple algorithm.
The following example program computes the minimum spanning tree on a polyhedral surface. More examples can be found in the Chapter Triangulated Surface Mesh Simplification.
File BGL_polyhedron_3/kruskal.cpp
The following example program shows a call to the Bgl Kruskal's minimum spanning tree algorithm accessing the id()
field stored in a polyhedron vertex.
The main function illustrates the access to the id()
field.
File BGL_polyhedron_3/kruskal_with_stored_id.cpp
Triangulations have vertices and faces. An edge is a pair of a face handle and the index of the edge. Particular care has to be taken with the infinite vertex and its incident edges. One can either use a boost::filtered_graph
in order to make the infinite edges invisible, or one can have a property map that returns an infinite length for these edges.
A classical example for an algorithm that is a combination of computational geometry and graph theory is the Euclidean Minimum Spanning Tree for a point set in the plane. It can be computed by running the minimum spanning tree algorithm on a Delaunay triangulation of the point set.
In the following example we create a Delaunay triangulation and run Kruskal's minimum spanning tree algorithm on it. Because the vertex handles of the triangulation are not indices in an array, we have to provide a property map that maps vertex handles to integers in the range [0, t.number_of_vertices())
.
File BGL_triangulation_2/emst.cpp
The algorithms of Bgl extensively use of the indices of vertices. In the previous example we stored the indices in a std::map
and turned that map in a property map. This property map was then passed as argument to the shortest path function.
If the user does not pass explicitly a property map, the graph algorithms use the property map returned by the call get(boost::vertex_index,ft)
. This property map assumes that the vertex has a member function id()
that returns a reference to an int. Therefore CGAL offers a class Triangulation_vertex_base_with_id_2
. It is in the users responsibility to set the indices properly.
The example further illustrates that the graph traits also works for the Delaunay triangulation.
File BGL_triangulation_2/dijkstra_with_internal_properties.cpp
CGAL offers the graph traits for the arrangement itself as well as for its dual graph.
Arrangement instances are adapted to boost graphs by specializing the boost:graph_traits
template for Arrangement_2
instances. The graphtraits states the graph concepts that the arrangement class models (see below) and defines the types required by these concepts.
In this specialization the Arrangement_2
vertices correspond to the graph vertices, where two vertices are adjacent if there is at least one halfedge connecting them. More precisely, Arrangement_2::Vertex_handle
is the graphvertex type, while Arrangement_2::Halfedge_handle
is the graphedge type. As halfedges are directed, we consider the graph to be directed as well. Moreover, as several interiordisjoint \( x\)monotone curves (say circular arcs) may share two common endpoints, inducing an arrangement with two vertices that are connected with several edges, we allow parallel edges in our boost graph.
Given an Arrangement_2
instance, we can efficiently traverse its vertices and halfedges. Thus, the arrangement graph is a model of the concepts VertexListGraph
and EdgeListGraph
introduced by Bgl. At the same time, we use an iterator adapter of the circulator over the halfedges incident to a vertex (Halfedge_around_target_circulator
 see Section Traversal Methods for an Arrangement Vertex of the chaper on arrangements), so it is possible to go over the ingoing and outgoing edges of a vertex in linear time. Thus, our arrangement graph is a model of the concept BidirectionalGraph
(this concept refines IncidenceGraph
, which requires only the traversal of outgoing edges).
It is important to notice that the vertex descriptors we use are Vertex_handle
objects and not vertex indices. However, in order to gain more efficiency in most Bgl algorithm, it is better to have them indexed \( 0, 1, \ldots, (n1)\), where \( n\) is the number of vertices. We therefore introduce the Arr_vertex_index_map<Arrangement>
classtemplate, which maintains a mapping of vertex handles to indices, as required by Bgl. An instance of this class must be attached to a valid arrangement vertex when it is created. It uses the notification mechanism (see Section The Notification Mechanism) to automatically maintain the mapping of vertices to indices, even when new vertices are inserted into the arrangement or existing vertices are removed.
In most algorithm provided by Bgl, the output is given by property maps, such that each map entry corresponds to a vertex. For example, when we compute the shortest paths from a given source vertex \( s\) to all other vertices we can obtain a map of distances and a map of predecessors  namely for each \( v\) vertex we have its distance from \( s\) and a descriptor of the vertex that precedes \( v\) in the shortest path from \( s\). If the vertex descriptors are simply indices, one can use vectors to efficiently represent the property maps. As this is not the case with the arrangement graph, we offer the Arr_vertex_property_map<Arrangement,Type>
template allows for an efficient mapping of Vertex_handle
objects to properties of type Type
. Note however that unlike the Arr_vertex_index_map
class, the vertex propertymap class is not kept synchronized with the number of vertices in the arrangement, so it should not be reused in calls to Bgl functions in case the arrangement is modified in between these calls.
In the following example we construct an arrangement of 7 line segments, as shown in Figure 89.1, then use Bgl Dijkstra's shortestpaths algorithm to compute the graph distance of all vertices from the leftmost vertex in the arrangement \( v_0\). Note the usage of the Arr_vertex_index_map
and the Arr_vertex_property_map
classes. The latter one, instantiated by the type double
is used to map vertices to their distances from \( v_0\).
File BGL_arrangement_2/primal.cpp
It is possible to give a dual graph representation for an arrangement instance, such that each arrangement face corresponds to a graph vertex and two vertices are adjacent iff the corresponding faces share a common edge on their boundaries. This is done by specializing the boost:graph_traits
template for Dual<Arrangement_2>
instances, where Dual<Arrangement_2>
is a template specialization that gives a dual interpretation to an arrangement instance.
In dual representation, Arrangement_2::Face_handle
is the graphvertex type, while Arrangement_2::Halfedge_handle
is the graphedge type. We treat the graph edges as directed, such that a halfedge e
is directed from \( f_1\), which is its incident face, to \( f_2\), which is the incident face of its twin halfedge. As two arrangement faces may share more than a single edge on their boundary, we allow parallel edges in our boost graph. As is the case in the primal graph, the dual arrangement graph is also a model of the concepts VertexListGraph
, EdgeListGraph
and BidirectionalGraph
(thus also of IncidenceGraph
).
Since we use Face_handle
objects as the vertex descriptors, we define the Arr_face_index_map<Arrangement>
classtemplate, which maintains an efficient mapping of face handles to indices. We also provide the template Arr_face_property_map<Arrangement,Type>
for associating arbitrary data with the arrangement faces.
In the following example we construct the same arrangement as in example ex_bgl_primal_adapter.cpp
(see Figure 33.29), and perform breadthfirst search on the graph faces, starting from the unbounded face. We extend the Dcel faces with an unsigned integer, marking the discover time of the face and use a breadthfirstsearch visitor to obtain these times and update the faces accordingly:
File BGL_arrangement_2/arrangement_dual.cpp
The previous sections introduced partial specializations and free functions so that several CGAL data structures are adapted as models of some of the Bgl graph concepts. In this section we define a set of new concepts to extend the functionality of Bgl in order to match Halfedge Data Structures more closely and to enable writing generic algorithms, which operate on data structures that have faces and halfedges.
HalfedgeGraph
refines Bidirectional Graph
with operations to accommodate halfedge data structures. Given a halfedge, say h
, the concept HalfedgeGraph
requires the provision of the halfedge opposite to h
, the halfedge that succeeds h
, and the halfedge that precedes h
.
MutableHalfedgeGraph
adds the requirement for operations to change the next/previous relation and to adjust the target of a halfedge.
FaceGraph
adds the requirements to explicitly handle faces in a graph, to provide quick access to incident halfedges of a face, and to enable access from every halfedge to an adjacent face. FaceListGraph
adds the requirement for efficient traversal of faces. MutableFaceGraph
adds requirements to change adjacency of faces and halfedges, and to remove and add faces.
The halfedge extensions are used by the surface simplification algorithms, which follow the design of Bgl as sketched in Section A Short Introduction to the Boost Graph Library.
Starting at a halfedge h
of a halfedge graph g
, applying several times next(h,g)
brings us back to the halfedge where we started. All halfedges traversed on the way are incident to the same face.
Using the composition of the next(h,g)
and opposite(h,g)
functions results in another cycle, namely the cycle of halfedges which are incident to the same vertex.
For convenience, two iterator and circulator types enable the traversal of all halfedges incident to a given face, and all halfedges having a given vertex as target.
These types are not part of the concept HalfedgeGraph
, but they are class templates that work for any model of this concept.
There are two categories of mutating operations. The first category comprises low level operations that change incidences such as the target vertex of a halfedge. A halfedge graph might turn invalid by the application of inconsistent low lever operations. The second category of operations are called Euler Operations. These are high level operations such as adding a center vertex to a face, which means also adding halfedges and faces, and updating incidence information. The Euler operations enable manipulating models of MutableFaceGraph
.
The dual graph of a FaceGraph
G
is a graph that has a vertex for each face of G
. The dual graph has an edge whenever two faces of G
are separated from each other by an edge. Thus, each edge e
of G
has a corresponding dual edge, the edge that connects the two faces on either side of e
.
The class template Dual
is an adaptor that creates the dual view of a FaceGraph
. Faces of the original graph correspond to vertices in the Dual
and vice versa.
The dual graph comes in handy when one wants to compute the connected component of a surface mesh.
Note that border edges in a Dual
have the null_face
of the original graph as either source or target. This is unusual and might break other algorithms since edges are always assumed to have nonnull vertices as a source and target. It is possible to filter border edges using boost::filtered_graph
as shown in the following example.
File BGL_surface_mesh/surface_mesh_dual.cpp
The following example shows several functions that enable navigating in a HalfedgeGraph
. We have two implementations of the operation that finds the vertices adjacent to a vertex v
. Let us have a look at the first version. Given a vertex descriptor vd
, we first call halfedge(vd,g)
to obtain the halfedge with vd
as target. Applying source()
then gives us an adjacent vertex. We then get to the next halfedge with vd
as target, by first going to the next halfedge around the face, and then going to the opposite halfedge.
The second version does the next()
and opposite()
jumping with an iterator. Note that when calling source()
we have to dereference hi
, as the function expects a halfedge descriptor and not a halfedge iterator. Also note that halfedges_around_target()
expects a halfedge, and not a vertex. This provides the user with the ability to start the traversal at a specific halfedge incident to the input vertex (and not the arbitrary incident halfedge stored in the vertex record.)
File BGL_polyhedron_3/incident_vertices.cpp
The following example program shows a simple algorithm for calculating facet normals for a polyhedron using the Bgl API. A boost::vector_property_map is used to to store the calculated normals instead of changing the Polyhedron items class.
File BGL_polyhedron_3/normals.cpp