summaryrefslogtreecommitdiff
path: root/src/common/include/gudhi/graph_simplicial_complex.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-10 16:06:27 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-10 16:06:27 +0000
commitbe6997e1cb3b7e6feeb3ece37437f02e6c60a18b (patch)
treed79d4ebba790f127fdc80b7729e1cc154fb71818 /src/common/include/gudhi/graph_simplicial_complex.h
parent9afff26c8f15121aa58eb1a1beacffc2a38cd477 (diff)
Doc review : Gudhi::Proximity_graph and Gudhi::Radius_distance must be links in the doc
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cechcomplex_vincent@3370 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: fc57faf137316ae07e06491482e0756fbacaf479
Diffstat (limited to 'src/common/include/gudhi/graph_simplicial_complex.h')
-rw-r--r--src/common/include/gudhi/graph_simplicial_complex.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/common/include/gudhi/graph_simplicial_complex.h b/src/common/include/gudhi/graph_simplicial_complex.h
index d84421b2..a6126182 100644
--- a/src/common/include/gudhi/graph_simplicial_complex.h
+++ b/src/common/include/gudhi/graph_simplicial_complex.h
@@ -42,6 +42,12 @@ struct vertex_filtration_t {
typedef boost::vertex_property_tag kind;
};
+/** \brief Proximity_graph contains the vertices and edges with their filtration values in order to store the result
+ * of `Gudhi::compute_proximity_graph` function.
+ *
+ * \tparam SimplicialComplexForProximityGraph furnishes `Filtration_value` type definition.
+ *
+ */
template <typename SimplicialComplexForProximityGraph>
using Proximity_graph = typename boost::adjacency_list < boost::vecS, boost::vecS, boost::undirectedS
, boost::property < vertex_filtration_t, typename SimplicialComplexForProximityGraph::Filtration_value >