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
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 Filtration_value;
36 
40  typedef unspecified Indexing_tag;
41 
44  Simplex_handle null_simplex();
48  size_t num_simplices();
50  int dimension(Simplex_handle sh);
55  Filtration_value filtration(Simplex_handle sh);
56 
60  Simplex_handle simplex ( size_t idx );
66 typedef unspecified Boundary_simplex_iterator;
72 typedef unspecified Boundary_simplex_range;
73 
85 Boundary_simplex_range boundary_simplex_range(Simplex_handle sh);
86 
92 typedef unspecified Filtration_simplex_iterator;
97 typedef unspecified Filtration_simplex_range;
102 Filtration_simplex_range filtration_simplex_range();
103 
110  typedef unspecified Simplex_key;
113  Simplex_key null_key ();
117  Simplex_key key ( Simplex_handle sh );
121  void assign_key(Simplex_handle sh, Simplex_key n);
125 /* \brief Iterator over the simplices of the complex,
126  * in an arbitrary order.
127  *
128  * 'value_type' must be 'Simplex_handle'.*/
129 //typedef unspecified Complex_simplex_iterator;
130 //typedef unspecified Complex_simplex_range;
131 
132 /*
133 * Returns a range over all the simplices of a
134 * complex.
135 */
136 //Complex_simplex_range complex_simplex_range();
137 
138 /*************************************************/
147 //int is_before_in_filtration(Simplex_handle s, Simplex_handle t);
148 /*************************************************/
149 
150 };
unspecified Boundary_simplex_iterator
Iterator on the simplices belonging to the boundary of a simplex.
Definition: FilteredComplex.h:66
unspecified Simplex_key
Data stored for each simplex.
Definition: FilteredComplex.h:110
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:40
unspecified Filtration_simplex_iterator
Iterator over all simplices of the complex in the order of the indexing scheme.
Definition: FilteredComplex.h:92
Simplex_handle null_simplex()
unspecified Boundary_simplex_range
Range giving access to the simplices in the boundary of a simplex.
Definition: FilteredComplex.h:72
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:97
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:35
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.3.0  - C++ library for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding.  - Copyright : GPL v3 Generated on Tue Sep 4 2018 14:32:59 for GUDHI by Doxygen 1.8.13