From e4a627b0675453fc88d3a43eef3bff663d3f8121 Mon Sep 17 00:00:00 2001 From: skachano Date: Wed, 1 Feb 2017 10:54:18 +0000 Subject: The rest of the comments git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/relaxed-witness@2043 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 37e81613f87a77768bde47d3539a2dbc6bf3552b --- src/Witness_complex/include/gudhi/Strong_witness_complex.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'src/Witness_complex/include/gudhi/Strong_witness_complex.h') diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h index 5858d917..058b5bbc 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -41,9 +41,9 @@ namespace witness_complex { * \brief Constructs strong witness complex for a given table of nearest landmarks with respect to witnesses. * \ingroup witness_complex * - * \tparam Nearest_landmark_table_ needs to be a range of a range of nearest landmarks. - * The range of nearest landmarks should admit a member type 'iterator'. The dereference type - * of the nearest landmark range iterator needs to be 'std::pair'. + * \tparam Nearest_landmark_table_ needs to be a CopyConstructible range of a range of pairs of nearest landmarks and distances. + * The range of pairs must admit a member type 'iterator'. The dereference type + * of the pair range iterator needs to be 'std::pair'. */ template< class Nearest_landmark_table_ > class Strong_witness_complex { @@ -76,9 +76,10 @@ private: /** * \brief Initializes member variables before constructing simplicial complex. * \details Records nearest landmark table. - * @param[in] nearest_landmark_table needs to be a range of a range of nearest landmarks. - * The range of nearest landmarks should admit a member type 'iterator'. The dereference type - * of the nearest landmark range iterator needs to be 'std::pair'. */ + * @param[in] nearest_landmark_table needs to be a CopyConstructible range of a range of pairs of nearest landmarks and distances. + * The range of pairs must admit a member type 'iterator'. The dereference type + * of the pair range iterator needs to be 'std::pair'. + */ Strong_witness_complex(Nearest_landmark_table_ const & nearest_landmark_table) : nearest_landmark_table_(std::begin(nearest_landmark_table), std::end(nearest_landmark_table)) { -- cgit v1.2.3