summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/doc/Intro_alpha_complex.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-09-01 07:50:33 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-09-01 07:50:33 +0000
commit4b44247f14ddd84bf3e58ba53fe93a3e793f0ce4 (patch)
tree133f35778085227857b0351efe340e97d5dbec51 /src/Alpha_complex/doc/Intro_alpha_complex.h
parentcb82907d03e3f875a418efc52570970c01c2677d (diff)
Documentation fix (starts at 0 and not 1 + alpha shape was not correct)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alphashapes@765 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 99f8d4cd274778f5d7aac04afa84b780dc3678ec
Diffstat (limited to 'src/Alpha_complex/doc/Intro_alpha_complex.h')
-rw-r--r--src/Alpha_complex/doc/Intro_alpha_complex.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h
index 34af2b98..d266219b 100644
--- a/src/Alpha_complex/doc/Intro_alpha_complex.h
+++ b/src/Alpha_complex/doc/Intro_alpha_complex.h
@@ -35,7 +35,7 @@ namespace alphacomplex {
*
* Alpha_complex is a Simplex_tree constructed from each finite cell of a Delaunay Triangulation.
*
- * The filtration value of each simplex is computed from the alpha value of the simplex if it is Gabriel or
+ * The filtration value of each simplex is computed from the alpha square value of the simplex if it is Gabriel or
* from the alpha value of the simplex coface that makes the simplex not Gabriel.
*
* Please refer to \cite AlphaShapesDefinition for a more complete alpha complex definition.
@@ -54,7 +54,7 @@ namespace alphacomplex {
*
* When launching:
*
- * \code $> ./alphaoffreader ../../data/points/alphacomplexdoc.off
+ * \code $> ./alphaoffreader ../../data/points/alphacomplexdoc.off 60.0
* \endcode
*
* the program output is:
@@ -77,7 +77,7 @@ namespace alphacomplex {
* \For{i : dimension $\rightarrow$ 1}
* \ForAll{$\sigma$ of dimension i}
* \If {filtration($\sigma$) is NaN}
- * \State filtration($\sigma$) = $\alpha(\sigma)$
+ * \State filtration($\sigma$) = $\alpha^2(\sigma)$
* \EndIf
* \ForAll{$\tau$ face of $\sigma$} \Comment{propagate alpha filtration value}
* \If {filtration($\tau$) is not NaN}
@@ -105,8 +105,8 @@ namespace alphacomplex {
*
* \section alpha-shape Alpha shape
*
- * In the example above, the alpha shape of \f$\alpha_{74} < \alpha < \alpha_{73}\f$ is the alpha complex where the
- * \f$\alpha_{74} <\f$ filtration value \f$< \alpha_{73}\f$ as described in \cite AlphaShapesIntroduction
+ * In the example above, the alpha shape of \f$\alpha^2_{74} < \alpha^2 < \alpha^2_{73}\f$ is the alpha complex where the
+ * \f$\alpha^2_{74} <\f$ filtration value \f$< \alpha^2_{73}\f$ as described in \cite AlphaShapesIntroduction
*
* \image html "alpha_complex_doc_alpha_shape.png" "Alpha shape example"
* \copyright GNU General Public License v3.