diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-22 09:31:29 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-22 09:31:29 +0000 |
commit | d42e0a508caf5aeb2944d097932801e1e86126f0 (patch) | |
tree | 7a12f3d9cd57f6b67399a2c6cd44a409b5e1b8fc /src/cython | |
parent | 3e1f686df11ec3e1ad02a18f12249621620ac969 (diff) | |
parent | 36784120de86410bfbe51c563910df0d8718e2e9 (diff) |
Merge last trunk modifications
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/set_dimension_mechanism_precision@2931 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 44ca09283b600e6af453eb3507bb4ec92b31948b
Diffstat (limited to 'src/cython')
-rw-r--r-- | src/cython/cython/simplex_tree.pyx | 67 | ||||
-rwxr-xr-x | src/cython/doc/python3-sphinx-build.py | 2 |
2 files changed, 46 insertions, 23 deletions
diff --git a/src/cython/cython/simplex_tree.pyx b/src/cython/cython/simplex_tree.pyx index ff12dd48..8a436619 100644 --- a/src/cython/cython/simplex_tree.pyx +++ b/src/cython/cython/simplex_tree.pyx @@ -133,9 +133,14 @@ cdef class SimplexTree: .. note:: - This function must be launched before persistence, betti_numbers, - persistent_betti_numbers or get_filtration after inserting or - removing simplices. + This function must be launched before + :func:`persistence()<gudhi.SimplexTree.persistence>`, + :func:`betti_numbers()<gudhi.SimplexTree.betti_numbers>`, + :func:`persistent_betti_numbers()<gudhi.SimplexTree.persistent_betti_numbers>`, + or :func:`get_filtration()<gudhi.SimplexTree.get_filtration>` + after :func:`inserting<gudhi.SimplexTree.insert>` or + :func:`removing<gudhi.SimplexTree.remove_maximal_simplex>` + simplices. """ self.thisptr.initialize_filtration() @@ -167,7 +172,10 @@ cdef class SimplexTree: This function is not constant time because it can recompute dimension if required (can be triggered by - remove_maximal_simplex or prune_above_filtration methods). + :func:`remove_maximal_simplex()<gudhi.SimplexTree.remove_maximal_simplex>` + or + :func:`prune_above_filtration()<gudhi.SimplexTree.prune_above_filtration>` + methods). """ return self.thisptr.dimension() @@ -190,8 +198,11 @@ cdef class SimplexTree: This function must be used with caution because it disables dimension recomputation when required - (this recomputation can be triggered by remove_maximal_simplex - or prune_above_filtration methods. + (this recomputation can be triggered by + :func:`remove_maximal_simplex()<gudhi.SimplexTree.remove_maximal_simplex>` + or + :func:`prune_above_filtration()<gudhi.SimplexTree.prune_above_filtration>` + ). """ self.thisptr.set_dimension(<int>dimension) @@ -319,14 +330,16 @@ cdef class SimplexTree: .. note:: Be aware that removing is shifting data in a flat_map - (initialize_filtration to be done). + (:func:`initialize_filtration()<gudhi.SimplexTree.initialize_filtration>` to be done). .. note:: The dimension of the simplicial complex may be lower after calling remove_maximal_simplex than it was before. However, - upper_bound_dimension method will return the old value, which - remains a valid upper bound. If you care, you can call dimension + :func:`upper_bound_dimension()<gudhi.SimplexTree.upper_bound_dimension>` + method will return the old value, which + remains a valid upper bound. If you care, you can call + :func:`dimension()<gudhi.SimplexTree.dimension>` to recompute the exact dimension. """ self.thisptr.remove_maximal_simplex(simplex) @@ -344,17 +357,23 @@ cdef class SimplexTree: Some simplex tree functions require the filtration to be valid. prune_above_filtration function is not launching - initialize_filtration but returns the filtration modification + :func:`initialize_filtration()<gudhi.SimplexTree.initialize_filtration>` + but returns the filtration modification information. If the complex has changed , please call - initialize_filtration to recompute it. + :func:`initialize_filtration()<gudhi.SimplexTree.initialize_filtration>` + to recompute it. .. note:: Note that the dimension of the simplicial complex may be lower - after calling prune_above_filtration than it was before. However, - upper_bound_dimension will return the old value, which remains a - valid upper bound. If you care, you can call dimension method to - recompute the exact dimension. + after calling + :func:`prune_above_filtration()<gudhi.SimplexTree.prune_above_filtration>` + than it was before. However, + :func:`upper_bound_dimension()<gudhi.SimplexTree.upper_bound_dimension>` + will return the old value, which remains a + valid upper bound. If you care, you can call + :func:`dimension()<gudhi.SimplexTree.dimension>` + method to recompute the exact dimension. """ return self.thisptr.prune_above_filtration(filtration) @@ -405,8 +424,9 @@ cdef class SimplexTree: :returns: The Betti numbers ([B0, B1, ..., Bn]). :rtype: list of int - :note: betti_numbers function requires persistence function to be - launched first. + :note: betti_numbers function requires + :func:`persistence()<gudhi.SimplexTree.persistence>` + function to be launched first. """ cdef vector[int] bn_result if self.pcohptr != NULL: @@ -430,7 +450,8 @@ cdef class SimplexTree: :returns: The persistent Betti numbers ([B0, B1, ..., Bn]). :rtype: list of int - :note: persistent_betti_numbers function requires persistence + :note: persistent_betti_numbers function requires + :func:`persistence()<gudhi.SimplexTree.persistence>` function to be launched first. """ cdef vector[int] pbn_result @@ -450,8 +471,9 @@ cdef class SimplexTree: :returns: The persistence intervals. :rtype: list of pair of float - :note: intervals_in_dim function requires persistence function to be - launched first. + :note: intervals_in_dim function requires + :func:`persistence()<gudhi.SimplexTree.persistence>` + function to be launched first. """ cdef vector[pair[double,double]] intervals_result if self.pcohptr != NULL: @@ -468,8 +490,9 @@ cdef class SimplexTree: :param persistence_file: The specific dimension. :type persistence_file: string. - :note: intervals_in_dim function requires persistence function to be - launched first. + :note: intervals_in_dim function requires + :func:`persistence()<gudhi.SimplexTree.persistence>` + function to be launched first. """ if self.pcohptr != NULL: if persistence_file != '': diff --git a/src/cython/doc/python3-sphinx-build.py b/src/cython/doc/python3-sphinx-build.py index 44b94169..84d158cf 100755 --- a/src/cython/doc/python3-sphinx-build.py +++ b/src/cython/doc/python3-sphinx-build.py @@ -1,4 +1,4 @@ -#!/usr/bin/python3 +#!/usr/bin/env python3 """ Emulate sphinx-build for python3 |