summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2022-11-08 22:26:36 +0100
committerMarc Glisse <marc.glisse@inria.fr>2022-11-08 22:26:36 +0100
commit8804aa1580c500ed927d65c25e8b78700725338e (patch)
treec4e9a53af5c7464b8da1d0d36340f11548be632d
parentaa2dd7a0498594229fd828079bc069d71bbba59a (diff)
Clarify doc of RipsComplex.__init__
-rw-r--r--src/python/gudhi/rips_complex.pyx9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/python/gudhi/rips_complex.pyx b/src/python/gudhi/rips_complex.pyx
index c3470292..a0924cd6 100644
--- a/src/python/gudhi/rips_complex.pyx
+++ b/src/python/gudhi/rips_complex.pyx
@@ -45,20 +45,19 @@ cdef class RipsComplex:
max_edge_length=float('inf'), sparse=None):
"""RipsComplex constructor.
- :param max_edge_length: Rips value.
- :type max_edge_length: float
-
:param points: A list of points in d-Dimension.
- :type points: list of list of float
+ :type points: List[List[float]]
Or
:param distance_matrix: A distance matrix (full square or lower
triangular).
- :type points: list of list of float
+ :type distance_matrix: List[List[float]]
And in both cases
+ :param max_edge_length: Rips value.
+ :type max_edge_length: float
:param sparse: If this is not None, it switches to building a sparse
Rips and represents the approximation parameter epsilon.
:type sparse: float