summaryrefslogtreecommitdiff
path: root/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-10-12 13:09:43 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-10-12 13:09:43 +0000
commit05b163f41a8b2ee0b10b862b0c7497d3f6e9b4b3 (patch)
treea5d6d66f8b59a691a30c910c0f3ea9dd5e3369f9 /src/Toplex_map/include/gudhi/Filtered_toplex_map.h
parent4b619ec130bfa6cff47fbde47a732d890327f465 (diff)
Remove all documentation from user manual
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/toplex_map@3949 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: ef6f0dd7622590ae3d550162174120c2e0406cb7
Diffstat (limited to 'src/Toplex_map/include/gudhi/Filtered_toplex_map.h')
-rw-r--r--src/Toplex_map/include/gudhi/Filtered_toplex_map.h27
1 files changed, 9 insertions, 18 deletions
diff --git a/src/Toplex_map/include/gudhi/Filtered_toplex_map.h b/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
index ed65e36f..9a35b8b7 100644
--- a/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
+++ b/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
@@ -8,44 +8,35 @@
namespace Gudhi {
/** A Filtered_toplex_map represents the simplicial complex with a filtration.
- * A "toplex" is a critical simplex.
- * \ingroup toplex_map */
+ * A "toplex" is a critical simplex. */
class Filtered_toplex_map {
public:
- /** Vertex is the type of vertices.
- * \ingroup toplex_map */
+ /** Vertex is the type of vertices. */
typedef Toplex_map::Vertex Vertex;
- /** Simplex is the type of simplices.
- * \ingroup toplex_map */
+ /** Simplex is the type of simplices. */
typedef Toplex_map::Simplex Simplex;
- /** The type of the pointers to maximal simplices.
- * \ingroup toplex_map */
+ /** The type of the pointers to maximal simplices. */
typedef Toplex_map::Simplex_ptr Simplex_ptr;
- /** The type of the sets of Simplex_ptr.
- * \ingroup toplex_map */
+ /** The type of the sets of Simplex_ptr. */
typedef Toplex_map::Simplex_ptr_set Simplex_ptr_set;
- /** The type of the filtration values.
- * \ingroup toplex_map */
+ /** The type of the filtration values. */
typedef double Filtration_value;
/** Add a simplex and its subfaces with the given filtration value
- * in the Filtered_toplex_map.
- * \ingroup toplex_map */
+ * in the Filtered_toplex_map. */
template <typename Input_vertex_range>
std::pair<Simplex, bool> insert_simplex_and_subfaces(const Input_vertex_range &vertex_range, Filtration_value f = std::numeric_limits<double>::quiet_NaN());
- /** Gives the filtration of the input simplex.
- * \ingroup toplex_map */
+ /** Gives the filtration of the input simplex. */
template <typename Input_vertex_range>
Filtration_value filtration(const Input_vertex_range &vertex_range) const;
- /** Is the input simplex member of the complex ?
- * \ingroup toplex_map */
+ /** Is the input simplex member of the complex ? */
template <typename Input_vertex_range>
bool membership(const Input_vertex_range &vertex_range) const;