summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-18 10:52:01 +0000
committerskachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-01-18 10:52:01 +0000
commit9335a9dae7bfb76a7d6cb5e15f0975dcbb20f17e (patch)
tree4a49ddb8c856f160f3efc8ff858e957ac92c42c0
parent6b7a6c4ab5e643393ac9ef9ccec25d9d9afac822 (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
-rw-r--r--src/Witness_complex/concept/Simplicial_complex_for_witness.h2
-rw-r--r--src/Witness_complex/doc/Witness_complex_doc.h2
-rw-r--r--src/Witness_complex/include/gudhi/Strong_witness_complex.h9
-rw-r--r--src/Witness_complex/include/gudhi/Witness_complex.h8
4 files changed, 15 insertions, 6 deletions
diff --git a/src/Witness_complex/concept/Simplicial_complex_for_witness.h b/src/Witness_complex/concept/Simplicial_complex_for_witness.h
index b47de809..df294f19 100644
--- a/src/Witness_complex/concept/Simplicial_complex_for_witness.h
+++ b/src/Witness_complex/concept/Simplicial_complex_for_witness.h
@@ -27,7 +27,7 @@ namespace Gudhi {
namespace witness_complex {
-/** \brief The concept Simplicial_Complex describes the requirements
+/** \brief The concept SimplicialComplexForWitness describes the requirements
* for a type to implement a simplicial complex,
* used for example to build a Witness_complex.
*/
diff --git a/src/Witness_complex/doc/Witness_complex_doc.h b/src/Witness_complex/doc/Witness_complex_doc.h
index fa45e359..1ed3fd4e 100644
--- a/src/Witness_complex/doc/Witness_complex_doc.h
+++ b/src/Witness_complex/doc/Witness_complex_doc.h
@@ -44,7 +44,9 @@
The two complexes described above are implemented in the corresponding classes
- Gudhi::witness_complex::Witness_complex
+ - Gudhi::witness_complex::Euclidean_witness_complex
- Gudhi::witness_complex::Strong_witness_complex
+ - Gudhi::witness_complex::Euclidean_strong_witness_complex
The construction of both of them follow the same scheme:
1. Construct a search tree on landmarks (for that Gudhi::spatial_searching::Kd_tree_search is used internally).
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)