diff options
Diffstat (limited to 'src/Witness_complex/include/gudhi/Strong_witness_complex.h')
| -rw-r--r-- | src/Witness_complex/include/gudhi/Strong_witness_complex.h | 13 |
1 files changed, 7 insertions, 6 deletions
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<std::size_t, double>'. + * \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<std::size_t, double>'. */ 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<std::size_t, double>'. */ + * @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<std::size_t, double>'. + */ Strong_witness_complex(Nearest_landmark_table_ const & nearest_landmark_table) : nearest_landmark_table_(std::begin(nearest_landmark_table), std::end(nearest_landmark_table)) { |