CGAL 4.12  CGAL and the Boost Graph Library

The algorithms of the 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.
In the following, we assume that PolygonMesh
is a model of the concept FaceGraph
. Note that for some functions, the type might be more specific:
Here is the list of the named parameters available in this package:
vertex_point_map  is the property map with the points associated to the vertices of the polygon mesh. boost::get(CGAL::vertex_point, pmesh) 
vertex_index_map  is the property map containing the index of each vertex of the input polygon mesh. typename boost::property_traits<typename boost::property_map<PolygonMesh, CGAL::vertex_index_t>::type>::value_type Default: boost::get(CGAL::vertex_index, pmesh) 
halfedge_index_map  is the property map containing the index of each halfedge of the input polygon mesh. typename boost::property_traits<typename boost::property_map<PolygonMesh, CGAL::halfedge_index_t>::type>::value_type Default: boost::get(CGAL::halfedge_index, pmesh) If this internal property map exists, its values should be initialized. 
edge_index_map  is the property map containing the index of each edge of the input polygon mesh. typename boost::property_traits<typename boost::property_map<PolygonMesh, CGAL::edge_index_t>::type>::value_type Default: boost::get(CGAL::edge_index, pmesh) If this internal property map exists, its values should be initialized. 
face_index_map  is the property map containing the index of each face of the input polygon mesh. typename boost::property_traits<typename boost::property_map<PolygonMesh, CGAL::face_index_t>::type>::value_type Default: boost::get(CGAL::face_index, pmesh) If this internal property map exists, its values should be initialized. 
edge_is_constrained_map  is the property map containing information about edges of the input polygon mesh being marked or not. 
METIS_options  is a parameter used in 
vertex_partition_id_map  is the property map storing for each vertex of the mesh the id of the subpart of the partition that has been assigned to this vertex. 
face_partition_id_map  is the property map storing for each face of the mesh the id of the subpart of the partition that has been assigned to this face. 