summaryrefslogtreecommitdiff
path: root/src/cython/doc/cubical_complex_user.rst
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2019-02-12 14:08:56 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2019-02-12 14:08:56 +0000
commitf29a6e9a03dca95dc0a070b604fb11e18897a6f6 (patch)
tree0da92a78fad0b15c119c18480b6d98d94924c78e /src/cython/doc/cubical_complex_user.rst
parentb1843507262c7c0d9831ebbeb2f43f43093aa15d (diff)
Fix doc for C++ and Python.
Fix some warnings on Nerve GIC sphinx doc generation git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cubical_complex_small_fix@4101 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 57eacb8c4108be212e61796c65e3b45bb9c13644
Diffstat (limited to 'src/cython/doc/cubical_complex_user.rst')
-rw-r--r--src/cython/doc/cubical_complex_user.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/cython/doc/cubical_complex_user.rst b/src/cython/doc/cubical_complex_user.rst
index 320bd79b..19120360 100644
--- a/src/cython/doc/cubical_complex_user.rst
+++ b/src/cython/doc/cubical_complex_user.rst
@@ -83,9 +83,15 @@ Input Format.
In the current implantation, filtration is given at the maximal cubes, and it is then extended by the lower star
filtration to all cubes. There are a number of constructors that can be used to construct cubical complex by users
who want to use the code directly. They can be found in the :doc:`cubical_complex_ref`.
-Currently one input from a text file is used. It uses a format used already in
+Currently one input from a text file is used. It uses a format inspired from the Perseus software
`Perseus software <http://www.sas.upenn.edu/~vnanda/perseus/>`_ by Vidit Nanda.
-The file format is described here: :doc:`Perseus <fileformats>`.
+
+.. note::
+ While Perseus assume the filtration of all maximal cubes to be non-negative, over here we do not enforce this and
+ we allow any filtration values. As a consequence one cannot use ``-1``'s to indicate missing cubes. If you have
+ missing cubes in your complex, please set their filtration to :math:`+\infty` (aka. ``inf`` in the file).
+
+The file format is described in details in :ref:`Perseus file format` file format section.
.. testcode::