From 1be3e1d3f2c657977b0d61b3ea695d026e112f9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 2 May 2024 14:36:18 +0200 Subject: [PATCH 1/2] shorten parameters for better doc readibility --- .../Polygon_mesh_processing/corefinement.h | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h index 1100d638cfa..78d8c572e26 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h @@ -59,7 +59,7 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1, #define CGAL_COREF_SET_OUTPUT_EDGE_MARK_MAP(I) \ typedef typename internal_np::Lookup_named_param_def < \ internal_np::edge_is_constrained_t, \ - NamedParametersOut##I, \ + NPOut##I, \ Corefinement::No_mark \ > ::type Ecm_out_##I; \ Ecm_out_##I ecm_out_##I = \ @@ -92,10 +92,10 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1, * @tparam TriangleMesh a model of `HalfedgeListGraph`, `FaceListGraph`, and `MutableFaceGraph` * @tparam NamedParameters1 a sequence of \ref bgl_namedparameters "Named Parameters" * @tparam NamedParameters2 a sequence of \ref bgl_namedparameters "Named Parameters" - * @tparam NamedParametersOut0 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the union of the volumes bounded by `tm1` and `tm2` - * @tparam NamedParametersOut1 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the intersection of the volumes bounded by `tm1` and `tm2` - * @tparam NamedParametersOut2 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the difference of the volumes bounded by `tm1` and `tm2` - * @tparam NamedParametersOut3 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the difference of the volumes bounded by `tm2` and `tm1` + * @tparam NPOut0 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the union of the volumes bounded by `tm1` and `tm2` + * @tparam NPOut1 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the intersection of the volumes bounded by `tm1` and `tm2` + * @tparam NPOut2 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the difference of the volumes bounded by `tm1` and `tm2` + * @tparam NPOut3 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the difference of the volumes bounded by `tm2` and `tm1` * * @param tm1 first input triangulated surface mesh * @param tm2 second input triangulated surface mesh @@ -178,10 +178,10 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1, template + class NPOut0 = parameters::Default_named_parameters, + class NPOut1 = parameters::Default_named_parameters, + class NPOut2 = parameters::Default_named_parameters, + class NPOut3 = parameters::Default_named_parameters> std::array corefine_and_compute_boolean_operations( TriangleMesh& tm1, @@ -189,11 +189,11 @@ corefine_and_compute_boolean_operations( const std::array< boost::optional,4>& output, const NamedParameters1& np1 = parameters::default_values(), const NamedParameters2& np2 = parameters::default_values(), - const std::tuple& nps_out - = std::tuple()) + const std::tuple& nps_out + = std::tuple()) { using parameters::choose_parameter; using parameters::get_parameter; @@ -222,10 +222,10 @@ corefine_and_compute_boolean_operations( // input map, a dummy default vpm is used so that calls to get/put can be compiled // (even if not used). typedef std::tuple< - Corefinement::TweakedGetVertexPointMap, - Corefinement::TweakedGetVertexPointMap, - Corefinement::TweakedGetVertexPointMap, - Corefinement::TweakedGetVertexPointMap + Corefinement::TweakedGetVertexPointMap, + Corefinement::TweakedGetVertexPointMap, + Corefinement::TweakedGetVertexPointMap, + Corefinement::TweakedGetVertexPointMap > VPM_out_tuple_helper; typedef std::tuple< From 6291a4f62dafddbc660e20fda1a4c19d8f0aaded Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Mon, 6 May 2024 09:50:18 +0200 Subject: [PATCH 2/2] also rename input nps --- .../Polygon_mesh_processing/corefinement.h | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h index 78d8c572e26..761d7f98a77 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h @@ -90,8 +90,8 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1, * \pre \link CGAL::Polygon_mesh_processing::does_bound_a_volume() `CGAL::Polygon_mesh_processing::does_bound_a_volume(tm2)` \endlink * * @tparam TriangleMesh a model of `HalfedgeListGraph`, `FaceListGraph`, and `MutableFaceGraph` - * @tparam NamedParameters1 a sequence of \ref bgl_namedparameters "Named Parameters" - * @tparam NamedParameters2 a sequence of \ref bgl_namedparameters "Named Parameters" + * @tparam NPIn1 a sequence of \ref bgl_namedparameters "Named Parameters" + * @tparam NPIn2 a sequence of \ref bgl_namedparameters "Named Parameters" * @tparam NPOut0 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the union of the volumes bounded by `tm1` and `tm2` * @tparam NPOut1 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the intersection of the volumes bounded by `tm1` and `tm2` * @tparam NPOut2 a sequence of \ref bgl_namedparameters "Named Parameters" for computing the difference of the volumes bounded by `tm1` and `tm2` @@ -176,8 +176,8 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1, * will only be corefined. */ template ,4>& output, - const NamedParameters1& np1 = parameters::default_values(), - const NamedParameters2& np2 = parameters::default_values(), + const NPIn1& np1 = parameters::default_values(), + const NPIn2& np2 = parameters::default_values(), const std::tuple::type VPM1; - typedef typename GetVertexPointMap::type VPM2; + typedef typename GetVertexPointMap::type VPM1; + typedef typename GetVertexPointMap::type VPM2; CGAL_static_assertion((std::is_same::value_type, typename boost::property_traits::value_type>::value)); @@ -331,13 +331,13 @@ corefine_and_compute_boolean_operations( //for input meshes typedef typename internal_np::Lookup_named_param_def < internal_np::edge_is_constrained_t, - NamedParameters1, + NPIn1, Corefinement::No_mark//default > ::type Ecm1; typedef typename internal_np::Lookup_named_param_def < internal_np::edge_is_constrained_t, - NamedParameters2, + NPIn2, Corefinement::No_mark//default > ::type Ecm2; @@ -357,8 +357,8 @@ corefine_and_compute_boolean_operations( Edge_mark_map_tuple; // Face index point maps - typedef typename CGAL::GetInitializedFaceIndexMap::type FaceIndexMap1; - typedef typename CGAL::GetInitializedFaceIndexMap::type FaceIndexMap2; + typedef typename CGAL::GetInitializedFaceIndexMap::type FaceIndexMap1; + typedef typename CGAL::GetInitializedFaceIndexMap::type FaceIndexMap2; FaceIndexMap1 fid_map1 = get_initialized_face_index_map(tm1, np1); FaceIndexMap2 fid_map2 = get_initialized_face_index_map(tm2, np2); @@ -367,7 +367,7 @@ corefine_and_compute_boolean_operations( // User visitor typedef typename internal_np::Lookup_named_param_def < internal_np::visitor_t, - NamedParameters1, + NPIn1, Corefinement::Default_visitor//default > ::type User_visitor; User_visitor uv(choose_parameter(get_parameter(np1, internal_np::visitor)));