improve wording concerning value_type

This commit is contained in:
Andreas Fabri 2015-02-05 14:53:01 +01:00
parent f1bd6f1627
commit 1e99228829
15 changed files with 46 additions and 46 deletions

View File

@ -19,7 +19,7 @@ typedef std::pair<Point, Vector> PointVectorPair;
int main(int argc, char* argv[]) int main(int argc, char* argv[])
{ {
const char* input_filename = (argc>1)?argv[1]:"data/before_upsample.xyz"; const char* input_filename = (argc>1)?argv[1]:"data/before_upsample.xyz";
const char* output_filename = (argc>1)?argv[1]:"data/before_upsample_UPSAMPLED.xyz"; const char* output_filename = (argc>2)?argv[2]:"data/before_upsample_UPSAMPLED.xyz";
// Reads a .xyz point set file in points[], *with normals*. // Reads a .xyz point set file in points[], *with normals*.
std::vector<PointVectorPair> points; std::vector<PointVectorPair> points;

View File

@ -99,10 +99,10 @@ compute_average_spacing(const typename Kernel::Point_3& query, ///< 3D point who
/// \pre `k >= 2.` /// \pre `k >= 2.`
/// ///
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if InputIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value typ of `PointPMap`.
/// ///
/// @return average spacing (scalar). /// @return average spacing (scalar).

View File

@ -285,7 +285,7 @@ update_new_point(
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` /// @tparam PointPMap is a model of `ReadablePropertyMap`
/// with the value type of `ForwardIterator` as key and `Kernel::Point_3` as value type. /// with the value type of `ForwardIterator` as key and `Kernel::Point_3` as value type.
/// It can be omitted if ForwardIterator::value_type is convertible to /// It can be omitted if the value type of `ForwardIterator` is convertible to
/// `Kernel::Point_3`. /// `Kernel::Point_3`.
/// @tparam NormalPMap is a model of `ReadablePropertyMap` with the value type of `ForwardIterator` as key /// @tparam NormalPMap is a model of `ReadablePropertyMap` with the value type of `ForwardIterator` as key
/// and `Kernel::Vector_3` as value type. /// and `Kernel::Vector_3` as value type.

View File

@ -142,10 +142,10 @@ public:
/// \pre `epsilon > 0` /// \pre `epsilon > 0`
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator::value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// ///
/// @return iterator over the first point to remove. /// @return iterator over the first point to remove.

View File

@ -205,10 +205,10 @@ improved_jet_smooth_point(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadWritePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename ForwardIterator, template <typename ForwardIterator,

View File

@ -196,10 +196,10 @@ improved_laplacian_smooth_point(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadWritePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value_type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename ForwardIterator, template <typename ForwardIterator,

View File

@ -119,13 +119,13 @@ jet_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute
/// ///
/// ///
/// @tparam ForwardIterator iterator model of the concept of the same name over input points and able to store output normals. /// @tparam ForwardIterator iterator model of the concept of the same name over input points and able to store output normals.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator::value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam NormalPMap is a model of `WritablePropertyMap` with a value_type = Vector_3<Kernel>. /// @tparam NormalPMap is a model of `WritablePropertyMap` with value type `Vector_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// @tparam SvdTraits template parameter for the class `Monge_via_jet_fitting` that /// @tparam SvdTraits template parameter for the class `Monge_via_jet_fitting` that
/// can be ommited in conditions described in the documentation of `Monge_via_jet_fitting`. /// can be ommited under conditions described in the documentation of `Monge_via_jet_fitting`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename ForwardIterator, template <typename ForwardIterator,

View File

@ -119,12 +119,12 @@ jet_smooth_point(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadWritePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if InputIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// @tparam SvdTraits template parameter for the class `Monge_via_jet_fitting` that /// @tparam SvdTraits template parameter for the class `Monge_via_jet_fitting` that
/// can be ommited in conditions described in the documentation of `Monge_via_jet_fitting`. /// can be ommited under conditions described in the documentation of `Monge_via_jet_fitting`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename InputIterator, template <typename InputIterator,

View File

@ -110,11 +110,11 @@ pca_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator::value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam NormalPMap is a model of `WritablePropertyMap` with a value_type = Vector_3<Kernel>. /// @tparam NormalPMap is a model of `WritablePropertyMap` with value type `Vector_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename ForwardIterator, template <typename ForwardIterator,

View File

@ -111,10 +111,10 @@ pca_smooth_point(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadWritePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if InputIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
// This variant requires all parameters. // This variant requires all parameters.
template <typename InputIterator, template <typename InputIterator,

View File

@ -43,11 +43,11 @@ namespace CGAL {
/// \pre normals must be unit vectors /// \pre normals must be unit vectors
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam NormalPMap is a model of `ReadWritePropertyMap` with a value_type = Vector_3<Kernel>. /// @tparam NormalPMap is a model of `ReadWritePropertyMap` with value type `Vector_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// ///
/// @return iterator over the first point with an unoriented normal. /// @return iterator over the first point with an unoriented normal.

View File

@ -39,10 +39,10 @@ namespace CGAL {
/// For this reason it should not be called on sorted containers. /// For this reason it should not be called on sorted containers.
/// ///
/// @tparam ForwardIterator iterator over input points. /// @tparam ForwardIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if ForwardIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// ///
/// @return iterator over the first point to remove. /// @return iterator over the first point to remove.

View File

@ -112,10 +112,10 @@ compute_avg_knn_sq_distance_3(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if InputIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted ifthe value type of InputIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// ///
/// @return iterator over the first point to remove. /// @return iterator over the first point to remove.

View File

@ -109,10 +109,10 @@ compute_median_knn_sq_distance_3(
/// \pre `k >= 2` /// \pre `k >= 2`
/// ///
/// @tparam InputIterator iterator over input points. /// @tparam InputIterator iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` with a value_type = Point_3<Kernel>. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3<Kernel>`.
/// It can be omitted if InputIterator value_type is convertible to Point_3<Kernel>. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3<Kernel>`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from PointPMap value_type. /// It can be omitted and deduced automatically from the value type of `PointPMap`.
/// ///
/// @return iterator over the first point to remove. /// @return iterator over the first point to remove.

View File

@ -411,11 +411,11 @@ public:
/// It must accept objects of type `Kernel::Point_3`. /// It must accept objects of type `Kernel::Point_3`.
/// @tparam RandomAccessIterator Iterator over input points. /// @tparam RandomAccessIterator Iterator over input points.
/// @tparam PointPMap is a model of `ReadablePropertyMap` /// @tparam PointPMap is a model of `ReadablePropertyMap`
/// with the value type of `ForwardIterator` as key and `Kernel::Point_3` as value type. /// with the value type of `ForwardIterator` as key type and `Kernel::Point_3` as value type.
/// It can be omitted if RandomAccessIterator value_type is convertible /// It can be omitted if the value type of ` RandomAccessIterator` is convertible
/// to `Kernel::Point_3`. /// to `Kernel::Point_3`.
/// @tparam Kernel Geometric traits class. /// @tparam Kernel Geometric traits class.
/// It can be omitted and deduced automatically from the value type of `PointPMap` /// It can be omitted and deduced automatically from the value type of `PointPMap`
/// using `Kernel_traits`. /// using `Kernel_traits`.
// This variant requires all parameters. // This variant requires all parameters.