summaryrefslogtreecommitdiff
path: root/src/Witness_complex/include
diff options
context:
space:
mode:
authorskachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-02-23 11:04:40 +0000
committerskachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-02-23 11:04:40 +0000
commitea51646efd72e9edab55abae846100c7494916ca (patch)
tree4864da80d0036efab165dd76e51addda1e2ed6b7 /src/Witness_complex/include
parenta627aaf34fccc458556d9a1522c1eae0350b78e1 (diff)
Added the copiable precision to the doc.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/relaxed-witness@2100 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 1892ed7c04219bee7e3dbf408d49d153d85fe10b
Diffstat (limited to 'src/Witness_complex/include')
-rw-r--r--src/Witness_complex/include/gudhi/Strong_witness_complex.h2
-rw-r--r--src/Witness_complex/include/gudhi/Witness_complex.h6
2 files changed, 6 insertions, 2 deletions
diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h
index 50ba8d0b..2f833ccd 100644
--- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h
+++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h
@@ -42,6 +42,7 @@ namespace witness_complex {
* \ingroup witness_complex
*
* \tparam Nearest_landmark_table_ needs to be a range of a range 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<std::size_t, double>'.
*/
@@ -78,6 +79,7 @@ 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 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<std::size_t, double>'.
*/
diff --git a/src/Witness_complex/include/gudhi/Witness_complex.h b/src/Witness_complex/include/gudhi/Witness_complex.h
index d808de57..c09e6af9 100644
--- a/src/Witness_complex/include/gudhi/Witness_complex.h
+++ b/src/Witness_complex/include/gudhi/Witness_complex.h
@@ -43,6 +43,7 @@ namespace witness_complex {
* \ingroup witness_complex
*
* \tparam Nearest_landmark_table_ needs to be a range of a range 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<std::size_t, double>'.
*/
@@ -78,8 +79,9 @@ 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 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>'.
+ * 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<std::size_t, double>'.
*/
Witness_complex(Nearest_landmark_table_ const & nearest_landmark_table)