summaryrefslogtreecommitdiff
path: root/src/cython
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-05-23 08:22:35 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-05-23 08:22:35 +0000
commit90bb34c0e81b57ed85131ccaa638f457338c9219 (patch)
treee9cfb890f54d705984ce70721e06f76c662a2e76 /src/cython
parent71840751fcd4771d126c0ebe2f63a02c14e67186 (diff)
Modify documentation for Simplex_tree make_filtration_non_decreasing
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/python_2.1.0_fix_vincent@3452 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 304779c7952985d651750aded78cb32c6e583555
Diffstat (limited to 'src/cython')
-rw-r--r--src/cython/cython/simplex_tree.pyx6
1 files changed, 2 insertions, 4 deletions
diff --git a/src/cython/cython/simplex_tree.pyx b/src/cython/cython/simplex_tree.pyx
index 38740f4f..667fd40b 100644
--- a/src/cython/cython/simplex_tree.pyx
+++ b/src/cython/cython/simplex_tree.pyx
@@ -402,10 +402,8 @@ cdef class SimplexTree:
self.thisptr.expansion(max_dim)
def make_filtration_non_decreasing(self):
- """Browse the simplex tree to ensure the filtration is not decreasing.
- The simplex tree is browsed starting from the root until the leaf, and
- the filtration values are set with their parent value (increased), in
- case the values are decreasing.
+ """This function ensures that each simplex has a higher filtration
+ value than its faces by increasing the filtration values.
:returns: The filtration modification information.
:rtype: bint