From cd0c4f59f72406543189af8d3cda6d9ae83c8f11 Mon Sep 17 00:00:00 2001 From: iyaz Date: Tue, 30 Apr 2013 16:59:02 +0300 Subject: [PATCH] Documentation related changes --- .../include/CGAL/compute_average_spacing.h | 6 +-- .../include/CGAL/grid_simplify_point_set.h | 6 +-- .../CGAL/improved_jet_smooth_point_set.h | 6 +-- .../improved_laplacian_smooth_point_set.h | 6 +-- .../include/CGAL/jet_estimate_normals.h | 12 ++--- .../include/CGAL/jet_smooth_point_set.h | 6 +-- .../include/CGAL/mst_orient_normals.h | 28 +++++------ .../include/CGAL/pca_estimate_normals.h | 12 ++--- .../include/CGAL/pca_smooth_point_set.h | 6 +-- .../include/CGAL/property_map.h | 50 ++++++++++++------- .../include/CGAL/radial_orient_normals.h | 12 ++--- .../include/CGAL/random_simplify_point_set.h | 6 +-- .../include/CGAL/remove_outliers.h | 6 +-- ...move_outliers_wrt_median_knn_sq_distance.h | 6 +-- 14 files changed, 90 insertions(+), 78 deletions(-) diff --git a/Point_set_processing_3/include/CGAL/compute_average_spacing.h b/Point_set_processing_3/include/CGAL/compute_average_spacing.h index e536732649f..dc4d240bc1b 100644 --- a/Point_set_processing_3/include/CGAL/compute_average_spacing.h +++ b/Point_set_processing_3/include/CGAL/compute_average_spacing.h @@ -114,7 +114,7 @@ typename Kernel::FT compute_average_spacing( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. const Kernel& /*kernel*/) ///< geometric traits. { @@ -179,7 +179,7 @@ typename Kernel_traits::value_type>:: compute_average_spacing( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k) ///< number of neighbors { typedef typename boost::property_traits::value_type Point; @@ -193,7 +193,7 @@ compute_average_spacing( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template < typename InputIterator > typename Kernel_traits::value_type>::Kernel::FT compute_average_spacing( diff --git a/Point_set_processing_3/include/CGAL/grid_simplify_point_set.h b/Point_set_processing_3/include/CGAL/grid_simplify_point_set.h index 493ea02822f..ac3b40d3884 100644 --- a/Point_set_processing_3/include/CGAL/grid_simplify_point_set.h +++ b/Point_set_processing_3/include/CGAL/grid_simplify_point_set.h @@ -155,7 +155,7 @@ template Point_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 double epsilon, ///< tolerance value when merging 3D points. const Kernel& /*kernel*/) ///< geometric traits. { @@ -193,7 +193,7 @@ ForwardIterator grid_simplify_point_set( ForwardIterator first, ///< iterator over the first input point ForwardIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 double epsilon) ///< tolerance value when merging 3D points { typedef typename boost::property_traits::value_type Point; @@ -207,7 +207,7 @@ grid_simplify_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template ForwardIterator diff --git a/Point_set_processing_3/include/CGAL/improved_jet_smooth_point_set.h b/Point_set_processing_3/include/CGAL/improved_jet_smooth_point_set.h index 9eb14fe2e40..eaf134d50a8 100644 --- a/Point_set_processing_3/include/CGAL/improved_jet_smooth_point_set.h +++ b/Point_set_processing_3/include/CGAL/improved_jet_smooth_point_set.h @@ -219,7 +219,7 @@ void improved_jet_smooth_point_set( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. unsigned int k, ///< number of neighbors. const unsigned int iter_number, ///< number of iterations. const Kernel& kernel, ///< geometric traits. @@ -319,7 +319,7 @@ void improved_jet_smooth_point_set( ForwardIterator first, ///< iterator over the first input point ForwardIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 unsigned int k, ///< number of neighbors. const unsigned int iter_number, FT alpha, @@ -338,7 +338,7 @@ improved_jet_smooth_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template diff --git a/Point_set_processing_3/include/CGAL/improved_laplacian_smooth_point_set.h b/Point_set_processing_3/include/CGAL/improved_laplacian_smooth_point_set.h index f5e3169622b..1be1242a826 100644 --- a/Point_set_processing_3/include/CGAL/improved_laplacian_smooth_point_set.h +++ b/Point_set_processing_3/include/CGAL/improved_laplacian_smooth_point_set.h @@ -202,7 +202,7 @@ void improved_laplacian_smooth_point_set( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. unsigned int k, ///< number of neighbors. const unsigned int iter_number, ///< number of iterations. const Kernel& kernel, ///< geometric traits. @@ -299,7 +299,7 @@ void improved_laplacian_smooth_point_set( ForwardIterator first, ///< iterator over the first input point ForwardIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 unsigned int k, ///< number of neighbors. const unsigned int iter_number, FT alpha, @@ -318,7 +318,7 @@ improved_laplacian_smooth_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template diff --git a/Point_set_processing_3/include/CGAL/jet_estimate_normals.h b/Point_set_processing_3/include/CGAL/jet_estimate_normals.h index 50483a54aba..ceabe2ae560 100644 --- a/Point_set_processing_3/include/CGAL/jet_estimate_normals.h +++ b/Point_set_processing_3/include/CGAL/jet_estimate_normals.h @@ -131,8 +131,8 @@ void jet_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k, ///< number of neighbors. const Kernel& /*kernel*/, ///< geometric traits. unsigned int degree_fitting = 2) ///< fitting degree @@ -214,8 +214,8 @@ void jet_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k, ///< number of neighbors. unsigned int degree_fitting = 2) { @@ -232,7 +232,7 @@ jet_estimate_normals( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template @@ -240,7 +240,7 @@ void jet_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k, ///< number of neighbors. unsigned int degree_fitting = 2) { diff --git a/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h b/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h index d9dbead6ac4..133e262c614 100644 --- a/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h +++ b/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h @@ -129,7 +129,7 @@ void jet_smooth_point_set( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. unsigned int k, ///< number of neighbors. const Kernel& /*kernel*/, ///< geometric traits. unsigned int degree_fitting = 2, ///< fitting degree @@ -189,7 +189,7 @@ void jet_smooth_point_set( InputIterator first, ///< iterator over the first input point InputIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. const unsigned int degree_fitting = 2, const unsigned int degree_monge = 2) @@ -206,7 +206,7 @@ jet_smooth_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template void diff --git a/Point_set_processing_3/include/CGAL/mst_orient_normals.h b/Point_set_processing_3/include/CGAL/mst_orient_normals.h index 07bb479c780..955fee2a131 100644 --- a/Point_set_processing_3/include/CGAL/mst_orient_normals.h +++ b/Point_set_processing_3/include/CGAL/mst_orient_normals.h @@ -102,7 +102,7 @@ struct MST_graph_vertex_properties { bool is_oriented; ///< Is input point's normal oriented? }; template Normal + typename NormalPMap, ///< property map: value_type of ForwardIterator -> Normal typename Kernel ///< Geometric traits class > class MST_graph @@ -134,7 +134,7 @@ public: /// @tparam Kernel Geometric traits class. template Normal + typename NormalPMap, ///< property map: value_type of ForwardIterator -> Normal typename Kernel > struct Propagate_normal_orientation @@ -212,8 +212,8 @@ ForwardIterator mst_find_source( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3 const Kernel& /*kernel*/) ///< geometric traits. { CGAL_TRACE(" mst_find_source()\n"); @@ -282,8 +282,8 @@ Riemannian_graph create_riemannian_graph( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3 IndexPMap index_pmap, ///< property map ForwardIterator -> index unsigned int k, ///< number of neighbors const Kernel& /*kernel*/) ///< geometric traits. @@ -441,8 +441,8 @@ MST_graph create_mst_graph( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3 IndexPMap index_pmap, ///< property map ForwardIterator -> index unsigned int k, ///< number of neighbors const Kernel& kernel, ///< geometric traits. @@ -555,8 +555,8 @@ ForwardIterator mst_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3. unsigned int k, ///< number of neighbors const Kernel& kernel) ///< geometric traits. { @@ -663,8 +663,8 @@ ForwardIterator mst_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3. unsigned int k) ///< number of neighbors { typedef typename boost::property_traits::value_type Point; @@ -679,7 +679,7 @@ mst_orient_normals( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template @@ -687,7 +687,7 @@ ForwardIterator mst_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3. + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3. unsigned int k) ///< number of neighbors { return mst_orient_normals( diff --git a/Point_set_processing_3/include/CGAL/pca_estimate_normals.h b/Point_set_processing_3/include/CGAL/pca_estimate_normals.h index 1cebe031766..dfc315075c2 100644 --- a/Point_set_processing_3/include/CGAL/pca_estimate_normals.h +++ b/Point_set_processing_3/include/CGAL/pca_estimate_normals.h @@ -126,8 +126,8 @@ void pca_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k, ///< number of neighbors. const Kernel& /*kernel*/) ///< geometric traits. { @@ -208,8 +208,8 @@ void pca_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k) ///< number of neighbors. { typedef typename boost::property_traits::value_type Point; @@ -224,7 +224,7 @@ pca_estimate_normals( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template @@ -232,7 +232,7 @@ void pca_estimate_normals( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - NormalPMap normal_pmap, ///< property map InputIterator -> Vector_3. + NormalPMap normal_pmap, ///< property map: value_type of InputIterator -> Vector_3. unsigned int k) ///< number of neighbors. { pca_estimate_normals( diff --git a/Point_set_processing_3/include/CGAL/pca_smooth_point_set.h b/Point_set_processing_3/include/CGAL/pca_smooth_point_set.h index 028a50bc9af..098722c2cd0 100644 --- a/Point_set_processing_3/include/CGAL/pca_smooth_point_set.h +++ b/Point_set_processing_3/include/CGAL/pca_smooth_point_set.h @@ -125,7 +125,7 @@ void pca_smooth_point_set( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3. + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3. unsigned int k, ///< number of neighbors. const Kernel& kernel) ///< geometric traits. { @@ -184,7 +184,7 @@ void pca_smooth_point_set( InputIterator first, ///< iterator over the first input point InputIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k) ///< number of neighbors. { typedef typename boost::property_traits::value_type Point; @@ -198,7 +198,7 @@ pca_smooth_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template void diff --git a/Point_set_processing_3/include/CGAL/property_map.h b/Point_set_processing_3/include/CGAL/property_map.h index 3e0701b41c4..2a27dbe5960 100644 --- a/Point_set_processing_3/include/CGAL/property_map.h +++ b/Point_set_processing_3/include/CGAL/property_map.h @@ -35,8 +35,12 @@ namespace CGAL { #ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS -/// An alternative to boost::put_get_helper for: -/// - return type of `get` function is `const Reference` +/// \cond SKIP_IN_MANUAL + +/// An alternative to boost::put_get_helper for pmaps where key itself or a part of it returned as mapped value. +/// - Two `get` functions exist. +/// + One of them passes key by reference and returns mapped value as reference +/// + The other passes key by const reference, and returns mapped value as const reference /// - `key` is passed by reference in `put` function template struct put_get_helper_pass_key_by_reference { }; @@ -63,6 +67,7 @@ put(const put_get_helper_pass_key_by_reference& pa, K& k { static_cast(pa)[k] = v; } +/// \endcond #endif #ifdef CGAL_USE_OLD_PAIR_PROPERTY_MAPS @@ -100,16 +105,23 @@ make_dereference_property_map(Iter) #endif #ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS +/// \ingroup PkgProperty_map +/// Property map that maps a key to itself. +/// +/// \cgalModels `LvaluePropertyMap` template struct Typed_identity_property_map_by_reference : put_get_helper_pass_key_by_reference > { - typedef T key_type; - typedef T value_type; - typedef T& reference; - typedef boost::lvalue_property_map_tag category; - + typedef T key_type; ///< typedef to `T` + typedef T value_type; ///< typedef to `T` + typedef T& reference; ///< typedef to `T&` + typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` + + /// Access a property map element. + /// @param v a key which is returned as mapped value. reference operator[](key_type& v) const { return v; } + /// Const version. const value_type& operator[](const key_type& v) const { return v; } }; @@ -138,7 +150,7 @@ struct First_of_pair_property_map : public boost::put_get_helper > { - typedef Pair* key_type; ///< typedef to 'Pair*' + typedef Pair* key_type; ///< typedef to `Pair*` typedef typename Pair::first_type value_type; ///< typedef to `Pair::first_type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag @@ -172,15 +184,15 @@ struct First_of_pair_property_map : put_get_helper_pass_key_by_reference > { - typedef Pair key_type; ///< typedef to 'Pair' + typedef Pair key_type; ///< typedef to `Pair` typedef typename Pair::first_type value_type; ///< typedef to `Pair::first_type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag /// Access a property map element. - /// - /// @tparam pair a key whose first item is accessed + /// @param pair a key whose first item is accessed reference operator[](key_type& pair) const { return pair.first; } + /// Const version. const value_type& operator[](const key_type& pair) const { return pair.first; } }; @@ -210,7 +222,7 @@ struct Second_of_pair_property_map : public boost::put_get_helper > { - typedef Pair* key_type; ///< typedef to 'Pair*' + typedef Pair* key_type; ///< typedef to `Pair*` typedef typename Pair::second_type value_type; ///< typedef to `Pair::second_type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` @@ -247,15 +259,15 @@ struct Second_of_pair_property_map : put_get_helper_pass_key_by_reference > { - typedef Pair key_type; ///< typedef to 'Pair' + typedef Pair key_type; ///< typedef to `Pair` typedef typename Pair::second_type value_type; ///< typedef to `Pair::first_type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag /// Access a property map element. - /// - /// @tparam pair a key whose second item is accessed + /// @param pair a key whose second item is accessed reference operator[](key_type& pair) const { return pair.second; } + /// Const version. const value_type& operator[](const key_type& pair) const { return pair.second; } }; @@ -288,7 +300,7 @@ struct Nth_of_tuple_property_map : public boost::put_get_helper::type&, Nth_of_tuple_property_map > { - typedef Tuple* key_type; ///< typedef to 'Tuple*' + typedef Tuple* key_type; ///< typedef to `Tuple*` typedef typename boost::tuples::element::type value_type; ///< typedef to `boost::tuples::element::%type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` @@ -324,15 +336,15 @@ struct Nth_of_tuple_property_map : put_get_helper_pass_key_by_reference::type&, Nth_of_tuple_property_map > { - typedef Tuple key_type; ///< typedef to 'Tuple' + typedef Tuple key_type; ///< typedef to `Tuple` typedef typename boost::tuples::element::type value_type; ///< typedef to `boost::tuples::element::%type` typedef value_type& reference; ///< typedef to `value_type&` typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` /// Access a property map element. - /// - /// @tparam tuple a key whose Nth item is accessed + /// @param tuple a key whose Nth item is accessed reference operator[](key_type& tuple) const { return tuple.template get(); } + /// Const version. const value_type& operator[](const key_type& tuple) const { return tuple.template get(); } }; diff --git a/Point_set_processing_3/include/CGAL/radial_orient_normals.h b/Point_set_processing_3/include/CGAL/radial_orient_normals.h index bd6575df5c1..c98fccd0278 100644 --- a/Point_set_processing_3/include/CGAL/radial_orient_normals.h +++ b/Point_set_processing_3/include/CGAL/radial_orient_normals.h @@ -58,8 +58,8 @@ ForwardIterator radial_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. - NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. + NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3. const Kernel& kernel) ///< geometric traits. { CGAL_TRACE("Calls radial_orient_normals()\n"); @@ -143,8 +143,8 @@ ForwardIterator radial_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3. - NormalPMap normal_pmap) ///< property map ForwardIterator -> Vector_3. + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3. + NormalPMap normal_pmap) ///< property map: value_type of ForwardIterator -> Vector_3. { typedef typename boost::property_traits::value_type Point; typedef typename Kernel_traits::Kernel Kernel; @@ -156,7 +156,7 @@ radial_orient_normals( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template @@ -164,7 +164,7 @@ ForwardIterator radial_orient_normals( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - NormalPMap normal_pmap) ///< property map ForwardIterator -> Vector_3. + NormalPMap normal_pmap) ///< property map: value_type of ForwardIterator -> Vector_3. { return radial_orient_normals( first,beyond, diff --git a/Point_set_processing_3/include/CGAL/random_simplify_point_set.h b/Point_set_processing_3/include/CGAL/random_simplify_point_set.h index 8fd22197bdb..70d91d5c58e 100644 --- a/Point_set_processing_3/include/CGAL/random_simplify_point_set.h +++ b/Point_set_processing_3/include/CGAL/random_simplify_point_set.h @@ -54,7 +54,7 @@ ForwardIterator random_simplify_point_set( ForwardIterator first, ///< iterator over the first input point. ForwardIterator beyond, ///< past-the-end iterator over the input points. - PointPMap /*point_pmap*/, ///< property map ForwardIterator -> Point_3 + PointPMap /*point_pmap*/, ///< property map: value_type of ForwardIterator -> Point_3 double removed_percentage, ///< percentage of points to remove. const Kernel& /*kernel*/) ///< geometric traits. { @@ -81,7 +81,7 @@ ForwardIterator random_simplify_point_set( ForwardIterator first, ///< iterator over the first input point ForwardIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map ForwardIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of ForwardIterator -> Point_3 double removed_percentage) ///< percentage of points to remove { typedef typename boost::property_traits::value_type Point; @@ -95,7 +95,7 @@ random_simplify_point_set( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template ForwardIterator diff --git a/Point_set_processing_3/include/CGAL/remove_outliers.h b/Point_set_processing_3/include/CGAL/remove_outliers.h index e3d2b952192..9cb3c97c283 100644 --- a/Point_set_processing_3/include/CGAL/remove_outliers.h +++ b/Point_set_processing_3/include/CGAL/remove_outliers.h @@ -128,7 +128,7 @@ InputIterator remove_outliers( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. double threshold_percent, ///< percentage of points to remove. const Kernel& /*kernel*/) ///< geometric traits. @@ -215,7 +215,7 @@ InputIterator remove_outliers( InputIterator first, ///< iterator over the first input point InputIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. double threshold_percent) ///< percentage of points to remove { @@ -230,7 +230,7 @@ remove_outliers( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template InputIterator diff --git a/Point_set_processing_3/include/CGAL/remove_outliers_wrt_median_knn_sq_distance.h b/Point_set_processing_3/include/CGAL/remove_outliers_wrt_median_knn_sq_distance.h index b9f83e4c39d..3bfbb9b4970 100644 --- a/Point_set_processing_3/include/CGAL/remove_outliers_wrt_median_knn_sq_distance.h +++ b/Point_set_processing_3/include/CGAL/remove_outliers_wrt_median_knn_sq_distance.h @@ -125,7 +125,7 @@ InputIterator remove_outliers_wrt_median_knn_sq_distance( InputIterator first, ///< iterator over the first input point. InputIterator beyond, ///< past-the-end iterator over the input points. - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. double threshold_percent, ///< percentage of points to remove. const Kernel& kernel) ///< geometric traits. @@ -213,7 +213,7 @@ InputIterator remove_outliers_wrt_median_knn_sq_distance( InputIterator first, ///< iterator over the first input point InputIterator beyond, ///< past-the-end iterator - PointPMap point_pmap, ///< property map InputIterator -> Point_3 + PointPMap point_pmap, ///< property map: value_type of InputIterator -> Point_3 unsigned int k, ///< number of neighbors. double threshold_percent) ///< percentage of points to remove { @@ -228,7 +228,7 @@ remove_outliers_wrt_median_knn_sq_distance( /// @endcond /// @cond SKIP_IN_MANUAL -// This variant creates a default point property map = Dereference_property_map. +// This variant creates a default point property map = Typed_identity_property_map_by_reference. template InputIterator