From 27114ca8df752b4ddd24f0ebf161f46882e352df Mon Sep 17 00:00:00 2001 From: Marc Glisse Date: Fri, 10 May 2019 12:37:48 +0200 Subject: Clarify doc of witness complex --- src/Witness_complex/include/gudhi/Strong_witness_complex.h | 4 ++-- 1 file changed, 2 insertions(+), 2 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 fd6b3f38..5fd116b9 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -40,10 +40,10 @@ 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 pairs of nearest landmarks and distances. + * \tparam Nearest_landmark_table_ needs to be a range (one entry per witness) of sorted ranges of pairs of nearest landmarks and distances. * The class Nearest_landmark_table_::value_type must be a copiable range. * The range of pairs must admit a member type 'iterator'. The dereference type - * of the pair range iterator needs to be 'std::pair'. + * of the pair range iterator needs to be 'std::pair' where the first element is the index of the landmark, and the second its (squared) distance to the witness. */ template< class Nearest_landmark_table_ > class Strong_witness_complex { -- cgit v1.2.3