diff options
| author | skachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-12-06 09:22:03 +0000 |
|---|---|---|
| committer | skachano <skachano@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-12-06 09:22:03 +0000 |
| commit | 6a1455578219460b9a15c58f47520d203682f9d8 (patch) | |
| tree | 4e82fb54b0c7c9e2b10b946364fb60d3219e6026 /src/Witness_complex | |
| parent | 4e5416f5d030a57c1aad3303dd19c9aba56013fd (diff) | |
Fixes in doc
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/relaxed-witness@1823 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 2a0b01b5662daeeb1a15366d8e5d3d9747032175
Diffstat (limited to 'src/Witness_complex')
| -rw-r--r-- | src/Witness_complex/include/gudhi/Strong_witness_complex.h | 2 | ||||
| -rw-r--r-- | src/Witness_complex/include/gudhi/Witness_complex.h | 10 |
2 files changed, 8 insertions, 4 deletions
diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h index c7b8c27b..03cdbcca 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -96,6 +96,7 @@ private: * \brief Initializes member variables before constructing simplicial complex. * \details Records landmarks from the range 'landmarks' into a * table internally, as well as witnesses from the range 'witnesses'. + * Both ranges should have value_type Kernel_::Point_d. */ template< typename LandmarkRange, typename WitnessRange > @@ -116,6 +117,7 @@ private: /** \brief Outputs the strong witness complex of relaxation 'max_alpha_square' * in a simplicial complex data structure. + * \details The function returns true if the construction is successful and false otherwise. * @param[out] complex Simplicial complex data structure, which is a model of * SimplicialComplexForWitness concept. * @param[in] max_alpha_square Maximal squared relaxation parameter. diff --git a/src/Witness_complex/include/gudhi/Witness_complex.h b/src/Witness_complex/include/gudhi/Witness_complex.h index c1d402c6..36aad7c3 100644 --- a/src/Witness_complex/include/gudhi/Witness_complex.h +++ b/src/Witness_complex/include/gudhi/Witness_complex.h @@ -90,6 +90,7 @@ private: * \brief Initializes member variables before constructing simplicial complex. * \details Records landmarks from the range 'landmarks' into a * table internally, as well as witnesses from the range 'witnesses'. + * Both ranges should have value_type Kernel_::Point_d. */ template< typename LandmarkRange, typename WitnessRange > @@ -109,6 +110,7 @@ private: /** \brief Outputs the (weak) witness complex of relaxation 'max_alpha_square' * in a simplicial complex data structure. + * \details The function returns true if the construction is successful and false otherwise. * @param[out] complex Simplicial complex data structure compatible which is a model of * SimplicialComplexForWitness concept. * @param[in] max_alpha_square Maximal squared relaxation parameter. @@ -172,10 +174,10 @@ private: //@} private: - /* \brief Adds recursively all the faces of a certain dimension dim witnessed by the same witness - * Iterator is needed to know until how far we can take landmarks to form simplexes - * simplex is the prefix of the simplexes to insert - * The output value indicates if the witness rests active or not + /* \brief Adds recursively all the faces of a certain dimension dim witnessed by the same witness. + * Iterator is needed to know until how far we can take landmarks to form simplexes. + * simplex is the prefix of the simplexes to insert. + * The output value indicates if the witness rests active or not. */ template < typename SimplicialComplexForWitness > bool add_all_faces_of_dimension(int dim, |