Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange > Class Template Reference

Cech complex data structure. More...

Public Member Functions
	Cech_complex (const ForwardPointRange &points, Filtration_value max_radius)
	Cech_complex constructor from a list of points. More...
template<typename SimplicialComplexForCechComplex >
void	create_complex (SimplicialComplexForCechComplex &complex, int dim_max)
	Initializes the simplicial complex from the proximity graph and expands it until a given maximal dimension, using the Cech blocker oracle. More...
Filtration_value	max_radius () const
const Point &	get_point (Vertex_handle vertex) const

Detailed Description

template<typename SimplicialComplexForProximityGraph, typename ForwardPointRange>
class Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange >

Cech complex data structure.

The data structure is a proximity graph, containing edges when the edge length is less or equal to a given max_radius. Edge length is computed from Gudhi::Minimal_enclosing_ball_radius distance function.

Template Parameters

SimplicialComplexForProximityGraph	furnishes Vertex_handle and Filtration_value type definition required by Gudhi::Proximity_graph.
ForwardPointRange	must be a range for which std::begin() and std::end() methods return input iterators on a point. std::begin() and std::end() methods are also required for a point.

Constructor & Destructor Documentation

Cech_complex()

template<typename SimplicialComplexForProximityGraph , typename ForwardPointRange >

Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange >::Cech_complex ( const ForwardPointRange &  points, Filtration_value  max_radius  )

inline

Cech_complex constructor from a list of points.

Parameters

[in]	points	Range of points.
[in]	max_radius	Maximal radius value.

Template Parameters

ForwardPointRange

must be a range of Point. Point must be a range of copyable Cartesian coordinates.

Member Function Documentation

create_complex()

template<typename SimplicialComplexForProximityGraph , typename ForwardPointRange >

template<typename SimplicialComplexForCechComplex >

void Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange >::create_complex ( SimplicialComplexForCechComplex &  complex, int  dim_max  )

inline

Initializes the simplicial complex from the proximity graph and expands it until a given maximal dimension, using the Cech blocker oracle.

Parameters

[in]	complex	SimplicialComplexForCech to be created.
[in]	dim_max	graph expansion until this given maximal dimension.

Exceptions

std::invalid_argument

In debug mode, if complex.num_vertices() does not return 0.

get_point()

template<typename SimplicialComplexForProximityGraph , typename ForwardPointRange >

const Point& Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange >::get_point ( Vertex_handle  vertex ) const

inline

Parameters

[in]

vertex

Point position in the range.

Returns

The point.

max_radius()

template<typename SimplicialComplexForProximityGraph , typename ForwardPointRange >

Filtration_value Gudhi::cech_complex::Cech_complex< SimplicialComplexForProximityGraph, ForwardPointRange >::max_radius ( ) const

inline

Returns

max_radius value given at construction.

---

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

• include/gudhi/Cech_complex.h