Add iso-cuboid file format

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/add_utils_in_gudhi_v2@2882 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: ad82867ef7523c4a03fdb89054e5bd7b8d40f7da

1 files changed, 15 insertions, 0 deletions

diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
index d715aa4d..3b3d9248 100644
--- a/src/common/doc/file_formats.h
+++ b/src/common/doc/file_formats.h
@@ -53,6 +53,21 @@ namespace Gudhi {
  Such files can be generated with `Gudhi::persistent_cohomology::Persistent_cohomology::output_diagram()` and read with
  `Gudhi::read_persistence_intervals_and_dimension()`, `Gudhi::read_persistence_intervals_grouped_by_dimension()` or
  `Gudhi::read_persistence_intervals_in_dimension()`.
+ 
+
+ \section FileFormatsIsoCuboid Iso-cuboid
+
+ Such a file describes an iso-oriented cuboid with diagonal opposite vertices (min_hx, min_hy, min_hz,...) and (max_hx, max_hy, max_hz, ...). The format is:<br>
+ \verbatim
+   min_hx min_hy [min_hz ...]
+   max_hx max_hy [max_hz ...]
+ \endverbatim
+
+ Here is a simple sample file in the 3D case:
+ \verbatim
+   -1. -1. -1.
+   1. 1. 1.
+ \endverbatim
 */
 }  // namespace Gudhi