summaryrefslogtreecommitdiff
path: root/src/common
diff options
context:
space:
mode:
authorsalinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-15 17:44:43 +0000
committersalinasd <salinasd@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-15 17:44:43 +0000
commit6a6651c5a097f5024a42c9912723fe09ba714fe7 (patch)
tree372884c4fa9f15326e44618bf7b3541a606f8e4b /src/common
parent03275635bf6f01eab4f5df469fef8e6c5eed7ee7 (diff)
doc
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@353 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Diffstat (limited to 'src/common')
-rw-r--r--src/common/doc/Gudhi_banner.jpgbin0 -> 34437 bytes
-rw-r--r--src/common/doc/main_page.h48
-rw-r--r--src/common/include/gudhi/Utils.h2
3 files changed, 27 insertions, 23 deletions
diff --git a/src/common/doc/Gudhi_banner.jpg b/src/common/doc/Gudhi_banner.jpg
new file mode 100644
index 00000000..ebd3d8af
--- /dev/null
+++ b/src/common/doc/Gudhi_banner.jpg
Binary files differ
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
diff --git a/src/common/include/gudhi/Utils.h b/src/common/include/gudhi/Utils.h
index 7678685c..1626a0bf 100644
--- a/src/common/include/gudhi/Utils.h
+++ b/src/common/include/gudhi/Utils.h
@@ -25,7 +25,7 @@
#define PRINT(a) std::cerr << #a << ": " << (a) << " (DISP)"<<std::endl
-//#define DBG_VERBOSE
+#define DBG_VERBOSE
#ifdef DBG_VERBOSE
#define DBG(a) std::cerr << "DBG: " << (a)<<std::endl
#define DBGMSG(a,b) std::cerr << "DBG: " << a<<b<<std::endl