From 655b7a42078a350c3827cb68beb86a25ac5929ab Mon Sep 17 00:00:00 2001
From: vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Wed, 6 Jun 2018 10:56:52 +0000
Subject: Doc review : warn about cubical betti numbers function and remove
 simplicial references for cubical

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_2.1.0_fix_vincent@3546 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 41399f9e8aec2ab914368822cd288b1a08839085
---
 src/cython/cython/cubical_complex.pyx | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

(limited to 'src')

diff --git a/src/cython/cython/cubical_complex.pyx b/src/cython/cython/cubical_complex.pyx
index a98a3ec3..de6cd396 100644
--- a/src/cython/cython/cubical_complex.pyx
+++ b/src/cython/cython/cubical_complex.pyx
@@ -104,22 +104,22 @@ cdef class CubicalComplex:
         return self.pcohptr != NULL
 
     def num_simplices(self):
-        """This function returns the number of simplices of the simplicial
+        """This function returns the number of all cubes in the complex.
         complex.
 
-        :returns:  int -- the simplicial complex number of simplices.
+        :returns:  int -- the number of all cubes in the complex.
         """
         return self.thisptr.num_simplices()
 
     def dimension(self):
-        """This function returns the dimension of the simplicial complex.
+        """This function returns the dimension of the complex.
 
-        :returns:  int -- the simplicial complex dimension.
+        :returns:  int -- the complex dimension.
         """
         return self.thisptr.dimension()
 
     def persistence(self, homology_coeff_field=11, min_persistence=0):
-        """This function returns the persistence of the simplicial complex.
+        """This function returns the persistence of the complex.
 
         :param homology_coeff_field: The homology coefficient field. Must be a
             prime number
@@ -130,7 +130,7 @@ cdef class CubicalComplex:
             Sets min_persistence to -1.0 to see all values.
         :type min_persistence: float.
         :returns: list of pairs(dimension, pair(birth, death)) -- the
-            persistence of the simplicial complex.
+            persistence of the complex.
         """
         if self.pcohptr != NULL:
             del self.pcohptr
@@ -142,12 +142,15 @@ cdef class CubicalComplex:
         return persistence_result
 
     def betti_numbers(self):
-        """This function returns the Betti numbers of the simplicial complex.
+        """This function returns the Betti numbers of the complex.
 
         :returns: list of int -- The Betti numbers ([B0, B1, ..., Bn]).
 
         :note: betti_numbers function requires persistence function to be
             launched first.
+
+        :note: betti_numbers function always returns [1, 0, 0, ...] as infinity
+        filtration cubes are not removed from the complex.
         """
         cdef vector[int] bn_result
         if self.pcohptr != NULL:
@@ -155,8 +158,7 @@ cdef class CubicalComplex:
         return bn_result
 
     def persistent_betti_numbers(self, from_value, to_value):
-        """This function returns the persistent Betti numbers of the
-        simplicial complex.
+        """This function returns the persistent Betti numbers of the complex.
 
         :param from_value: The persistence birth limit to be added in the
             numbers (persistent birth <= from_value).
@@ -177,8 +179,8 @@ cdef class CubicalComplex:
         return pbn_result
 
     def persistence_intervals_in_dimension(self, dimension):
-        """This function returns the persistence intervals of the simplicial
-        complex in a specific dimension.
+        """This function returns the persistence intervals of the complex in a
+        specific dimension.
 
         :param dimension: The specific dimension.
         :type from_value: int.
-- 
cgit v1.2.3