1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/*! \mainpage
* \tableofcontents
* \image html "Gudhi_banner.jpg" "" width=20cm
*
* \section Introduction Introduction
* The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic open source C++ library for
* Computational Topology and Topological Data Analysis
* (<a class="el" target="_blank" href="https://en.wikipedia.org/wiki/Topological_data_analysis">TDA</a>).
* The GUDHI library intends to help the development of new algorithmic solutions in TDA and their transfer to
* applications. It provides robust, efficient, flexible and easy to use implementations of state-of-the-art
* algorithms and data structures.
*
* The current release of the GUDHI library includes:
*
* \li Data structures to represent, construct and manipulate simplicial complexes.
* \li Algorithms to compute persistent homology and multi-field persistent homology.
* \li Simplication of simplicial complexes by edge contraction.
*
* All data-structures are generic and several of their aspects can be parameterized via template classes.
* We refer to \cite gudhilibrary_ICMS14 for a detailed description of the design of the library.
*
\section DataStructures Data structures
\subsection SimplexTreeDataStructure Simplex tree
\image html "Simplex_tree_representation.png" "Simplex tree representation"
<table border="0">
<tr>
<td width="25%">
<b>Introduced in:</b> GUDHI 1.0.0<br>
<b>Copyright:</b> GPL v3<br>
</td>
<td width="75%">
<i>Clément Maria</i><br>
The simplex tree is an efficient and flexible
data structure for representing general (filtered) simplicial complexes. The data structure
is described in \cite boissonnatmariasimplextreealgorithmica .<br>
<b>User manual:</b> \ref simplex_tree - <b>Reference manual:</b> Gudhi::Simplex_tree
</td>
</tr>
</table>
\subsection SkeletonBlockerDataStructure Skeleton blocker
\image html "ds_representation.png" "Skeleton blocker representation"
<table border="0">
<tr>
<td width="25%">
<b>Introduced in:</b> GUDHI 1.1.0<br>
<b>Copyright:</b> GPL v3<br>
</td>
<td width="75%">
<i>David Salinas</i><br>
The Skeleton-Blocker data-structure proposes a light encoding for simplicial complexes by storing only an *implicit*
representation of its simplices \cite socg_blockers_2011,\cite blockers2012. Intuitively, it just stores the
1-skeleton of a simplicial complex with a graph and the set of its "missing faces" that is very small in practice.
This data-structure handles all simplicial complexes operations such as simplex enumeration or simplex removal but
operations that are particularly efficient are operations that do not require simplex enumeration such as edge
iteration, link computation or simplex contraction.<br>
<b>User manual:</b> \ref skbl - <b>Reference manual:</b> Gudhi::skbl::Skeleton_blocker_complex
</td>
</tr>
</table>
\section Toolbox Toolbox
\subsection PersistentCohomologyToolbox Persistent Cohomology
\image html "barcode_poch.png" "Persistent Cohomology represented as a barcode"
<table border="0">
<tr>
<td width="25%">
<b>Introduced in:</b> GUDHI 1.0.0<br>
<b>Copyright:</b> GPL v3<br>
</td>
<td width="75%">
<i>Clément Maria</i><br>
The theory of homology consists in attaching to a topological space a sequence of (homology) groups, capturing
global topological features like connected components, holes, cavities, etc. Persistent homology studies the
evolution -- birth, life and death -- of these features when the topological space is changing. Consequently, the
theory is essentially composed of three elements: topological spaces, their homology groups and an evolution
scheme.
Computation of persistent cohomology using the algorithm of \cite DBLP:journals/dcg/SilvaMV11 and
\cite DBLP:journals/corr/abs-1208-5018 and the Compressed Annotation Matrix implementation of
\cite DBLP:conf/esa/BoissonnatDM13 .<br>
<b>User manual:</b> \ref persistent_cohomology
</td>
</tr>
</table>
\subsection ContractionToolbox Contraction
\image html "sphere_contraction_representation.png" "Sphere contraction example"
<table border="0">
<tr>
<td width="25%">
<b>Introduced in:</b> GUDHI 1.1.0<br>
<b>Copyright:</b> GPL v3<br>
</td>
<td width="75%">
<i>David Salinas</i><br>
The purpose of this package is to offer a user-friendly interface for edge contraction simplification of huge
simplicial complexes. It uses the \ref skbl data-structure whose size remains small during simplification of most
used geometrical complexes of topological data analysis such as the Rips or the Delaunay complexes. In practice,
the size of this data-structure is even much lower than the total number of simplices.<br>
<b>User manual:</b> \ref contr
</td>
</tr>
</table>
*/
/*! \page installation Gudhi installation
* As Gudhi is a header only library, there is no need to install the library.
*
* Examples of Gudhi headers inclusion can be found in \ref demos.
*
* \section compiling Compiling
* The library uses c++11 and requires <a target="_blank" href="http://www.boost.org/">Boost</a> with version 1.48.0 or
* more recent. It is a multi-platform library and compiles on Linux, Mac OSX and Visual Studio 2015.
*
* \subsection gmp GMP:
* The multi-field persistent homology algorithm requires GMP which is a free library for arbitrary-precision
* arithmetic, operating on signed integers, rational numbers, and floating point numbers.
*
* The following example requires the <a target="_blank" href="http://gmplib.org/">GNU Multiple Precision Arithmetic
* Library</a> (GMP) and will not be built if GMP is not installed:
* \li Persistent_cohomology/rips_multifield_persistence
*
* Having GMP version 4.2 or higher installed is recommended.
*
* \subsection cgal CGAL:
* CGAL is a C++ library which provides easy access to efficient and reliable geometric algorithms.
*
* The following examples require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms
* Library</a> (CGAL) and will not be built if CGAL is not installed:
* \li GudhUI
* \li Persistent_cohomology/alpha_shapes_persistence
* \li Simplex_tree/simplex_tree_from_alpha_shapes_3
*
* Having CGAL version 4.4 or higher installed is recommended. The procedure to install this library according to
* your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html
*
* \subsection demos Demos and examples
* To build the demos and libraries, run the following commands in a terminal:
\verbatim cd /path-to-gudhi/
mkdir build
cd build/
cmake ..
make \endverbatim
*
* \subsection testsuites Test suites
* To test your build, run the following command in a terminal:
* \verbatim make test \endverbatim
*
* \section Contributions Bug reports and contributions
* Please help us improving the quality of the GUDHI library. You may report bugs or suggestions to:
* \verbatim Contact: gudhi-users@lists.gforge.inria.fr \endverbatim
*
* Gudhi is open to external contributions. If you want to join our development team, please contact us.
*
*/
/*! \page Upcoming Upcoming
*
* The library is under active development. New packages to be released next include:
* \li Alpha complex.
* \li Bottleneck distance.
* \li Zig zag persistence.
* \li Witness complex.
* \li Tangential complex.
* \li Clustering.
*/
/*! \page Citation Acknowledging the GUDHI library
* We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use
* of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages.
* Feel free to contact us in case you have any question or remark on this topic.
*
* We provide \ref GudhiBibtex entries for the modules of the User and Reference Manual, as well as for publications
* directly related to the GUDHI library.
* \section GudhiBibtex GUDHI bibtex
* \verbinclude biblio/how_to_cite_gudhi.bib
*/
|
