diff options
Diffstat (limited to 'src/common/doc/main_page.h')
| -rw-r--r-- | src/common/doc/main_page.h | 48 |
1 files changed, 26 insertions, 22 deletions
diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 4e36066f..f81f5a94 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -1,20 +1,38 @@ /** \mainpage +\image html "Gudhi_banner.jpg" "" width=20cm + The Gudhi library (Geometric Understanding in Higher Dimensions) is a generic C++ library for -computational topology. Its goal is to provide robust, efficient, flexible and easy to use +topological analysis of high-dimensional data whose goal is to provide robust, efficient, flexible and easy to use implementations of -state-of-the-art algorithms and data structures for computational topology. We refer to +state-of-the-art algorithms and data structures for computational topology. + +The current release of the library allows to use several data-structures for simplicial complexes : +simplex tree, Hasse diagram or skeleton-blocker. Several operations can then be done on top of these +representations persistent homology computation, or simplification. + +All data-structures are generic and several of their aspects (such as stored elements, policies) +can be parametrized via template classes. + +We refer to \cite gudhilibrary_ICMS14 for a detailed description of the design of the library. -The current release of the library allows the user to construct representations of simplicial complexes -- -simplex tree or Hasse diagram -- from a point -cloud (Rips complex) or -a list of simplices, and to compute their persistent homology with coefficients in a field -\f$\mathbb{Z}/p\mathbb{Z}\f$ (for an arbitrary prime \f$p\f$), or simultaneously with coefficients -in a family of fields (multi-field persistent homology). +\section Compiling + +The library uses c++11 and requires Boost with version 1.48.0 or more recent : http://www.boost.org/. +Some packages require additional libraries : +\li the multi-field persistent homology algorithm has an optional dependency with GMP +\li Qt demos require CGAL, Qt4 and QGLViewer + +The procedure to install these packages according to your operating system is +detailled here http://doc.cgal.org/latest/Manual/installation.html + +The library compiles in Linux, Mac OSX and visual studio 2013. + +\section d Demos and Examples To build the library, run the following in a terminal: @@ -26,22 +44,8 @@ cmake -DCMAKE_BUILD_TYPE=Release .. make \endverbatim -The library has dependencies with Boost 1.48.0 or more recent (required): http://www.boost.org/ -and with GMP: https://gmplib.org/ The dependency with GMP is optional, and is used only for the -multi-field persistent homology algorithm. - - -We provide example files: run these examples with -h for details on their use, and read the README file. - -\li <CODE>rips_persistence.cpp</CODE> computes the Rips complex of a point cloud and its persistence diagram. -\li <CODE>rips_multifield_persistence.cpp</CODE> computes the Rips complex of a point cloud and its persistence diagram -with a family of field coefficients. -\li <CODE>performance_rips_persistence.cpp</CODE> provides timings for the construction of the Rips complex on a set of -points sampling a Klein bottle in \f$\mathbb{R}^5\f$ with a simplex tree, its conversion to a -Hasse diagram and the computation of persistent homology and multi-field persistent homology for the -different representations. \details |