summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-17 14:16:05 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2014-12-17 14:16:05 +0000
commit1bdf7e623948b6737def08bcbff067a800cf9fa0 (patch)
treef67e112b534a5444eff1f09280619c4077fc4146
parented7d659f03f65be94de9e8f2b25088e83aa6fe85 (diff)
Version 1.1.0 - GMPXX removal from simplex_tree_from_alpha_shapes example - GMP and CGAL text modification on main page
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@375 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 6af168d44ff2e1a6220d1050221884f36e8fd79b
-rw-r--r--src/Doxyfile2
-rw-r--r--src/Simplex_tree/example/CMakeLists.txt5
-rw-r--r--src/common/doc/main_page.h31
3 files changed, 26 insertions, 12 deletions
diff --git a/src/Doxyfile b/src/Doxyfile
index 51629766..62412627 100644
--- a/src/Doxyfile
+++ b/src/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME = "Gudhi"
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = "1.0.3"
+PROJECT_NUMBER = "1.1.0"
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
diff --git a/src/Simplex_tree/example/CMakeLists.txt b/src/Simplex_tree/example/CMakeLists.txt
index ac145df5..3eafa61b 100644
--- a/src/Simplex_tree/example/CMakeLists.txt
+++ b/src/Simplex_tree/example/CMakeLists.txt
@@ -11,12 +11,11 @@ target_link_libraries(simple_simplex_tree ${Boost_SYSTEM_LIBRARY})
add_test(simple_simplex_tree ${CMAKE_CURRENT_BINARY_DIR}/simple_simplex_tree)
# An example with Simplex-tree using CGAL alpha_shapes_3
-if(GMPXX_FOUND AND GMP_FOUND AND CGAL_FOUND)
+if(GMP_FOUND AND CGAL_FOUND)
message("CGAL_lib = ${CGAL_LIBRARIES_DIR}")
- message("GMPXX_LIBRARIES = ${GMPXX_LIBRARIES}")
message("GMP_LIBRARIES = ${GMP_LIBRARIES}")
add_executable ( simplex_tree_from_alpha_shapes_3 simplex_tree_from_alpha_shapes_3.cpp )
- target_link_libraries(simplex_tree_from_alpha_shapes_3 ${Boost_SYSTEM_LIBRARY} ${GMPXX_LIBRARIES} ${GMP_LIBRARIES} ${CGAL_LIBRARY})
+ target_link_libraries(simplex_tree_from_alpha_shapes_3 ${Boost_SYSTEM_LIBRARY} ${GMP_LIBRARIES} ${CGAL_LIBRARY})
add_test(simplex_tree_from_alpha_shapes_3 ${CMAKE_CURRENT_BINARY_DIR}/simplex_tree_from_alpha_shapes_3 ${CMAKE_SOURCE_DIR}/data/points/bunny_5000)
endif()
diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h
index fd8f9046..b573f4d0 100644
--- a/src/common/doc/main_page.h
+++ b/src/common/doc/main_page.h
@@ -10,28 +10,43 @@ 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 such a spersistent homology computation or simplification.
+representations such a 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.
+can be parameterized via template classes.
We refer to
\cite gudhilibrary_ICMS14
for a detailed description of the design of the library.
-\section Compiling
+\section compiling Compiling
The library uses c++11 and requires Boost with version 1.48.0 or more recent : http://www.boost.org/.
-The multi-field persistent homology algorithm has a dependency with GMP and some demos requires CGAL https://www.cgal.org/.
+The library compiles in Linux and Mac OSX.
-The procedure to install these libraries according to your operating system is
-detailled here http://doc.cgal.org/latest/Manual/installation.html
+\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 library compiles in Linux and Mac OSX.
+The following examples require The GNU Multiple Precision Arithmetic Library (GMP) http://gmplib.org/
+and will not be built if GMP is not installed:
+ - Persistent_cohomology/rips_multifield_persistence
+ - Simplex_tree/simplex_tree_from_alpha_shapes_3
-\section d Demos and Examples
+Having GMP version 4.2 or higher installed is recommended. This library can be obtained from http://gmplib.org/
+
+\subsection cgal CGAL:
+CGAL is a C++ library which provides easy access to efficient and reliable geometric algorithms.
+
+The following example requires CGAL https://www.cgal.org/ and will not be built if CGAL is not installed:
+ - Simplex_tree/simplex_tree_from_alpha_shapes_3
+
+Having CGAL version 4.5 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
+
+\section demos Demos and Examples
To build the library, run the following in a terminal: