FilteredComplex.h
1 /* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
2  * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
3  * Author(s): ClĂ©ment Maria
4  *
5  * Copyright (C) 2014 Inria
6  *
7  * Modification(s):
8  * - YYYY/MM Author: Description of the modification
9  */
10 
17 {
19  typedef unspecified Simplex_handle;
23  typedef unspecified Filtration_value;
24 
28  typedef unspecified Indexing_tag;
29 
31  Simplex_handle null_simplex();
35  size_t num_simplices();
37  int dimension(Simplex_handle sh);
42  Filtration_value filtration(Simplex_handle sh);
43 
47  Simplex_handle simplex ( size_t idx );
52 typedef unspecified Boundary_simplex_iterator;
57 typedef unspecified Boundary_simplex_range;
58 
69 Boundary_simplex_range boundary_simplex_range(Simplex_handle sh);
70 
75 typedef unspecified Filtration_simplex_iterator;
79 typedef unspecified Filtration_simplex_range;
83 Filtration_simplex_range filtration_simplex_range();
84 
91  typedef unspecified Simplex_key;
94  Simplex_key null_key ();
98  Simplex_key key ( Simplex_handle sh );
102  void assign_key(Simplex_handle sh, Simplex_key n);
106 /* \brief Iterator over the simplices of the complex,
107  * in an arbitrary order.
108  *
109  * 'value_type' must be 'Simplex_handle'.*/
110 //typedef unspecified Complex_simplex_iterator;
111 //typedef unspecified Complex_simplex_range;
112 
113 /*
114 * Returns a range over all the simplices of a
115 * complex.
116 */
117 //Complex_simplex_range complex_simplex_range();
118 
119 /*************************************************/
128 //int is_before_in_filtration(Simplex_handle s, Simplex_handle t);
129 /*************************************************/
130 
131 };
unspecified Boundary_simplex_iterator
Iterator on the simplices belonging to the boundary of a simplex.
Definition: FilteredComplex.h:52
unspecified Simplex_key
Data stored for each simplex.
Definition: FilteredComplex.h:91
void assign_key(Simplex_handle sh, Simplex_key n)
Store a number for a simplex, which can later be retrieved with key(sh).
Simplex_handle simplex(size_t idx)
Returns the simplex that has index idx in the filtration.
Simplex_key null_key()
Returns a constant dummy number that is either negative, or at least as large as num_simplices(). Suggested value: -1.
Simplex_key key(Simplex_handle sh)
Returns the number stored for a simplex by assign_key.
unspecified Indexing_tag
Specifies the nature of the indexing scheme.
Definition: FilteredComplex.h:28
unspecified Filtration_simplex_iterator
Iterator over all simplices of the complex in the order of the indexing scheme.
Definition: FilteredComplex.h:75
Simplex_handle null_simplex()
Returns a Simplex_handle that is different from all simplex handles of the simplices.
unspecified Boundary_simplex_range
Range giving access to the simplices in the boundary of a simplex.
Definition: FilteredComplex.h:57
Filtration_simplex_range filtration_simplex_range()
Returns a range over the simplices of the complex in the order of the filtration. ...
size_t num_simplices()
Returns the number of simplices in the complex.
unspecified Simplex_handle
Handle to specify a simplex.
Definition: FilteredComplex.h:19
unspecified Filtration_simplex_range
Range over the simplices of the complex in the order of the filtration.
Definition: FilteredComplex.h:79
Filtration_value filtration(Simplex_handle sh)
Returns the filtration value of a simplex.
int dimension(Simplex_handle sh)
Returns the dimension of a simplex.
The concept FilteredComplex describes the requirements for a type to implement a filtered cell comple...
Definition: FilteredComplex.h:16
unspecified Filtration_value
Type for the value of the filtration function.
Definition: FilteredComplex.h:23
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...
GUDHI  Version 3.1.0  - C++ library for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding.  - Copyright : MIT Generated on Mon Jan 20 2020 14:12:57 for GUDHI by Doxygen 1.8.13