From 854e61dc5f31ab4528c104119007276a81916293 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Wed, 28 Sep 2016 05:57:24 +0000 Subject: Fix bottleneck doxygen issues git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/bottleneck_integration@1574 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: d85f8399427bb2518650adaf5f9e849b53e13048 --- .../doc/Intro_bottleneck_distance.h | 6 +-- src/Doxyfile | 3 +- src/common/doc/main_page.h | 50 +++++++++++++++++----- 3 files changed, 44 insertions(+), 15 deletions(-) (limited to 'src') diff --git a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h index 795bcbea..00e614f6 100644 --- a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h +++ b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h @@ -30,17 +30,17 @@ namespace bottleneck_distance { /** \defgroup bottleneck_distance Bottleneck distance * - * \author François Godi + * \author François Godi * @{ * * \section bottleneckdefinition Definition * - * Bottleneck distance mesures the similarity between two persistence diagrams. + * Bottleneck distance measures the similarity between two persistence diagrams. * It's the shortest distance b for which there exists a perfect matching between * the points of the two diagrams (+ all the diagonal points) such that * any couple of matched points are at distance at most b. * - * \image html perturb_pd.png La bottleneck distance est la longueur de la plus longue arête. + * \image html perturb_pd.png Bottleneck distance is the length of the longest edge. * */ /** @} */ // end defgroup bottleneck_distance diff --git a/src/Doxyfile b/src/Doxyfile index dd9a33fb..db77d69d 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -845,7 +845,8 @@ IMAGE_PATH = doc/Skeleton_blocker/ \ doc/Simplex_tree/ \ doc/Persistent_cohomology/ \ doc/Witness_complex/ \ - doc/Bitmap_cubical_complex/ + doc/Bitmap_cubical_complex/ \ + doc/Bottleneck_distance/ # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 21cf6925..76401724 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -28,6 +28,7 @@ Author: Vincent Rouvreau
Introduced in: GUDHI 1.3.0
Copyright: GPL v3
+ Requires: \ref cgal ≥ 4.7.0 and \ref eigen3 Alpha_complex is a simplicial complex constructed from the finite cells of a Delaunay Triangulation.
@@ -111,6 +112,26 @@ \section Toolbox Toolbox + \subsection BottleneckDistanceToolbox Bottleneck distance + \image html "perturb_pd.png" "Bottleneck distance is the length of the longest edge" + + + + + +
+ Author: François Godi
+ Introduced in: GUDHI 1.4.0
+ Copyright: GPL v3
+ Requires: \ref cgal ≥ 4.8.0 and \ref eigen3 + 		+ Bottleneck distance measures the similarity between two persistence diagrams. + It's the shortest distance b for which there exists a perfect matching between + the points of the two diagrams (+ all the diagonal points) such that + any couple of matched points are at distance at most b. +
+ User manual: \ref bottleneck_distance +
\subsection ContractionToolbox Contraction \image html "sphere_contraction_representation.png" "Sphere contraction example" @@ -177,7 +198,7 @@ make \endverbatim * \verbatim make test \endverbatim * * \section optionallibrary Optional third-party library - * \subsection gmp GMP: + * \subsection gmp GMP * The multi-field persistent homology algorithm requires GMP which is a free library for arbitrary-precision * arithmetic, operating on signed integers, rational numbers, and floating point numbers. * @@ -190,11 +211,11 @@ make \endverbatim * * Having GMP version 4.2 or higher installed is recommended. * - * \subsection cgal CGAL: - * The \ref alpha_complex data structure and few examples requires CGAL, which is a C++ library which provides easy - * access to efficient and reliable geometric algorithms. + * \subsection cgal CGAL + * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ + * library which provides easy access to efficient and reliable geometric algorithms. * - * Having CGAL version 4.4 or higher installed is recommended. The procedure to install this library according to + * Having CGAL version 4.4.0 or higher installed is recommended. The procedure to install this library according to * your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html * * The following examples require the Computational Geometry Algorithms @@ -204,11 +225,11 @@ make \endverbatim * \li * Simplex_tree/simplex_tree_from_alpha_shapes_3.cpp * - * The following example requires CGAL version ≥ 4.6: + * The following example requires CGAL version ≥ 4.6.0: * \li * Witness_complex/witness_complex_sphere.cpp * - * The following example requires CGAL version ≥ 4.7: + * The following example requires CGAL version ≥ 4.7.0: * \li * Alpha_complex/Alpha_complex_from_off.cpp * \li @@ -220,7 +241,11 @@ make \endverbatim * \li * Persistent_cohomology/custom_persistence_sort.cpp * - * \subsection eigen3 Eigen3: + * The following example requires CGAL version ≥ 4.8.0: + * \li + * + * Bottleneck_distance/bottleneck_example.cpp + * \subsection eigen3 Eigen3 * The \ref alpha_complex data structure and few examples requires * Eigen3 is a C++ template library for linear algebra: * matrices, vectors, numerical solvers, and related algorithms. @@ -228,9 +253,11 @@ make \endverbatim * The following example requires the Eigen3 and will not be * built if Eigen3 is not installed: * \li - * Alpha_complex/Alpha_complex_from_off.cpp (requires also Eigen3) + * Alpha_complex/Alpha_complex_from_off.cpp * \li - * Alpha_complex/Alpha_complex_from_points.cpp (requires also Eigen3) + * Alpha_complex/Alpha_complex_from_points.cpp + * \li + * Bottleneck_distance/bottleneck_example.cpp * \li * Persistent_cohomology/alpha_complex_persistence.cpp * \li @@ -238,7 +265,7 @@ make \endverbatim * \li * Persistent_cohomology/custom_persistence_sort.cpp * - * \subsection tbb Threading Building Blocks: + * \subsection tbb Threading Building Blocks * Intel® TBB lets you easily write parallel * C++ programs that take full advantage of multicore performance, that are portable and composable, and that have * future-proof scalability. @@ -312,6 +339,7 @@ make \endverbatim /*! @file Examples * @example Alpha_complex/Alpha_complex_from_off.cpp * @example Alpha_complex/Alpha_complex_from_points.cpp + * @example Bottleneck_distance/bottleneck_example.cpp * @example Bitmap_cubical_complex/Bitmap_cubical_complex.cpp * @example Bitmap_cubical_complex/Bitmap_cubical_complex_periodic_boundary_conditions.cpp * @example Bitmap_cubical_complex/Random_bitmap_cubical_complex.cpp -- cgit v1.2.3