From c4ae5ea265963228767d08fc54ef7877e64ebf8a Mon Sep 17 00:00:00 2001 From: Ankit Gupta Date: Wed, 27 Jun 2007 16:04:25 +0000 Subject: [PATCH] Updated documentation --- .../doc_tex/Principal_component_analysis_ref/centroid.tex | 4 ++-- .../doc_tex/Principal_component_analysis_ref/intro.tex | 2 +- .../linear_least_squares_fitting_3.tex | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/centroid.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/centroid.tex index 19cc8025ed9..4c0be906fd5 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/centroid.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/centroid.tex @@ -40,7 +40,7 @@ specifying the type of manifold of the objects. \ccFunction{template < typename InputIterator, typename Tag > K::Point_3 centroid(InputIterator first, InputIterator beyond, const Tag& t);} -{ computes the centroid of a non-empty set of 3D points having a manifold described by t. +{ computes the centroid of a non-empty set of 3D objects having a manifold described by t. \ccc{K} is \ccc{Kernel_traits::value_type>::Kernel}. The value type must be \ccc{K::Point_3}. \ccPrecond{first != beyond.} } @@ -48,7 +48,7 @@ specifying the type of manifold of the objects. \ccFunction{template < typename InputIterator, typename K, typename Tag > K::Point_3 centroid(InputIterator first, InputIterator beyond, const K & k, const Tag& t);} -{ computes the centroid of a non-empty set of 3D points having a manifold described by t. +{ computes the centroid of a non-empty set of 3D objects having a manifold described by t. The value type must be \ccc{K::Point_3}. \ccPrecond{first != beyond.} } diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/intro.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/intro.tex index 3f317bb1ca5..c33b0a28f95 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/intro.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/intro.tex @@ -9,7 +9,7 @@ \ccRefChapter{Principal Component Analysis\label{ref_chapter_pca}} -\ccChapterAuthor{Pierre Alliez and Sylvain Pion and Ankit Gupta} +\ccChapterAuthor{Pierre Alliez, Sylvain Pion and Ankit Gupta} diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/linear_least_squares_fitting_3.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/linear_least_squares_fitting_3.tex index 0b9488fef27..f15034d0a80 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/linear_least_squares_fitting_3.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/linear_least_squares_fitting_3.tex @@ -28,7 +28,7 @@ sub-space. typename K::Point_3 & centroid, const K & k, const Tag& t);} -{ computes the best fitting 3D line of a 3D point set or triangle set in the range +{ computes the best fitting 3D line of a 3D object set in the range [\ccc{first},\ccc{beyond}). The value returned is a fitting quality between $0$ and $1$, where $0$ means that the variance is the same along any line (a horizontal line going through the centroid is output @@ -60,7 +60,7 @@ The tag \ccc{t} identifies the type of manifold of the objects in the object set typename K::Point_3 & centroid, const K & k, const Tag& t);} -{ computes the best fitting 3D plane of a 3D point set or triangle set in the range +{ computes the best fitting 3D plane of a 3D object set in the range [\ccc{first},\ccc{beyond}). The value returned is a fitting quality between $0$ and $1$, where $0$ means that the variance is the same along any plane (a horizontal plane going through the centroid is output