diff options
| author | pdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-02-09 14:35:03 +0000 |
|---|---|---|
| committer | pdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-02-09 14:35:03 +0000 |
| commit | 81d5f63b5107dd8229fd8b8576982d22acb9a57e (patch) | |
| tree | 8aaf09ee7097e2013bb2e2cc6806180ee64646a4 /src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h | |
| parent | 904e931e2938ed3a5b526711b073c957b938ae63 (diff) | |
Adding documentation to the bitmap cubical complex with periodic boundary conditions class.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/bitmap@1010 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: e1d9516f57be5e824203037b74998ed897741261
Diffstat (limited to 'src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h')
| -rw-r--r-- | src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h index b599a0d9..2ec7594d 100644 --- a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h +++ b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h @@ -37,7 +37,12 @@ namespace Cubical_complex //global variable, was used just for debugging. const bool globalDbg = false; -template <typename T> class is_before_in_filtration; +template <typename T> class is_before_in_filtration;
+
+/** +* This is a Bitmap_cubical_complex class. It joints a functionalities of Bitmap_cubical_complex__base and Bitmap_cubical_complex_periodic_boundary_conditions_base classes into
+* Gudhi persistent homology engine. It is a template class that inherit from its template parameter. The template parameter is supposed to be either Bitmap_cubical_complex__base or Bitmap_cubical_complex_periodic_boundary_conditions_base class. +**/ /** *@class Bitmap_cubical_complex |