From ca93a90b895e74cc6bdbeed9273e8cb5de195fc9 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Mon, 30 May 2016 12:49:54 +0000 Subject: Missing documentation for parameters. git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/get_persistence@1220 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 190cfccdca4d4fd15066ad04885d5dc19428d59c --- src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src/Persistent_cohomology/include') diff --git a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h index 23beaa96..efa9a367 100644 --- a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h +++ b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h @@ -649,10 +649,11 @@ class Persistent_cohomology { return betti_numbers; } - /** @brief Returns the persistentBetti number of the dimension passed by parameter. + /** @brief Returns the persistent Betti number of the dimension passed by parameter. * @param[in] dimension The Betti number dimension to get. - * @return Betti number of the given dimension - * + * @param[in] from The persistence birth limit to be added in the number \f$(persistent birth \leq from)\f$. + * @param[in] to The persistence death limit to be added in the number \f$(persistent death > from)\f$. + * @return Persistent Betti number of the given dimension */ int persistent_betti_number(int dimension, Filtration_value from, Filtration_value to) const { int betti_number = 0; -- cgit v1.2.3