diff options
author | pdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-09-20 09:14:30 +0000 |
---|---|---|
committer | pdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-09-20 09:14:30 +0000 |
commit | 3ae2a05fea03ad51cf9e43a48e67dce89b58875d (patch) | |
tree | fa4cfc83c56da2d2e01fd50130499a490791cdfb /src/Bitmap_cubical_complex/doc | |
parent | 7961566ae8e7f9a8ef34ab36f85b385197bc8a04 (diff) |
Fix to the documentation: to remove confusion with the perseus format.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cubical_complex_small_fix@3899 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 6d600838396236ca95346719058bd8b834541814
Diffstat (limited to 'src/Bitmap_cubical_complex/doc')
-rw-r--r-- | src/Bitmap_cubical_complex/doc/Gudhi_Cubical_Complex_doc.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/Bitmap_cubical_complex/doc/Gudhi_Cubical_Complex_doc.h b/src/Bitmap_cubical_complex/doc/Gudhi_Cubical_Complex_doc.h index d1836ef0..0c70c6e0 100644 --- a/src/Bitmap_cubical_complex/doc/Gudhi_Cubical_Complex_doc.h +++ b/src/Bitmap_cubical_complex/doc/Gudhi_Cubical_Complex_doc.h @@ -90,8 +90,11 @@ namespace cubical_complex { * 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 \a Bitmap_cubical_complex class. - * Currently one input from a text file is used. It uses a format used already in Perseus software - * (http://www.sas.upenn.edu/~vnanda/perseus/) by Vidit Nanda. The file format is described here: \ref FileFormatsPerseus. + * Currently one input from a text file is used. It uses a format nspired from the Perseus software + * (http://www.sas.upenn.edu/~vnanda/perseus/) by Vidit Nanda. Note however an important difference: 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 +Inf. The file format is described in details in here: \ref FileFormatsPerseus. * * \section PeriodicBoundaryConditions Periodic boundary conditions * Often one would like to impose periodic boundary conditions to the cubical complex. Let \f$ I_1\times ... \times |