Loading...
Searching...
No Matches
FilteredComplex.h
/* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
* See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
* Author(s): Clément Maria
*
* Copyright (C) 2014 Inria
*
* Modification(s):
* - YYYY/MM Author: Description of the modification
*/
struct FilteredComplex
{
typedef unspecified Simplex_handle;
typedef unspecified Filtration_value;
typedef unspecified Indexing_tag;
Simplex_handle null_simplex();
size_t num_simplices();
int dimension(Simplex_handle sh);
Filtration_value filtration(Simplex_handle sh);
Simplex_handle simplex ( size_t idx );
typedef unspecified Boundary_simplex_iterator;
typedef unspecified Boundary_simplex_range;
Boundary_simplex_range boundary_simplex_range(Simplex_handle sh);
typedef unspecified Filtration_simplex_iterator;
typedef unspecified Filtration_simplex_range;
Filtration_simplex_range filtration_simplex_range();
typedef unspecified Simplex_key;
Simplex_key null_key ();
Simplex_key key ( Simplex_handle sh );
void assign_key(Simplex_handle sh, Simplex_key n);
//typedef unspecified Complex_simplex_iterator;
//typedef unspecified Complex_simplex_range;
/*
* Returns a range over all the simplices of a
* complex.
*/
//Complex_simplex_range complex_simplex_range();
/*************************************************/
//int is_before_in_filtration(Simplex_handle s, Simplex_handle t);
/*************************************************/
};
FilteredComplex
The concept FilteredComplex describes the requirements for a type to implement a filtered cell comple...
Definition FilteredComplex.h:17
FilteredComplex::Boundary_simplex_iterator
unspecified Boundary_simplex_iterator
Iterator on the simplices belonging to the boundary of a simplex.
Definition FilteredComplex.h:52
FilteredComplex::Filtration_simplex_iterator
unspecified Filtration_simplex_iterator
Iterator over all simplices of the complex in the order of the indexing scheme.
Definition FilteredComplex.h:75
FilteredComplex::Boundary_simplex_range
unspecified Boundary_simplex_range
Range giving access to the simplices in the boundary of a simplex.
Definition FilteredComplex.h:57
FilteredComplex::Simplex_key
unspecified Simplex_key
Data stored for each simplex.
Definition FilteredComplex.h:91
FilteredComplex::filtration
Filtration_value filtration(Simplex_handle sh)
Returns the filtration value of a simplex.
FilteredComplex::assign_key
void assign_key(Simplex_handle sh, Simplex_key n)
Store a number for a simplex, which can later be retrieved with key(sh).
FilteredComplex::null_simplex
Simplex_handle null_simplex()
Returns a Simplex_handle that is different from all simplex handles of the simplices.
FilteredComplex::filtration_simplex_range
Filtration_simplex_range filtration_simplex_range()
Returns a range over the simplices of the complex in the order of the filtration.
FilteredComplex::Simplex_handle
unspecified Simplex_handle
Handle to specify a simplex.
Definition FilteredComplex.h:19
FilteredComplex::null_key
Simplex_key null_key()
Returns a constant dummy number that is either negative, or at least as large as num_simplices()....
FilteredComplex::Filtration_simplex_range
unspecified Filtration_simplex_range
Range over the simplices of the complex in the order of the filtration.
Definition FilteredComplex.h:79
FilteredComplex::key
Simplex_key key(Simplex_handle sh)
Returns the number stored for a simplex by assign_key.
FilteredComplex::Filtration_value
unspecified Filtration_value
Type for the value of the filtration function.
Definition FilteredComplex.h:23
FilteredComplex::dimension
int dimension(Simplex_handle sh)
Returns the dimension of a simplex.
FilteredComplex::Indexing_tag
unspecified Indexing_tag
Specifies the nature of the indexing scheme.
Definition FilteredComplex.h:28
FilteredComplex::simplex
Simplex_handle simplex(size_t idx)
Returns the simplex that has index idx in the filtration.
FilteredComplex::boundary_simplex_range
Boundary_simplex_range boundary_simplex_range(Simplex_handle sh)
Returns a range giving access to all simplices of the boundary of a simplex, i.e. the set of codimens...
FilteredComplex::num_simplices
size_t num_simplices()
Returns the number of simplices in the complex.