Gudhi  1.2.0
 All Classes Functions Variables Typedefs Friends Groups Pages
Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField > Class Template Reference

Computes the persistent cohomology of a filtered complex. More...

#include <Persistent_cohomology.h>

Public Member Functions

 Persistent_cohomology (Complex_ds &cpx)
 Initializes the Persistent_cohomology class. More...
 
 Persistent_cohomology (Complex_ds &cpx, bool persistence_dim_max)
 Initializes the Persistent_cohomology class. More...
 
void init_coefficients (int charac)
 Initializes the coefficient field.
 
void init_coefficients (int charac_min, int charac_max)
 Initializes the coefficient field for multi-field persistent homology.
 
void compute_persistent_cohomology (Filtration_value min_interval_length=0)
 Compute the persistent homology of the filtered simplicial complex. More...
 
void output_diagram (std::ostream &ostream=std::cout)
 Output the persistence diagram in ostream. More...
 

Additional Inherited Members

- Public Types inherited from PersistentHomology
typedef unspecified Filtered_complex
 Type of filtered cell complex on which persistent homology is computed. More...
 
typedef unspecified Coefficient_field
 Type of coefficients to be used for computing persistent homology. More...
 

Detailed Description

template<class FilteredComplex, class CoefficientField>
class Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField >

Computes the persistent cohomology of a filtered complex.

The computation is implemented with a Compressed Annotation Matrix (CAM)[5], and is adapted to the computation of Multi-Field Persistent Homology (MF) [3] .

Constructor & Destructor Documentation

template<class FilteredComplex, class CoefficientField>
Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField >::Persistent_cohomology ( Complex_ds cpx)
inlineexplicit

Initializes the Persistent_cohomology class.

Parameters
[in]cpxComplex for which the persistent homology is computed. cpx is a model of FilteredComplex
template<class FilteredComplex, class CoefficientField>
Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField >::Persistent_cohomology ( Complex_ds cpx,
bool  persistence_dim_max 
)
inline

Initializes the Persistent_cohomology class.

Parameters
[in]cpxComplex for which the persistent homology is compiuted. cpx is a model of FilteredComplex
[in]persistence_dim_maxif true, the persistent homology for the maximal dimension in the complex is computed. If false, it is ignored. Default is false.

Member Function Documentation

template<class FilteredComplex, class CoefficientField>
void Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField >::compute_persistent_cohomology ( Filtration_value  min_interval_length = 0)
inline

Compute the persistent homology of the filtered simplicial complex.

Parameters
[in]min_interval_lengththe computation discards all intervals of length less or equal than min_interval_length

Assumes that the filtration provided by the simplicial complex is valid. Undefined behavior otherwise.

template<class FilteredComplex, class CoefficientField>
void Gudhi::persistent_cohomology::Persistent_cohomology< FilteredComplex, CoefficientField >::output_diagram ( std::ostream &  ostream = std::cout)
inline

Output the persistence diagram in ostream.

The file format is the following: p1*...*pr dim b d

where "dim" is the dimension of the homological feature, b and d are respectively the birth and death of the feature and p1*...*pr is the product of prime numbers pi such that the homology feature exists in homology with Z/piZ coefficients.


The documentation for this class was generated from the following file: