summaryrefslogtreecommitdiff
path: root/include/gudhi/graph_simplicial_complex.h
diff options
context:
space:
mode:
authorGard Spreemann <gspreemann@gmail.com>2018-06-15 12:34:03 +0200
committerGard Spreemann <gspreemann@gmail.com>2018-06-15 12:34:03 +0200
commit41482b4260b4aff3d6803e340d5c94fbefb9af67 (patch)
tree89eae43dcb3fd4ab040e96f3d5479427d8cd2c7f /include/gudhi/graph_simplicial_complex.h
parent41a1b8c2728e212c832c0384c8bb424139a247cf (diff)
parentc524232f734de875d69e2f190f01a6c976024368 (diff)
Merge branch 'upstream/latest' into dfsg/latest
Diffstat (limited to 'include/gudhi/graph_simplicial_complex.h')
-rw-r--r--include/gudhi/graph_simplicial_complex.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/gudhi/graph_simplicial_complex.h b/include/gudhi/graph_simplicial_complex.h
index d84421b2..49fe56cc 100644
--- a/include/gudhi/graph_simplicial_complex.h
+++ b/include/gudhi/graph_simplicial_complex.h
@@ -4,7 +4,7 @@
*
* Author(s): Clément Maria
*
- * Copyright (C) 2014 INRIA
+ * Copyright (C) 2014 Inria
*
* 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
@@ -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 >