diff options
| author | skachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-01-18 10:52:01 +0000 |
|---|---|---|
| committer | skachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-01-18 10:52:01 +0000 |
| commit | 9335a9dae7bfb76a7d6cb5e15f0975dcbb20f17e (patch) | |
| tree | 4a49ddb8c856f160f3efc8ff858e957ac92c42c0 /src/Witness_complex/include | |
| parent | 6b7a6c4ab5e643393ac9ef9ccec25d9d9afac822 (diff) | |
Fixed thedocumentation. Even without an additional concept.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/relaxed-witness@1947 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 3efb3fc30ca069b720fe1134ab3d64d284feb7ad
Diffstat (limited to 'src/Witness_complex/include')
| -rw-r--r-- | src/Witness_complex/include/gudhi/Strong_witness_complex.h | 9 | ||||
| -rw-r--r-- | src/Witness_complex/include/gudhi/Witness_complex.h | 8 |
2 files changed, 12 insertions, 5 deletions
diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h index 20f9da8d..abfc879c 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -43,7 +43,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 model of NearestLandmarkRange concept. + * \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>'. */ template< class Nearest_landmark_table_ > class Strong_witness_complex { @@ -71,8 +73,9 @@ private: /** * \brief Initializes member variables before constructing simplicial complex. * \details Records nearest landmark table. - * @param[in] nearest_landmark_table should be a range of a model of NearestLandmarkRange concept. - */ + * @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>'. */ Strong_witness_complex(Nearest_landmark_table_ & nearest_landmark_table) : nearest_landmark_table_(nearest_landmark_table) { diff --git a/src/Witness_complex/include/gudhi/Witness_complex.h b/src/Witness_complex/include/gudhi/Witness_complex.h index 70d51677..3305a8e2 100644 --- a/src/Witness_complex/include/gudhi/Witness_complex.h +++ b/src/Witness_complex/include/gudhi/Witness_complex.h @@ -44,7 +44,9 @@ namespace witness_complex { * \brief Constructs (weak) 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 model of NearestLandmarkRange concept. + * \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>'. */ template< class Nearest_landmark_table_ > class Witness_complex { @@ -72,7 +74,9 @@ private: /** * \brief Initializes member variables before constructing simplicial complex. * \details Records nearest landmark table. - @param[in] nearest_landmark_table should be a range of a model of NearestLandmarkRange concept. + * @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>'. */ Witness_complex(Nearest_landmark_table_ & nearest_landmark_table) |