songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation related changes

This commit is contained in:
iyaz 2013-04-30 16:59:02 +03:00
parent 35a83e09f8
commit cd0c4f59f7
14 changed files with 90 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Point_set_processing_3/include/CGAL/compute_average_spacing.h
View File

@ -114,7 +114,7 @@ typename Kernel::FT
compute_average_spacing( compute_average_spacing(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
{ {
@ -179,7 +179,7 @@ typename Kernel_traits<typename boost::property_traits<PointPMap>::value_type>::
compute_average_spacing( compute_average_spacing(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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 unsigned int k) ///< number of neighbors
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -193,7 +193,7 @@ compute_average_spacing(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 > template < typename InputIterator >
typename Kernel_traits<typename std::iterator_traits<InputIterator>::value_type>::Kernel::FT typename Kernel_traits<typename std::iterator_traits<InputIterator>::value_type>::Kernel::FT
compute_average_spacing( compute_average_spacing(

6
Point_set_processing_3/include/CGAL/grid_simplify_point_set.h
View File

@ -155,7 +155,7 @@ template <typename ForwardIterator,
ForwardIterator grid_simplify_point_set( ForwardIterator grid_simplify_point_set(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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 epsilon, ///< tolerance value when merging 3D points. double epsilon, ///< tolerance value when merging 3D points.
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
{ {
@ -193,7 +193,7 @@ ForwardIterator
grid_simplify_point_set( grid_simplify_point_set(
ForwardIterator first, ///< iterator over the first input point ForwardIterator first, ///< iterator over the first input point
ForwardIterator beyond, ///< past-the-end iterator 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 double epsilon) ///< tolerance value when merging 3D points
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -207,7 +207,7 @@ grid_simplify_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator template <typename ForwardIterator
> >
ForwardIterator ForwardIterator

6
Point_set_processing_3/include/CGAL/improved_jet_smooth_point_set.h
View File

@ -219,7 +219,7 @@ void
improved_jet_smooth_point_set( improved_jet_smooth_point_set(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
const unsigned int iter_number, ///< number of iterations. const unsigned int iter_number, ///< number of iterations.
const Kernel& kernel, ///< geometric traits. const Kernel& kernel, ///< geometric traits.
@ -319,7 +319,7 @@ void
improved_jet_smooth_point_set( improved_jet_smooth_point_set(
ForwardIterator first, ///< iterator over the first input point ForwardIterator first, ///< iterator over the first input point
ForwardIterator beyond, ///< past-the-end iterator 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. unsigned int k, ///< number of neighbors.
const unsigned int iter_number, const unsigned int iter_number,
FT alpha, FT alpha,
@ -338,7 +338,7 @@ improved_jet_smooth_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator, template <typename ForwardIterator,
typename FT typename FT
> >

6
Point_set_processing_3/include/CGAL/improved_laplacian_smooth_point_set.h
View File

@ -202,7 +202,7 @@ void
improved_laplacian_smooth_point_set( improved_laplacian_smooth_point_set(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
const unsigned int iter_number, ///< number of iterations. const unsigned int iter_number, ///< number of iterations.
const Kernel& kernel, ///< geometric traits. const Kernel& kernel, ///< geometric traits.
@ -299,7 +299,7 @@ void
improved_laplacian_smooth_point_set( improved_laplacian_smooth_point_set(
ForwardIterator first, ///< iterator over the first input point ForwardIterator first, ///< iterator over the first input point
ForwardIterator beyond, ///< past-the-end iterator 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. unsigned int k, ///< number of neighbors.
const unsigned int iter_number, const unsigned int iter_number,
FT alpha, FT alpha,
@ -318,7 +318,7 @@ improved_laplacian_smooth_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator, template <typename ForwardIterator,
typename FT typename FT
> >

12
Point_set_processing_3/include/CGAL/jet_estimate_normals.h
View File

@ -131,8 +131,8 @@ void
jet_estimate_normals( jet_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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.
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 k, ///< number of neighbors.
const Kernel& /*kernel*/, ///< geometric traits. const Kernel& /*kernel*/, ///< geometric traits.
unsigned int degree_fitting = 2) ///< fitting degree unsigned int degree_fitting = 2) ///< fitting degree
@ -214,8 +214,8 @@ void
jet_estimate_normals( jet_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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.
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 k, ///< number of neighbors.
unsigned int degree_fitting = 2) unsigned int degree_fitting = 2)
{ {
@ -232,7 +232,7 @@ jet_estimate_normals(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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, template <typename InputIterator,
typename NormalPMap typename NormalPMap
> >
@ -240,7 +240,7 @@ void
jet_estimate_normals( jet_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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 k, ///< number of neighbors.
unsigned int degree_fitting = 2) unsigned int degree_fitting = 2)
{ {

6
Point_set_processing_3/include/CGAL/jet_smooth_point_set.h
View File

@ -129,7 +129,7 @@ void
jet_smooth_point_set( jet_smooth_point_set(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
const Kernel& /*kernel*/, ///< geometric traits. const Kernel& /*kernel*/, ///< geometric traits.
unsigned int degree_fitting = 2, ///< fitting degree unsigned int degree_fitting = 2, ///< fitting degree
@ -189,7 +189,7 @@ void
jet_smooth_point_set( jet_smooth_point_set(
InputIterator first, ///< iterator over the first input point InputIterator first, ///< iterator over the first input point
InputIterator beyond, ///< past-the-end iterator 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. unsigned int k, ///< number of neighbors.
const unsigned int degree_fitting = 2, const unsigned int degree_fitting = 2,
const unsigned int degree_monge = 2) const unsigned int degree_monge = 2)
@ -206,7 +206,7 @@ jet_smooth_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 template <typename InputIterator
> >
void void

28
Point_set_processing_3/include/CGAL/mst_orient_normals.h
View File

@ -102,7 +102,7 @@ struct MST_graph_vertex_properties {
bool is_oriented; ///< Is input point's normal oriented? bool is_oriented; ///< Is input point's normal oriented?
}; };
template <typename ForwardIterator, ///< Input point iterator template <typename ForwardIterator, ///< Input point iterator
typename NormalPMap, ///< property map ForwardIterator -> Normal typename NormalPMap, ///< property map: value_type of ForwardIterator -> Normal
typename Kernel ///< Geometric traits class typename Kernel ///< Geometric traits class
> >
class MST_graph class MST_graph
@ -134,7 +134,7 @@ public:
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
template <typename ForwardIterator, ///< Input point iterator template <typename ForwardIterator, ///< Input point iterator
typename NormalPMap, ///< property map ForwardIterator -> Normal typename NormalPMap, ///< property map: value_type of ForwardIterator -> Normal
typename Kernel typename Kernel
> >
struct Propagate_normal_orientation struct Propagate_normal_orientation
@ -212,8 +212,8 @@ ForwardIterator
mst_find_source( mst_find_source(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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
NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
{ {
CGAL_TRACE(" mst_find_source()\n"); CGAL_TRACE(" mst_find_source()\n");
@ -282,8 +282,8 @@ Riemannian_graph<ForwardIterator>
create_riemannian_graph( create_riemannian_graph(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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
NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3
IndexPMap index_pmap, ///< property map ForwardIterator -> index IndexPMap index_pmap, ///< property map ForwardIterator -> index
unsigned int k, ///< number of neighbors unsigned int k, ///< number of neighbors
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
@ -441,8 +441,8 @@ MST_graph<ForwardIterator, NormalPMap, Kernel>
create_mst_graph( create_mst_graph(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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
NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3 NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3
IndexPMap index_pmap, ///< property map ForwardIterator -> index IndexPMap index_pmap, ///< property map ForwardIterator -> index
unsigned int k, ///< number of neighbors unsigned int k, ///< number of neighbors
const Kernel& kernel, ///< geometric traits. const Kernel& kernel, ///< geometric traits.
@ -555,8 +555,8 @@ ForwardIterator
mst_orient_normals( mst_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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.
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 unsigned int k, ///< number of neighbors
const Kernel& kernel) ///< geometric traits. const Kernel& kernel) ///< geometric traits.
{ {
@ -663,8 +663,8 @@ ForwardIterator
mst_orient_normals( mst_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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.
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 unsigned int k) ///< number of neighbors
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -679,7 +679,7 @@ mst_orient_normals(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator, template <typename ForwardIterator,
typename NormalPMap typename NormalPMap
> >
@ -687,7 +687,7 @@ ForwardIterator
mst_orient_normals( mst_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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 unsigned int k) ///< number of neighbors
{ {
return mst_orient_normals( return mst_orient_normals(

12
Point_set_processing_3/include/CGAL/pca_estimate_normals.h
View File

@ -126,8 +126,8 @@ void
pca_estimate_normals( pca_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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.
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 k, ///< number of neighbors.
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
{ {
@ -208,8 +208,8 @@ void
pca_estimate_normals( pca_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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.
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 k) ///< number of neighbors.
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -224,7 +224,7 @@ pca_estimate_normals(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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, template <typename InputIterator,
typename NormalPMap typename NormalPMap
> >
@ -232,7 +232,7 @@ void
pca_estimate_normals( pca_estimate_normals(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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 k) ///< number of neighbors.
{ {
pca_estimate_normals( pca_estimate_normals(

6
Point_set_processing_3/include/CGAL/pca_smooth_point_set.h
View File

@ -125,7 +125,7 @@ void
pca_smooth_point_set( pca_smooth_point_set(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
const Kernel& kernel) ///< geometric traits. const Kernel& kernel) ///< geometric traits.
{ {
@ -184,7 +184,7 @@ void
pca_smooth_point_set( pca_smooth_point_set(
InputIterator first, ///< iterator over the first input point InputIterator first, ///< iterator over the first input point
InputIterator beyond, ///< past-the-end iterator 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. unsigned int k) ///< number of neighbors.
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -198,7 +198,7 @@ pca_smooth_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 template <typename InputIterator
> >
void void

48
Point_set_processing_3/include/CGAL/property_map.h
View File

@ -35,8 +35,12 @@
namespace CGAL { namespace CGAL {
#ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS #ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS
/// An alternative to boost::put_get_helper for: /// \cond SKIP_IN_MANUAL
/// - return type of `get` function is `const Reference`
/// 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 /// - `key` is passed by reference in `put` function
template <class Reference, class LvaluePropertyMap> template <class Reference, class LvaluePropertyMap>
struct put_get_helper_pass_key_by_reference { }; struct put_get_helper_pass_key_by_reference { };
@ -63,6 +67,7 @@ put(const put_get_helper_pass_key_by_reference<Reference, PropertyMap>& pa, K& k
{ {
static_cast<const PropertyMap&>(pa)[k] = v; static_cast<const PropertyMap&>(pa)[k] = v;
} }
/// \endcond
#endif #endif
#ifdef CGAL_USE_OLD_PAIR_PROPERTY_MAPS #ifdef CGAL_USE_OLD_PAIR_PROPERTY_MAPS
@ -100,16 +105,23 @@ make_dereference_property_map(Iter)
#endif #endif
#ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS #ifndef CGAL_USE_OLD_PAIR_PROPERTY_MAPS
/// \ingroup PkgProperty_map
/// Property map that maps a key to itself.
///
/// \cgalModels `LvaluePropertyMap`
template <typename T> template <typename T>
struct Typed_identity_property_map_by_reference struct Typed_identity_property_map_by_reference
: put_get_helper_pass_key_by_reference<T, Typed_identity_property_map_by_reference<T> > : put_get_helper_pass_key_by_reference<T, Typed_identity_property_map_by_reference<T> >
{ {
typedef T key_type; typedef T key_type; ///< typedef to `T`
typedef T value_type; typedef T value_type; ///< typedef to `T`
typedef T& reference; typedef T& reference; ///< typedef to `T&`
typedef boost::lvalue_property_map_tag category; 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; } reference operator[](key_type& v) const { return v; }
/// Const version.
const value_type& operator[](const key_type& v) const { return v; } 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<typename Pair::first_type&, : public boost::put_get_helper<typename Pair::first_type&,
First_of_pair_property_map<Pair> > First_of_pair_property_map<Pair> >
{ {
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 typename Pair::first_type value_type; ///< typedef to `Pair::first_type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag 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<typename Pair::first_type&, : put_get_helper_pass_key_by_reference<typename Pair::first_type&,
First_of_pair_property_map<Pair> > First_of_pair_property_map<Pair> >
{ {
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 typename Pair::first_type value_type; ///< typedef to `Pair::first_type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag
/// Access a property map element. /// Access a property map element.
/// /// @param pair a key whose first item is accessed
/// @tparam pair a key whose first item is accessed
reference operator[](key_type& pair) const { return pair.first; } reference operator[](key_type& pair) const { return pair.first; }
/// Const version.
const value_type& operator[](const key_type& pair) const { return pair.first; } 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<typename Pair::second_type&, : public boost::put_get_helper<typename Pair::second_type&,
Second_of_pair_property_map<Pair> > Second_of_pair_property_map<Pair> >
{ {
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 typename Pair::second_type value_type; ///< typedef to `Pair::second_type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` 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<typename Pair::second_type&, : put_get_helper_pass_key_by_reference<typename Pair::second_type&,
Second_of_pair_property_map<Pair> > Second_of_pair_property_map<Pair> >
{ {
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 typename Pair::second_type value_type; ///< typedef to `Pair::first_type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag typedef boost::lvalue_property_map_tag category; ///< boost::lvalue_property_map_tag
/// Access a property map element. /// Access a property map element.
/// /// @param pair a key whose second item is accessed
/// @tparam pair a key whose second item is accessed
reference operator[](key_type& pair) const { return pair.second; } reference operator[](key_type& pair) const { return pair.second; }
/// Const version.
const value_type& operator[](const key_type& pair) const { return pair.second; } 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<typename boost::tuples::element<N,Tuple>::type&, : public boost::put_get_helper<typename boost::tuples::element<N,Tuple>::type&,
Nth_of_tuple_property_map<N,Tuple> > Nth_of_tuple_property_map<N,Tuple> >
{ {
typedef Tuple* key_type; ///< typedef to 'Tuple*' typedef Tuple* key_type; ///< typedef to `Tuple*`
typedef typename boost::tuples::element<N,Tuple>::type value_type; ///< typedef to `boost::tuples::element<N,Tuple>::%type` typedef typename boost::tuples::element<N,Tuple>::type value_type; ///< typedef to `boost::tuples::element<N,Tuple>::%type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` 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<typename boost::tuples::element<N,Tuple>::type&, : put_get_helper_pass_key_by_reference<typename boost::tuples::element<N,Tuple>::type&,
Nth_of_tuple_property_map<N,Tuple> > Nth_of_tuple_property_map<N,Tuple> >
{ {
typedef Tuple key_type; ///< typedef to 'Tuple' typedef Tuple key_type; ///< typedef to `Tuple`
typedef typename boost::tuples::element<N,Tuple>::type value_type; ///< typedef to `boost::tuples::element<N,Tuple>::%type` typedef typename boost::tuples::element<N,Tuple>::type value_type; ///< typedef to `boost::tuples::element<N,Tuple>::%type`
typedef value_type& reference; ///< typedef to `value_type&` typedef value_type& reference; ///< typedef to `value_type&`
typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag` typedef boost::lvalue_property_map_tag category; ///< `boost::lvalue_property_map_tag`
/// Access a property map element. /// Access a property map element.
/// /// @param tuple a key whose Nth item is accessed
/// @tparam tuple a key whose Nth item is accessed
reference operator[](key_type& tuple) const { return tuple.template get<N>(); } reference operator[](key_type& tuple) const { return tuple.template get<N>(); }
/// Const version.
const value_type& operator[](const key_type& tuple) const { return tuple.template get<N>(); } const value_type& operator[](const key_type& tuple) const { return tuple.template get<N>(); }
}; };

12
Point_set_processing_3/include/CGAL/radial_orient_normals.h
View File

@ -58,8 +58,8 @@ ForwardIterator
radial_orient_normals( radial_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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.
NormalPMap normal_pmap, ///< property map ForwardIterator -> Vector_3. NormalPMap normal_pmap, ///< property map: value_type of ForwardIterator -> Vector_3.
const Kernel& kernel) ///< geometric traits. const Kernel& kernel) ///< geometric traits.
{ {
CGAL_TRACE("Calls radial_orient_normals()\n"); CGAL_TRACE("Calls radial_orient_normals()\n");
@ -143,8 +143,8 @@ ForwardIterator
radial_orient_normals( radial_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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.
NormalPMap normal_pmap) ///< property map ForwardIterator -> Vector_3. NormalPMap normal_pmap) ///< property map: value_type of ForwardIterator -> Vector_3.
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
typedef typename Kernel_traits<Point>::Kernel Kernel; typedef typename Kernel_traits<Point>::Kernel Kernel;
@ -156,7 +156,7 @@ radial_orient_normals(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator, template <typename ForwardIterator,
typename NormalPMap typename NormalPMap
> >
@ -164,7 +164,7 @@ ForwardIterator
radial_orient_normals( radial_orient_normals(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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( return radial_orient_normals(
first,beyond, first,beyond,

6
Point_set_processing_3/include/CGAL/random_simplify_point_set.h
View File

@ -54,7 +54,7 @@ ForwardIterator
random_simplify_point_set( random_simplify_point_set(
ForwardIterator first, ///< iterator over the first input point. ForwardIterator first, ///< iterator over the first input point.
ForwardIterator beyond, ///< past-the-end iterator over the input points. 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. double removed_percentage, ///< percentage of points to remove.
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
{ {
@ -81,7 +81,7 @@ ForwardIterator
random_simplify_point_set( random_simplify_point_set(
ForwardIterator first, ///< iterator over the first input point ForwardIterator first, ///< iterator over the first input point
ForwardIterator beyond, ///< past-the-end iterator 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 double removed_percentage) ///< percentage of points to remove
{ {
typedef typename boost::property_traits<PointPMap>::value_type Point; typedef typename boost::property_traits<PointPMap>::value_type Point;
@ -95,7 +95,7 @@ random_simplify_point_set(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 ForwardIterator template <typename ForwardIterator
> >
ForwardIterator ForwardIterator

6
Point_set_processing_3/include/CGAL/remove_outliers.h
View File

@ -128,7 +128,7 @@ InputIterator
remove_outliers( remove_outliers(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
double threshold_percent, ///< percentage of points to remove. double threshold_percent, ///< percentage of points to remove.
const Kernel& /*kernel*/) ///< geometric traits. const Kernel& /*kernel*/) ///< geometric traits.
@ -215,7 +215,7 @@ InputIterator
remove_outliers( remove_outliers(
InputIterator first, ///< iterator over the first input point InputIterator first, ///< iterator over the first input point
InputIterator beyond, ///< past-the-end iterator 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. unsigned int k, ///< number of neighbors.
double threshold_percent) ///< percentage of points to remove double threshold_percent) ///< percentage of points to remove
{ {
@ -230,7 +230,7 @@ remove_outliers(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 template <typename InputIterator
> >
InputIterator InputIterator

6
Point_set_processing_3/include/CGAL/remove_outliers_wrt_median_knn_sq_distance.h
View File

@ -125,7 +125,7 @@ InputIterator
remove_outliers_wrt_median_knn_sq_distance( remove_outliers_wrt_median_knn_sq_distance(
InputIterator first, ///< iterator over the first input point. InputIterator first, ///< iterator over the first input point.
InputIterator beyond, ///< past-the-end iterator over the input points. 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. unsigned int k, ///< number of neighbors.
double threshold_percent, ///< percentage of points to remove. double threshold_percent, ///< percentage of points to remove.
const Kernel& kernel) ///< geometric traits. const Kernel& kernel) ///< geometric traits.
@ -213,7 +213,7 @@ InputIterator
remove_outliers_wrt_median_knn_sq_distance( remove_outliers_wrt_median_knn_sq_distance(
InputIterator first, ///< iterator over the first input point InputIterator first, ///< iterator over the first input point
InputIterator beyond, ///< past-the-end iterator 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. unsigned int k, ///< number of neighbors.
double threshold_percent) ///< percentage of points to remove double threshold_percent) ///< percentage of points to remove
{ {
@ -228,7 +228,7 @@ remove_outliers_wrt_median_knn_sq_distance(
/// @endcond /// @endcond
/// @cond SKIP_IN_MANUAL /// @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 template <typename InputIterator
> >
InputIterator InputIterator