FilteredComplex.h
1  /* This file is part of the Gudhi Library. The Gudhi library
2  * (Geometric Understanding in Higher Dimensions) is a generic C++
3  * library for computational topology.
4  *
5  * Author(s): Clément Maria
6  *
7  * Copyright (C) 2014 INRIA Sophia Antipolis-Méditerranée (France)
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22 
29 {
31  typedef unspecified Simplex_handle;
35  typedef unspecified Simplex_key;
39  typedef unspecified Filtration_value;
40 
44  typedef unspecified Indexing_tag;
45 
48  Simplex_handle null_simplex();
52  size_t num_simplices();
54  int dimension(Simplex_handle sh);
59  Filtration_value filtration(Simplex_handle sh);
60 
63  Simplex_key null_key ();
67  Simplex_key key ( Simplex_handle sh );
71  Simplex_handle simplex ( Simplex_key idx );
73  void assign_key(Simplex_handle sh, Simplex_key key);
74 
80 typedef unspecified Boundary_simplex_iterator;
86 typedef unspecified Boundary_simplex_range;
87 
99 Boundary_simplex_range boundary_simplex_range(Simplex_handle sh);
100 
106 typedef unspecified Filtration_simplex_iterator;
111 typedef unspecified Filtration_simplex_range;
116 Filtration_simplex_range filtration_simplex_range();
117 
118 
119 /* \brief Iterator over the simplices of the complex,
120  * in an arbitrary order.
121  *
122  * 'value_type' must be 'Simplex_handle'.*/
123 //typedef unspecified Complex_simplex_iterator;
124 //typedef unspecified Complex_simplex_range;
125 
126 /*
127 * Returns a range over all the simplices of a
128 * complex.
129 */
130 //Complex_simplex_range complex_simplex_range();
131 
132 /*************************************************/
141 //int is_before_in_filtration(Simplex_handle s, Simplex_handle t);
142 /*************************************************/
143 
144 };
unspecified Boundary_simplex_iterator
Iterator on the simplices belonging to the boundary of a simplex.
Definition: FilteredComplex.h:80
unspecified Simplex_key
Key associated to each simplex.
Definition: FilteredComplex.h:35
void assign_key(Simplex_handle sh, Simplex_key key)
Assign a key to a simplex.
Simplex_key null_key()
Returns a key that is different from the keys associated to the simplices.
Simplex_key key(Simplex_handle sh)
Returns the key associated to a simplex.
unspecified Indexing_tag
Specifies the nature of the indexing scheme.
Definition: FilteredComplex.h:44
unspecified Filtration_simplex_iterator
Iterator over all simplices of the complex in the order of the indexing scheme.
Definition: FilteredComplex.h:106
Simplex_handle null_simplex()
unspecified Boundary_simplex_range
Range giving access to the simplices in the boundary of a simplex.
Definition: FilteredComplex.h:86
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
Definition: FilteredComplex.h:31
unspecified Filtration_simplex_range
Range over the simplices of the complex in the order of the filtration.
Definition: FilteredComplex.h:111
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:28
unspecified Filtration_value
Type for the value of the filtration function.
Definition: FilteredComplex.h:39
Simplex_handle simplex(Simplex_key idx)
Returns the simplex that has index idx in the filtration.
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 2.1.0  - C++ library for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding.  - Copyright : GPL v3 Generated on Wed Jan 31 2018 09:40:55 for GUDHI by Doxygen 1.8.11