summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-21 12:05:32 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-21 12:05:32 +0000
commit24fafed684bfb8cc4b34d4663927fb97b80edd75 (patch)
tree4644655a052ce7705dbf83a3c896f803777ee77c /src
parenta26b039683e35a64f7a3feb544a195b4a4510ec1 (diff)
Precise when to use set_dimension function
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@2212 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 9e17d1b5e8a96fffe48e1b1e7b6d766d2abf33e0
Diffstat (limited to 'src')
-rw-r--r--src/cython/cython/simplex_tree.pyx7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/cython/cython/simplex_tree.pyx b/src/cython/cython/simplex_tree.pyx
index 4bcda1cb..bb6fd1db 100644
--- a/src/cython/cython/simplex_tree.pyx
+++ b/src/cython/cython/simplex_tree.pyx
@@ -169,6 +169,13 @@ cdef class SimplexTree:
def set_dimension(self, dimension):
"""This function sets the dimension of the simplicial complex.
+ insert and remove_maximal_simplex functions do not update dimension
+ value of the `SimplexTree`.
+
+ `AlphaComplex`, `RipsComplex`, `TangentialComplex` and `WitnessComplex`
+ automatically sets the correct dimension in their `create_simplex_tree`
+ functions.
+
:param dimension: The new dimension value.
:type dimension: int.
"""