diff options
author | Vincent Rouvreau <VincentRouvreau@users.noreply.github.com> | 2019-06-14 15:46:10 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-14 15:46:10 +0200 |
commit | 3380ad8819697a53511ed70810e9a51ae8ace443 (patch) | |
tree | 5bddc1105c7c46757e8ef8daff7333be1f3b1c94 /src/Persistent_cohomology/include | |
parent | f9a2172f24da8d7538c67fbf4e7580ab09b456c5 (diff) | |
parent | aaf2b79181c1b0f935d2b2110f0e7f48fb98b35b (diff) |
Merge pull request #70 from VincentRouvreau/persistent_cohomology_documentation
Persistent cohomology documentation
Diffstat (limited to 'src/Persistent_cohomology/include')
-rw-r--r-- | src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h | 18 |
1 files changed, 5 insertions, 13 deletions
diff --git a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h index c57174cb..689a17c0 100644 --- a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h +++ b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h @@ -98,9 +98,13 @@ class Persistent_cohomology { * * @param[in] cpx Complex for which the persistent homology is computed. * cpx is a model of FilteredComplex + * + * @param[in] persistence_dim_max if true, the persistent homology for the maximal dimension in the + * complex is computed. If false, it is ignored. Default is false. + * * @exception std::out_of_range In case the number of simplices is more than Simplex_key type numeric limit. */ - explicit Persistent_cohomology(FilteredComplex& cpx) + explicit Persistent_cohomology(FilteredComplex& cpx, bool persistence_dim_max = false) : cpx_(&cpx), dim_max_(cpx.dimension()), // upper bound on the dimension of the simplices coeff_field_(), // initialize the field coefficient structure. @@ -126,18 +130,6 @@ class Persistent_cohomology { ++idx_fil; dsets_.make_set(cpx_->key(sh)); } - } - - /** \brief Initializes the Persistent_cohomology class. - * - * @param[in] cpx Complex for which the persistent homology is compiuted. - * cpx is a model of FilteredComplex - * - * @param[in] persistence_dim_max if true, the persistent homology for the maximal dimension in the - * complex is computed. If false, it is ignored. Default is false. - */ - Persistent_cohomology(FilteredComplex& cpx, bool persistence_dim_max) - : Persistent_cohomology(cpx) { if (persistence_dim_max) { ++dim_max_; } |