diff options
author | fgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-09-26 12:55:44 +0000 |
---|---|---|
committer | fgodi <fgodi@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-09-26 12:55:44 +0000 |
commit | 9ffc108705ace9910cabc79225d984fe1d15b794 (patch) | |
tree | c96922f4ad8258a828c74dfa2fd8e73943efb172 /src | |
parent | 15d87e9270fa40273c6cfcd707ac0dde01f0373e (diff) |
tentative ajout documentation bottleneck
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/bottleneck_integration@1567 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 5177eb3197263cfe272f981439317cdb4e8909c3
Diffstat (limited to 'src')
-rw-r--r-- | src/Bottleneck_distance/concept/Persistence_diagram.h | 8 | ||||
-rw-r--r-- | src/Bottleneck_distance/doc/Intro_bottleneck_distance.h | 40 | ||||
-rw-r--r-- | src/Bottleneck_distance/include/gudhi/Graph_matching.h | 3 |
3 files changed, 49 insertions, 2 deletions
diff --git a/src/Bottleneck_distance/concept/Persistence_diagram.h b/src/Bottleneck_distance/concept/Persistence_diagram.h index 27a258d8..bd90cc11 100644 --- a/src/Bottleneck_distance/concept/Persistence_diagram.h +++ b/src/Bottleneck_distance/concept/Persistence_diagram.h @@ -2,11 +2,19 @@ namespace Gudhi { namespace Bottleneck_distance { namespace Concept { +/** \brief Concept of persistence diagram point. The double first is the birth of the component and the double second is the death of the component. + * + * \ingroup bottleneck_distance + */ struct Diagram_point{ double first; double second; }; +/** \brief Concept of persistence diagram. + * + * \ingroup bottleneck_distance + */ struct Persistence_Diagram { const_iterator<Diagram_point> cbegin() const; diff --git a/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h new file mode 100644 index 00000000..2cf10975 --- /dev/null +++ b/src/Bottleneck_distance/doc/Intro_bottleneck_distance.h @@ -0,0 +1,40 @@ +/* This file is part of the Gudhi Library. The Gudhi library + * (Geometric Understanding in Higher Dimensions) is a generic C++ + * library for computational topology. + * + * Author(s): François Godi + * + * Copyright (C) 2015 INRIA Sophia-Antipolis (France) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef DOC_BOTTLENECK_DISTANCE_H_ +#define DOC_BOTTLENECK_DISTANCE_H_ + +// needs namespace for Doxygen to link on classes +namespace Gudhi { +// needs namespace for Doxygen to link on classes +namespace Bottleneck_distance { + +/** \defgroup bottleneck_distance Bottleneck distance + * + * \author François Godi + * + */ + +} // namespace Bottleneck_distance + +} // namespace Gudhi + diff --git a/src/Bottleneck_distance/include/gudhi/Graph_matching.h b/src/Bottleneck_distance/include/gudhi/Graph_matching.h index 69470067..7a8c8ee0 100644 --- a/src/Bottleneck_distance/include/gudhi/Graph_matching.h +++ b/src/Bottleneck_distance/include/gudhi/Graph_matching.h @@ -31,8 +31,7 @@ namespace Gudhi { namespace Bottleneck_distance { -/** \brief Function to use in order to compute the Bottleneck distance between two persistence diagrams. - * +/** \brief Function to use in order to compute the Bottleneck distance between two persistence diagrams. You get an additive e-approximation. * * * \ingroup bottleneck_distance |