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

fix linking to barycenter and centroid in PCA

This commit is contained in:
Sébastien Loriot 2013-01-08 15:59:21 +01:00
parent 0aaa77de4a
commit b6c2d31d40
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h
View File

@ -14,11 +14,11 @@ weighted points. The user can also optionally pass an explicit kernel,
in case the default, based on `Kernel_traits` is not sufficient. The in case the default, based on `Kernel_traits` is not sufficient. The
dimension is also deduced automatically. dimension is also deduced automatically.
\sa `CGAL::centroid`
*/ */
/// @{ /// @{
/*! /*!
computes the barycenter of a non-empty set of 2D or 3D weighted computes the barycenter of a non-empty set of 2D or 3D weighted
points. points.
@ -34,6 +34,10 @@ CGAL::Kernel_traits<
`std::pair<K::Point_2, K::FT>` or `std::pair<K::Point_3, K::FT>`. `std::pair<K::Point_2, K::FT>` or `std::pair<K::Point_3, K::FT>`.
\pre first != beyond, and the sum of the weights is non-zero. \pre first != beyond, and the sum of the weights is non-zero.
\sa `CGAL::centroid()`
\sa \link barycenter `CGAL::barycenter()` \endlink
*/ */
template < typename InputIterator > template < typename InputIterator >
Deduced Deduced
@ -50,6 +54,10 @@ the input values.
`std::pair<K::Point_2, K::FT>` or `std::pair<K::Point_3, K::FT>`. `std::pair<K::Point_2, K::FT>` or `std::pair<K::Point_3, K::FT>`.
\pre first != beyond, and the sum of the weights is non-zero. \pre first != beyond, and the sum of the weights is non-zero.
\sa `CGAL::centroid()`
\sa \link barycenter `CGAL::barycenter()` \endlink
*/ */
template < typename InputIterator, typename K > template < typename InputIterator, typename K >
Deduced Deduced

10
Principal_component_analysis/doc/Principal_component_analysis/CGAL/centroid.h
View File

@ -20,8 +20,6 @@ computes the centroid of the tetrahedron edges (3D segments) and
specifying a dimension 2 computes the centroid of the tetrahedron specifying a dimension 2 computes the centroid of the tetrahedron
facets (3D triangles). facets (3D triangles).
\sa \ref barycenter
*/ */
/// @{ /// @{
@ -53,6 +51,10 @@ The value type must be either `K::Point_3`, `K::Segment_3`,
of balls the user must call the function with value type `K::Sphere_3` of balls the user must call the function with value type `K::Sphere_3`
and with dimension tag of 3. The tag must range between and with dimension tag of 3. The tag must range between
`Dimension_tag<0>` and `Dimension_tag<3>`. `Dimension_tag<0>` and `Dimension_tag<3>`.
\sa `CGAL::barycenter()`
\sa \link centroid `CGAL::centroid()` \endlink
*/ */
template < typename InputIterator, typename Tag > template < typename InputIterator, typename Tag >
Deduced Deduced
@ -82,6 +84,10 @@ The value type must be either `K::Point_3`, `K::Segment_3`,
of balls the user must call the function with value type `K::Sphere_3` of balls the user must call the function with value type `K::Sphere_3`
and with dimension tag of 3. The tag must range between and with dimension tag of 3. The tag must range between
`Dimension_tag<0>` and `Dimension_tag<3>`. `Dimension_tag<0>` and `Dimension_tag<3>`.
\sa `CGAL::barycenter()`
\sa \link centroid `CGAL::centroid()` \endlink
*/ */
template < typename InputIterator, typename K, typename Tag > template < typename InputIterator, typename K, typename Tag >
Deduced Deduced