From cbcf098dbc2af8f385216d74d6ffbbe08deaff66 Mon Sep 17 00:00:00 2001 From: cjamin Date: Wed, 31 May 2017 11:44:16 +0000 Subject: Fix doc git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2487 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 7be9a5da2a64835ff7558373e7a754647bc5b663 --- src/common/include/gudhi/reader_utils.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/common') diff --git a/src/common/include/gudhi/reader_utils.h b/src/common/include/gudhi/reader_utils.h index 55a1e875..bb744b1c 100644 --- a/src/common/include/gudhi/reader_utils.h +++ b/src/common/include/gudhi/reader_utils.h @@ -330,7 +330,7 @@ void read_persistence_diagram_from_file(std::string const& filename, OutputItera /** Reads a file containing persistence intervals. Each line might contain 2, 3 or 4 values: [[field] dimension] birth death -The return value is an `std::map[dim, std::vector[std::pair[birth, death]]]` +The return value is an `std::map>>` where `dim` is an `int`, `birth` a `double`, and `death` a `double`. **/ std::map>> read_persistence_diagram_from_file(std::string const& filename) { @@ -368,7 +368,7 @@ Each line might contain 2, 3 or 4 values: [[field] dimension] birth death If `only_this_dim` = -1, dimension is ignored and all lines are returned. If `only_this_dim` is >= 0, only the lines where dimension = `only_this_dim` (or where dimension is not specified) are returned. -The return value is an `std::vector[std::pair[birth, death]]` +The return value is an `std::vector>` where `dim` is an `int`, `birth` a `double`, and `death` a `double`. **/ std::vector> read_persistence_diagram_from_file(std::string const& filename, int only_this_dim) { -- cgit v1.2.3