summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2020-12-19 17:08:24 +0100
committerGitHub <noreply@github.com>2020-12-19 17:08:24 +0100
commit792cffdae7d9ed501789b91ae61b2bb14e5d112a (patch)
treedeca5b5b86e6dcdea95babb17a52fb6f834d9582
parenta2e8ac11e22be7edff1244fbdd848ef6cbbd6903 (diff)
parent32388973293692b544de0db976abc800178a67ed (diff)
Merge pull request #440 from ulupo/patch-1
Docstring improvements in RipsComplex
-rw-r--r--src/python/gudhi/rips_complex.pyx8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/python/gudhi/rips_complex.pyx b/src/python/gudhi/rips_complex.pyx
index 72e82c79..c3470292 100644
--- a/src/python/gudhi/rips_complex.pyx
+++ b/src/python/gudhi/rips_complex.pyx
@@ -49,13 +49,13 @@ cdef class RipsComplex:
:type max_edge_length: float
:param points: A list of points in d-Dimension.
- :type points: list of list of double
+ :type points: list of list of float
Or
:param distance_matrix: A distance matrix (full square or lower
triangular).
- :type points: list of list of double
+ :type points: list of list of float
And in both cases
@@ -89,10 +89,10 @@ cdef class RipsComplex:
def create_simplex_tree(self, max_dimension=1):
"""
- :param max_dimension: graph expansion for rips until this given maximal
+ :param max_dimension: graph expansion for Rips until this given maximal
dimension.
:type max_dimension: int
- :returns: A simplex tree created from the Delaunay Triangulation.
+ :returns: A simplex tree encoding the Vietoris–Rips filtration.
:rtype: SimplexTree
"""
stree = SimplexTree()