diff --git a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h index c4df4d756cf..ae62ccc7815 100644 --- a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h +++ b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h @@ -64,8 +64,8 @@ std::pair< Data_type, bool> operator()(const Key_type& p); generates the interpolated function value computed by Farin's interpolant. -\pre `norm` \f$ \neq0\f$. `function_value(p).second == true` for all points `p` of the point/coordinate pairs in the range `[first, beyond). -\pre The range `[first, beyond)` contains either one or more than three element +\pre `norm` \f$ \neq0\f$. `function_value(p).second == true` for all points `p` of the point/coordinate pairs in the range `[first, beyond)`. +\pre The range `[first, beyond)` contains either one or more than three elements. The function `farin_c1_interpolation()` interpolates the function values and the gradients that are provided by functors using the method described in \cite f-sodt-90. diff --git a/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h b/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h index ec22697af44..33575ae129b 100644 --- a/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h +++ b/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h @@ -25,8 +25,8 @@ Only the following members of this traits class are used:
  • Additionally, `Traits` must meet the requirements for the traits class of the `polygon_area_2()` function. -
  • `OutputIterator::value_type` is equivalent to -`std::pair`, i.e. a pair +
  • The value type of `OutputIterator` is equivalent to +`std::pair`, i.e., a pair associating a point and its natural neighbor coordinate. @@ -50,15 +50,16 @@ value of the result triple is set to `false`. /*! computes the natural neighbor coordinates for `p` with respect to the -points in the two-dimensional Delaunay triangulation `dt`. The -template class `Dt` should be of type -`Delaunay_triangulation_2`. The value type of the -`OutputIterator` is a pair of `Dt::Point_2` and the coordinate value -of type `Dt::Geom_traits::FT`. The sequence of point/coordinate pairs +points in the two-dimensional Delaunay triangulation `dt`. + +\tparam Dt must be of type `Delaunay_triangulation_2`. +\tparam OutputIterator must have the value type `std::pair CGAL::Triple< @@ -68,8 +69,8 @@ natural_neighbor_coordinates_2( OutputIterator out, typename Dt::Face_handle start = typename Dt::Face_handle()); /*! -The same as above. `hole_begin` and `hole_end` determines the -iterator range over the boundary edges of the conflict zone of `p` in +The same as above. The iterator range `[hole_begin, hole_end)` determines +the boundary edges of the conflict zone of `p` in the triangulation. It is the result of the function \link Delaunay_triangulation_2::get_boundary_of_conflicts() `dt.get_boundary_of_conflicts(p,std::back_inserter(hole), start)`\endlink. @@ -81,7 +82,7 @@ bool > natural_neighbor_coordinates_2( OutputIterator out, EdgeIterator hole_begin, EdgeIterator hole_end); /*! -This function computes the natural neighbor coordinates of the point +computes the natural neighbor coordinates of the point `vh->point()` with respect to the vertices of `dt` excluding `vh->point()`. The same as above for the remaining parameters. */ diff --git a/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h b/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h index 09ba5765dd6..3ec1ebdf849 100644 --- a/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h +++ b/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h @@ -19,7 +19,7 @@ coordinates regular neighbor coordinates. concept `RegularTriangulationTraits_2`. It provides the number type `FT` which is a model for `FieldNumberType` and it must meet the requirements for the traits class of the -`polygon_area_2` function. A model of this traits class is +`polygon_area_2()` function. A model of this traits class is `Regular_triangulation_euclidean_traits_2`.
  • The value type of `OutputIterator` is equivalent to `std::pair`, i.e. a pair @@ -43,16 +43,19 @@ triple is set to `false`. /*! computes the regular neighbor coordinates for `p` with respect to the weighted points in the two-dimensional regular triangulation -`rt`. The template class `Rt` should be of type -`Regular_triangulation_2`. The value type of the -`OutputIterator` is a pair of `Rt::Weighted_point` and the -coordinate value of type `Rt::Geom_traits::FT`. The sequence of +`rt`. + +\tparam Rt must be a `Regular_triangulation_2`. +\tparam OutputIterator must have the value type +`std::pair CGAL::Triple< @@ -62,9 +65,8 @@ Rt::Weighted_point& p, OutputIterator out, typename Rt::Face_handle start = typename Rt::Face_handle()); /*! -The same as above. `hole_begin` and `hole_end` determines the iterator -range over the boundary edges of the conflict zone of `p` in the -triangulation `rt`. +The same as above. The iterator range `[hole_begin, hole_end)` determines +the boundary edges of the conflict zone of `p` in the triangulation `rt`. \link Regular_triangulation_2::hidden_vertices_begin() `rt.hidden_vertices_begin()`\endlink and \link Regular_triangulation_2::hidden_vertices_end() `rt.hidden_vertices_end()`\endlink determines the iterator range over the hidden vertices of the conflict @@ -80,7 +82,7 @@ hole_begin, EdgeIterator hole_end, VertexIterator hidden_vertices_begin, VertexIterator hidden_vertices_end); /*! -This function computes the regular neighbor coordinates of the point +computes the regular neighbor coordinates of the point `vh->point()` with respect to the vertices of `rt` excluding `vh->point()`. The same as above for the remaining parameters. */