**diff options**

author | Umberto Lupo <46537483+ulupo@users.noreply.github.com> | 2020-12-19 10:16:02 +0100 |
---|---|---|

committer | GitHub <noreply@github.com> | 2020-12-19 10:16:02 +0100 |

commit | 32388973293692b544de0db976abc800178a67ed (patch) | |

tree | deca5b5b86e6dcdea95babb17a52fb6f834d9582 | |

parent | a2e8ac11e22be7edff1244fbdd848ef6cbbd6903 (diff) |

Docstring improvements in RipsComplex

- create_simplex_tree method referred to the Delaunay triangulation instead of the flag complex
- "rips" was not capitalized
- "double" was used in the docs but only "float" (which has double precision) is a Python type

-rw-r--r-- | src/python/gudhi/rips_complex.pyx | 8 |

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() |