CGAL 6.1.2 - STL Extensions for CGAL: Upgrading Code using Boost Parameters to CGAL Named Function Parameters

CGAL 6.1.2 - STL Extensions for CGAL

Loading...
Searching...
No Matches
Upgrading Code using Boost Parameters to CGAL Named Function Parameters

Prior to CGAL 5.6, some packages were using Boost parameters to provide a user friendly way to set parameters of classes and functions.

In an attempt to remove a dependency and to get a more uniform API across packages, these packages have been updated to now use CGAL Named Parameters inspired by the function named parameters from the Boost graph library. In practice this means that the following call:

Mesh_criteria criteria(edge_size = 8,
facet_angle = 25,
facet_size = 8,
facet_distance = 0.2,
cell_radius_edge_ratio = 3,
cell_size = 10);

should now be written as follows:

Mesh_criteria criteria(edge_size(8).
facet_angle(25).
facet_size(8).
facet_distance(0.2).
cell_radius_edge_ratio(3).
cell_size(10));

Note that we have tried to preserve the backward compatibility by allowing previous API to remain valid. However, if new parameters are introduced for those functions, there is no guarantee that they will be ported to the old API. So we strongly encourage users to upgrade to the new API. Additionally, passing parameters without names is deprecated and even removed for some functions.