diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-04-10 16:06:27 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-04-10 16:06:27 +0000 |
| commit | be6997e1cb3b7e6feeb3ece37437f02e6c60a18b (patch) | |
| tree | d79d4ebba790f127fdc80b7729e1cc154fb71818 /src/common | |
| parent | 9afff26c8f15121aa58eb1a1beacffc2a38cd477 (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')
| -rw-r--r-- | src/common/include/gudhi/distance_functions.h | 22 | ||||
| -rw-r--r-- | src/common/include/gudhi/graph_simplicial_complex.h | 6 |
2 files changed, 26 insertions, 2 deletions
diff --git a/src/common/include/gudhi/distance_functions.h b/src/common/include/gudhi/distance_functions.h index 20b04000..9ab35fb1 100644 --- a/src/common/include/gudhi/distance_functions.h +++ b/src/common/include/gudhi/distance_functions.h @@ -75,11 +75,29 @@ class Euclidean_distance { * The points are assumed to have the same dimension. */ class Minimal_enclosing_ball_radius { public: + /** \brief Minimal_enclosing_ball_radius from two points. + * + * @param[in] point_1 First point. + * @param[in] point_2 second point. + * @return The minimal enclosing ball radius for the two points (aka. Euclidean distance / 2.). + * + * \tparam Point must be a range of Cartesian coordinates. + * + */ template< typename Point > typename std::iterator_traits<typename boost::range_iterator<Point>::type>::value_type - operator()(const Point& p1, const Point& p2) const { - return Euclidean_distance()(p1, p2) / 2.; + operator()(const Point& point_1, const Point& point_2) const { + return Euclidean_distance()(point_1, point_2) / 2.; } + /** \brief Minimal_enclosing_ball_radius from a point cloud. + * + * @param[in] point_cloud The points. + * @return The minimal enclosing ball radius for the points. + * + * \tparam Point_cloud must be a range of points with Cartesian coordinates. + * Point_cloud is a range over a range of Coordinate. + * + */ template< typename Point_cloud, typename Point_iterator = typename boost::range_const_iterator<Point_cloud>::type, typename Point= typename std::iterator_traits<Point_iterator>::value_type, 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 > |