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

polish doc in Interpolation

This commit is contained in:
Andreas Fabri 2013-01-17 18:05:41 +01:00
parent ca27d04e4d
commit 19a3cc48fd
3 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Interpolation/doc/Interpolation/CGAL/interpolation_functions.h
View File

@ -64,8 +64,8 @@ std::pair< Data_type, bool> operator()(const Key_type& p);
generates the interpolated function value computed by Farin's interpolant. 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 `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 The range `[first, beyond)` contains either one or more than three elements.
The function `farin_c1_interpolation()` interpolates the function values and the 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. gradients that are provided by functors using the method described in \cite f-sodt-90.

23
Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h
View File

@ -25,8 +25,8 @@ Only the following members of this traits class are used:
<LI>Additionally, `Traits` must meet the requirements for <LI>Additionally, `Traits` must meet the requirements for
the traits class of the `polygon_area_2()` function. the traits class of the `polygon_area_2()` function.
</UL> </UL>
<LI>`OutputIterator::value_type` is equivalent to <LI>The value type of `OutputIterator` is equivalent to
`std::pair<Dt::Point_2, Dt::Geom_traits::FT>`, i.e. a pair `std::pair<Dt::Point_2, Dt::Geom_traits::FT>`, i.e., a pair
associating a point and its natural neighbor coordinate. associating a point and its natural neighbor coordinate.
</OL> </OL>
@ -50,15 +50,16 @@ value of the result triple is set to `false`.
/*! /*!
computes the natural neighbor coordinates for `p` with respect to the computes the natural neighbor coordinates for `p` with respect to the
points in the two-dimensional Delaunay triangulation `dt`. The points in the two-dimensional Delaunay triangulation `dt`.
template class `Dt` should be of type
`Delaunay_triangulation_2<Traits, Tds>`. The value type of the \tparam Dt must be of type `Delaunay_triangulation_2<Traits, Tds>`.
`OutputIterator` is a pair of `Dt::Point_2` and the coordinate value \tparam OutputIterator must have the value type `std::pair<Dt::Point_2, Dt::Geom_traits::FT`.
of type `Dt::Geom_traits::FT`. The sequence of point/coordinate pairs
The sequence of point/coordinate pairs
that is computed by the function is placed starting at `out`. The that is computed by the function is placed starting at `out`. The
function returns a triple with an iterator that is placed past-the-end function returns a triple with an iterator that is placed past-the-end
of the resulting sequence of point/coordinate pairs, the normalization of the resulting sequence of point/coordinate pairs, the normalization
factor of the coordinates and a Boolean value which is set to true iff factor of the coordinates and a Boolean value which is set to `true` iff
the coordinate computation was successful. the coordinate computation was successful.
*/ */
template < class Dt, class OutputIterator > CGAL::Triple< template < class Dt, class OutputIterator > CGAL::Triple<
@ -68,8 +69,8 @@ natural_neighbor_coordinates_2(
OutputIterator out, typename Dt::Face_handle start = typename Dt::Face_handle()); OutputIterator out, typename Dt::Face_handle start = typename Dt::Face_handle());
/*! /*!
The same as above. `hole_begin` and `hole_end` determines the The same as above. The iterator range `[hole_begin, hole_end)` determines
iterator range over the boundary edges of the conflict zone of `p` in the boundary edges of the conflict zone of `p` in
the triangulation. It is the result of the function the triangulation. It is the result of the function
\link Delaunay_triangulation_2::get_boundary_of_conflicts() \link Delaunay_triangulation_2::get_boundary_of_conflicts()
`dt.get_boundary_of_conflicts(p,std::back_inserter(hole), start)`\endlink. `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); 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()` with respect to the vertices of `dt` excluding
`vh->point()`. The same as above for the remaining parameters. `vh->point()`. The same as above for the remaining parameters.
*/ */

26
Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h
View File

@ -19,7 +19,7 @@ coordinates regular neighbor coordinates.
concept `RegularTriangulationTraits_2`. It provides the number concept `RegularTriangulationTraits_2`. It provides the number
type `FT` which is a model for `FieldNumberType` and it must type `FT` which is a model for `FieldNumberType` and it must
meet the requirements for the traits class of the 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<K, Weight>`. `Regular_triangulation_euclidean_traits_2<K, Weight>`.
<LI>The value type of `OutputIterator` is equivalent to <LI>The value type of `OutputIterator` is equivalent to
`std::pair<Rt::Weighted_point, Rt::Geom_traits::FT>`, i.e. a pair `std::pair<Rt::Weighted_point, Rt::Geom_traits::FT>`, i.e. a pair
@ -43,16 +43,19 @@ triple is set to `false`.
/*! /*!
computes the regular neighbor coordinates for `p` with respect computes the regular neighbor coordinates for `p` with respect
to the weighted points in the two-dimensional regular triangulation to the weighted points in the two-dimensional regular triangulation
`rt`. The template class `Rt` should be of type `rt`.
`Regular_triangulation_2<Traits, Tds>`. The value type of the
`OutputIterator` is a pair of `Rt::Weighted_point` and the \tparam Rt must be a `Regular_triangulation_2<Traits, Tds>`.
coordinate value of type `Rt::Geom_traits::FT`. The sequence of \tparam OutputIterator must have the value type
`std::pair<Rt::Weighted_point, Rt::Geom_traits::FT`. The sequence of
point/coordinate pairs that is computed by the function is placed point/coordinate pairs that is computed by the function is placed
starting at `out`. The function returns a triple with an starting at `out`.
The function returns a triple with an
iterator that is placed past-the-end of the resulting sequence of iterator that is placed past-the-end of the resulting sequence of
point/coordinate pairs, the normalization factor of the coordinates point/coordinate pairs, the normalization factor of the coordinates
and a Boolean value which is set to true iff the coordinate and a Boolean value which is set to `true`, iff the coordinate
computation was successful, i.e. if `p` lies inside the computation was successful, i.e., if `p` lies inside the
convex hull of the points in `rt`. convex hull of the points in `rt`.
*/ */
template < class Rt, class OutputIterator > CGAL::Triple< template < class Rt, class OutputIterator > CGAL::Triple<
@ -62,9 +65,8 @@ Rt::Weighted_point& p, OutputIterator out, typename
Rt::Face_handle start = typename Rt::Face_handle()); Rt::Face_handle start = typename Rt::Face_handle());
/*! /*!
The same as above. `hole_begin` and `hole_end` determines the iterator The same as above. The iterator range `[hole_begin, hole_end)` determines
range over the boundary edges of the conflict zone of `p` in the the boundary edges of the conflict zone of `p` in the triangulation `rt`.
triangulation `rt`.
\link Regular_triangulation_2::hidden_vertices_begin() `rt.hidden_vertices_begin()`\endlink and \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 \link Regular_triangulation_2::hidden_vertices_end() `rt.hidden_vertices_end()`\endlink
determines the iterator range over the hidden vertices of the conflict 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); 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()` with respect to the vertices of `rt` excluding
`vh->point()`. The same as above for the remaining parameters. `vh->point()`. The same as above for the remaining parameters.
*/ */