From 342a72ccb89f42109e709ae087d01fa6dcf98e39 Mon Sep 17 00:00:00 2001 From: glisse Date: Fri, 26 Jan 2018 10:22:30 +0000 Subject: doc for epsilon git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/sparserips-glisse@3162 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 02ec0665d288e7e68959aa188cd291924a7d1c8f --- src/Rips_complex/include/gudhi/Sparse_rips_complex.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/Rips_complex/include/gudhi/Sparse_rips_complex.h') diff --git a/src/Rips_complex/include/gudhi/Sparse_rips_complex.h b/src/Rips_complex/include/gudhi/Sparse_rips_complex.h index c5378b6e..e1e3a951 100644 --- a/src/Rips_complex/include/gudhi/Sparse_rips_complex.h +++ b/src/Rips_complex/include/gudhi/Sparse_rips_complex.h @@ -46,7 +46,7 @@ namespace rips_complex { * \ingroup rips_complex * * \details - * This class is used to construct a sparse \f$(1+\epsilon)\f$-approximation of `Rips_complex`. + * This class is used to construct a sparse \f$(1+\epsilon)\f$-approximation of `Rips_complex`, i.e. a filtered simplicial complex that is multiplicatively \f$(1+\epsilon)\f$-interleaved with the Rips filtration. * * \tparam Filtration_value is the type used to store the filtration values of the simplicial complex. */ @@ -65,10 +65,12 @@ class Sparse_rips_complex { * * @param[in] points Range of points. * @param[in] distance distance function that returns a `Filtration_value` from 2 given points. + * @param[in] epsilon (1+epsilon) is the desired approximation factor. epsilon must be positive. * */ template Sparse_rips_complex(const RandomAccessPointRange& points, Distance distance, double epsilon) { + GUDHI_CHECK(epsilon > 0, "epsilon must be positive"); std::vector sorted_points; std::vector params; auto dist_fun = [&](Vertex_handle i, Vertex_handle j){return distance(points[i], points[j]);}; @@ -83,6 +85,7 @@ class Sparse_rips_complex { * `distance_matrix[i][j]` returns the distance between points \f$i\f$ and * \f$j\f$ as long as \f$ 0 \leqslant i < j \leqslant * distance\_matrix.size().\f$ + * @param[in] epsilon (1+epsilon) is the desired approximation factor. epsilon must be positive. */ template Sparse_rips_complex(const DistanceMatrix& distance_matrix, double epsilon) -- cgit v1.2.3