diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-08-20 17:05:13 +0200 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-08-20 17:05:13 +0200 |
commit | 87a8d7962ea13f11e591462ec5757e9e1747dc07 (patch) | |
tree | 5f1ca83e20cec1be410b119622177d2a3b5ae043 | |
parent | ed59f5bf1b35269cf4324dbb72df863bf50dac01 (diff) |
Fix issue #10 and modify main and installation documentations accordingly
-rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex.h | 13 | ||||
-rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex_3d.h | 11 | ||||
-rw-r--r-- | src/Bottleneck_distance/include/gudhi/Bottleneck.h | 10 | ||||
-rw-r--r-- | src/Contraction/include/gudhi/Skeleton_blocker_contractor.h | 9 | ||||
-rw-r--r-- | src/Nerve_GIC/include/gudhi/GIC.h | 8 | ||||
-rw-r--r-- | src/Spatial_searching/include/gudhi/Kd_tree_search.h | 13 | ||||
-rw-r--r-- | src/Tangential_complex/include/gudhi/Tangential_complex.h | 12 | ||||
-rw-r--r-- | src/Witness_complex/include/gudhi/Euclidean_strong_witness_complex.h | 14 | ||||
-rw-r--r-- | src/Witness_complex/include/gudhi/Euclidean_witness_complex.h | 14 | ||||
-rw-r--r-- | src/common/doc/installation.h | 12 | ||||
-rw-r--r-- | src/common/doc/main_page.md | 6 | ||||
-rw-r--r-- | src/common/include/gudhi/random_point_generators.h | 7 | ||||
-rw-r--r-- | src/cython/doc/alpha_complex_sum.inc | 34 | ||||
-rw-r--r-- | src/cython/doc/installation.rst | 18 | ||||
-rw-r--r-- | src/cython/doc/tangential_complex_sum.inc | 22 | ||||
-rw-r--r-- | src/cython/doc/witness_complex_sum.inc | 28 |
16 files changed, 166 insertions, 65 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h index cdc1ed1d..8919cdb9 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h @@ -5,6 +5,7 @@ * Copyright (C) 2015 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -23,6 +24,9 @@ #include <CGAL/Spatial_sort_traits_adapter_d.h> #include <CGAL/property_map.h> // for CGAL::Identity_property_map #include <CGAL/NT_converter.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST #include <iostream> #include <vector> @@ -33,6 +37,15 @@ #include <stdexcept> #include <numeric> // for std::iota +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace Gudhi { namespace alpha_complex { diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h index 9bff42b5..13ebb9c1 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h @@ -5,6 +5,7 @@ * Copyright (C) 2018 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -32,7 +33,9 @@ #include <CGAL/Object.h> #include <CGAL/tuple.h> #include <CGAL/iterator.h> -#include <CGAL/version.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST #include <boost/container/static_vector.hpp> @@ -45,11 +48,15 @@ #include <type_traits> // for std::conditional and std::enable_if #include <limits> // for numeric_limits<> -#if CGAL_VERSION_NR < 1041101000 // Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 # error Alpha_complex_3d is only available for CGAL >= 4.11 #endif +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace Gudhi { namespace alpha_complex { diff --git a/src/Bottleneck_distance/include/gudhi/Bottleneck.h b/src/Bottleneck_distance/include/gudhi/Bottleneck.h index d31c82ee..82ba9f68 100644 --- a/src/Bottleneck_distance/include/gudhi/Bottleneck.h +++ b/src/Bottleneck_distance/include/gudhi/Bottleneck.h @@ -5,8 +5,9 @@ * Copyright (C) 2015 Inria * * Modification(s): - * - YYYY/MM Author: Description of the modification * - 2019/06 Vincent Rouvreau : Fix doxygen warning. + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL + * - YYYY/MM Author: Description of the modification */ #ifndef BOTTLENECK_H_ @@ -14,6 +15,8 @@ #include <gudhi/Graph_matching.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + #include <vector> #include <algorithm> // for max #include <limits> // for numeric_limits @@ -21,6 +24,11 @@ #include <cmath> #include <cfloat> // FLT_EVAL_METHOD +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + namespace Gudhi { namespace persistence_diagram { diff --git a/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h b/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h index d9f8d9f4..c2b3157c 100644 --- a/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h +++ b/src/Contraction/include/gudhi/Skeleton_blocker_contractor.h @@ -5,6 +5,7 @@ * Copyright (C) 2014 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL * - YYYY/MM Author: Description of the modification */ @@ -24,8 +25,9 @@ #include <gudhi/Skeleton_blocker/Skeleton_blocker_complex_visitor.h> #include <gudhi/Debug_utils.h> -// todo remove the queue to be independent from cgald +// todo remove the queue to be independent from cgal #include <CGAL/Modifiable_priority_queue.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR #include <boost/scoped_array.hpp> #include <boost/scoped_ptr.hpp> @@ -36,6 +38,11 @@ #include <utility> // for pair #include <vector> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + namespace Gudhi { namespace contraction { diff --git a/src/Nerve_GIC/include/gudhi/GIC.h b/src/Nerve_GIC/include/gudhi/GIC.h index a1621ad9..fc6a2a91 100644 --- a/src/Nerve_GIC/include/gudhi/GIC.h +++ b/src/Nerve_GIC/include/gudhi/GIC.h @@ -5,6 +5,7 @@ * Copyright (C) 2017 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL * - YYYY/MM Author: Description of the modification */ @@ -34,6 +35,8 @@ #include <boost/graph/subgraph.hpp> #include <boost/graph/graph_utility.hpp> +#include <CGAL/version.h> // for CGAL_VERSION_NR + #include <iostream> #include <vector> #include <map> @@ -45,6 +48,11 @@ #include <cassert> #include <cmath> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + namespace Gudhi { namespace cover_complex { diff --git a/src/Spatial_searching/include/gudhi/Kd_tree_search.h b/src/Spatial_searching/include/gudhi/Kd_tree_search.h index 9e4666bb..fedbb32e 100644 --- a/src/Spatial_searching/include/gudhi/Kd_tree_search.h +++ b/src/Spatial_searching/include/gudhi/Kd_tree_search.h @@ -5,6 +5,7 @@ * Copyright (C) 2016 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -17,6 +18,9 @@ #include <CGAL/Search_traits_adapter.h> #include <CGAL/Fuzzy_sphere.h> #include <CGAL/property_map.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST #include <boost/property_map/property_map.hpp> #include <boost/iterator/counting_iterator.hpp> @@ -24,6 +28,15 @@ #include <cstddef> #include <vector> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace Gudhi { namespace spatial_searching { diff --git a/src/Tangential_complex/include/gudhi/Tangential_complex.h b/src/Tangential_complex/include/gudhi/Tangential_complex.h index b3bac58e..f59476b1 100644 --- a/src/Tangential_complex/include/gudhi/Tangential_complex.h +++ b/src/Tangential_complex/include/gudhi/Tangential_complex.h @@ -5,6 +5,7 @@ * Copyright (C) 2016 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -29,9 +30,11 @@ #include <CGAL/Delaunay_triangulation.h> #include <CGAL/Combination_enumerator.h> #include <CGAL/point_generators_d.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR #include <Eigen/Core> #include <Eigen/Eigen> +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST #include <boost/optional.hpp> #include <boost/iterator/transform_iterator.hpp> @@ -62,6 +65,15 @@ // #define GUDHI_TC_EXPORT_NORMALS // Only for 3D surfaces (k=2, d=3) +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace sps = Gudhi::spatial_searching; namespace Gudhi { diff --git a/src/Witness_complex/include/gudhi/Euclidean_strong_witness_complex.h b/src/Witness_complex/include/gudhi/Euclidean_strong_witness_complex.h index c9767982..7d3c2d6d 100644 --- a/src/Witness_complex/include/gudhi/Euclidean_strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Euclidean_strong_witness_complex.h @@ -5,6 +5,7 @@ * Copyright (C) 2015 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -15,9 +16,22 @@ #include <gudhi/Active_witness/Active_witness.h> #include <gudhi/Kd_tree_search.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST + #include <utility> #include <vector> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace Gudhi { namespace witness_complex { diff --git a/src/Witness_complex/include/gudhi/Euclidean_witness_complex.h b/src/Witness_complex/include/gudhi/Euclidean_witness_complex.h index 75ea38e9..21682ec4 100644 --- a/src/Witness_complex/include/gudhi/Euclidean_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Euclidean_witness_complex.h @@ -5,6 +5,7 @@ * Copyright (C) 2015 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL and Eigen3 * - YYYY/MM Author: Description of the modification */ @@ -15,11 +16,24 @@ #include <gudhi/Active_witness/Active_witness.h> #include <gudhi/Kd_tree_search.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR + +#include <Eigen/src/Core/util/Macros.h> // for EIGEN_VERSION_AT_LEAST + #include <utility> #include <vector> #include <list> #include <limits> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + +#if !EIGEN_VERSION_AT_LEAST(3,1,0) +# error Alpha_complex_3d is only available for Eigen3 >= 3.1.0 installed with CGAL +#endif + namespace Gudhi { namespace witness_complex { diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 2629d12c..02d3c73a 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -60,8 +60,8 @@ make doxygen * Having GMP version 4.2 or higher installed is recommended. * * \subsection cgal CGAL - * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ - * library which provides easy access to efficient and reliable geometric algorithms. + * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples requires CGAL, a C++ library that provides + * easy access to efficient and reliable geometric algorithms. * * \note There is no need to install CGAL, you can just <CODE>cmake . && make</CODE> CGAL (or even * <CODE>cmake -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to compile @@ -125,13 +125,13 @@ make doxygen * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> * - * \subsection eigen3 Eigen3 + * \subsection eigen Eigen * The \ref alpha_complex data structure and few examples requires - * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> is a C++ template library for linear algebra: + * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> is a C++ template library for linear algebra: * matrices, vectors, numerical solvers, and related algorithms. * - * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> and will not be - * built if Eigen3 is not installed: + * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> and will not be + * built if Eigen is not installed: * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index ea2474be..d8cbf97f 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -50,7 +50,7 @@ <b>Author:</b> Vincent Rouvreau<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -126,7 +126,7 @@ <b>Author:</b> Siargey Kachanovich<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT ([GPL v3](../../licensing/) for Euclidean version)<br> - <b>Euclidean version requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Euclidean version requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -324,7 +324,7 @@ <b>Author:</b> Clément Jamin<br> <b>Introduced in:</b> GUDHI 2.0.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> diff --git a/src/common/include/gudhi/random_point_generators.h b/src/common/include/gudhi/random_point_generators.h index 7889b9ca..fb69f832 100644 --- a/src/common/include/gudhi/random_point_generators.h +++ b/src/common/include/gudhi/random_point_generators.h @@ -5,6 +5,7 @@ * Copyright (C) 2016 Inria * * Modification(s): + * - 2019/08 Vincent Rouvreau: Fix issue #10 for CGAL * - YYYY/MM Author: Description of the modification */ @@ -14,9 +15,15 @@ #include <CGAL/number_utils.h> #include <CGAL/Random.h> #include <CGAL/point_generators_d.h> +#include <CGAL/version.h> // for CGAL_VERSION_NR #include <vector> // for vector<> +// Make compilation fail - required for external projects - https://github.com/GUDHI/gudhi-devel/issues/10 +#if CGAL_VERSION_NR < 1041101000 +# error Alpha_complex_3d is only available for CGAL >= 4.11 +#endif + namespace Gudhi { /////////////////////////////////////////////////////////////////////////////// diff --git a/src/cython/doc/alpha_complex_sum.inc b/src/cython/doc/alpha_complex_sum.inc index 9049e654..c5ba9dc7 100644 --- a/src/cython/doc/alpha_complex_sum.inc +++ b/src/cython/doc/alpha_complex_sum.inc @@ -1,20 +1,20 @@ .. table:: :widths: 30 50 20 - +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | .. figure:: | Alpha complex is a simplicial complex constructed from the finite | :Author: Vincent Rouvreau | - | ../../doc/Alpha_complex/alpha_complex_representation.png | cells of a Delaunay Triangulation. | | - | :alt: Alpha complex representation | | :Introduced in: GUDHI 2.0.0 | - | :figclass: align-center | The filtration value of each simplex is computed as the square of the | | - | | circumradius of the simplex if the circumsphere is empty (the simplex | :Copyright: MIT (`GPL v3 </licensing/>`_) | - | | is then said to be Gabriel), and as the minimum of the filtration | | - | | values of the codimension 1 cofaces that make it not Gabriel | :Requires: `Eigen3 <installation.html#eigen3>`__ and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 | - | | otherwise. All simplices that have a filtration value strictly | | - | | greater than a given alpha squared value are not inserted into the | | - | | complex. | | - | | | | - | | This package requires having CGAL version 4.7 or higher (4.8.1 is | | - | | advised for better performance). | | - +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ - | * :doc:`alpha_complex_user` | * :doc:`alpha_complex_ref` | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | .. figure:: | Alpha complex is a simplicial complex constructed from the finite | :Author: Vincent Rouvreau | + | ../../doc/Alpha_complex/alpha_complex_representation.png | cells of a Delaunay Triangulation. | | + | :alt: Alpha complex representation | | :Introduced in: GUDHI 2.0.0 | + | :figclass: align-center | The filtration value of each simplex is computed as the square of the | | + | | circumradius of the simplex if the circumsphere is empty (the simplex | :Copyright: MIT (`GPL v3 </licensing/>`_) | + | | is then said to be Gabriel), and as the minimum of the filtration | | + | | values of the codimension 1 cofaces that make it not Gabriel | :Requires: `Eigen <installation.html#eigen>`__ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 | + | | otherwise. All simplices that have a filtration value strictly | | + | | greater than a given alpha squared value are not inserted into the | | + | | complex. | | + | | | | + | | This package requires having CGAL version 4.7 or higher (4.8.1 is | | + | | advised for better performance). | | + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | * :doc:`alpha_complex_user` | * :doc:`alpha_complex_ref` | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/installation.rst b/src/cython/doc/installation.rst index 02b889d0..e40a2ef9 100644 --- a/src/cython/doc/installation.rst +++ b/src/cython/doc/installation.rst @@ -144,12 +144,10 @@ Optional third-party library CGAL ==== -The :doc:`Alpha complex </alpha_complex_user>`, -:doc:`Tangential complex </tangential_complex_user>` and -:doc:`Witness complex </witness_complex_user>` data structures, and -:doc:`Bottleneck distance </bottleneck_distance_user>` requires CGAL, which is a -C++ library which provides easy access to efficient and reliable geometric -algorithms. +Some GUDHI modules (cf. :doc:`modules list </index>`), and few examples +requires CGAL, a C++ library that provides easy access to efficient and +reliable geometric algorithms. + The procedure to install this library according to your operating system is detailed @@ -166,17 +164,17 @@ The following examples requires CGAL version ≥ 4.11.0: * :download:`euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_strong_witness_complex_diagram_persistence_from_off_file_example.py>` * :download:`euclidean_witness_complex_diagram_persistence_from_off_file_example.py <../example/euclidean_witness_complex_diagram_persistence_from_off_file_example.py>` -Eigen3 -====== +Eigen +===== The :doc:`Alpha complex </alpha_complex_user>`, :doc:`Tangential complex </tangential_complex_user>` and :doc:`Witness complex </witness_complex_user>` data structures and few -examples requires `Eigen3 <http://eigen.tuxfamily.org/>`_, a C++ template +examples requires `Eigen <http://eigen.tuxfamily.org/>`_, a C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms. -The following examples require the `Eigen3 <http://eigen.tuxfamily.org/>`_: +The following examples require `Eigen <http://eigen.tuxfamily.org/>`_ version ≥ 3.1.0: .. only:: builder_html diff --git a/src/cython/doc/tangential_complex_sum.inc b/src/cython/doc/tangential_complex_sum.inc index c8bc1177..d84aa433 100644 --- a/src/cython/doc/tangential_complex_sum.inc +++ b/src/cython/doc/tangential_complex_sum.inc @@ -1,14 +1,14 @@ .. table:: :widths: 30 50 20 - +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------------------------------------+ - | .. figure:: | A Tangential Delaunay complex is a simplicial complex designed to | :Author: Clément Jamin | - | ../../doc/Tangential_complex/tc_examples.png | reconstruct a :math:`k`-dimensional manifold embedded in :math:`d`- | | - | :figclass: align-center | dimensional Euclidean space. The input is a point sample coming from | :Introduced in: GUDHI 2.0.0 | - | | an unknown manifold. The running time depends only linearly on the | | - | | extrinsic dimension :math:`d` and exponentially on the intrinsic | :Copyright: MIT (`GPL v3 </licensing/>`_) | - | | dimension :math:`k`. | | - | | | :Requires: `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 | - +----------------------------------------------------------------+------------------------------------------------------------------------+------------------------------------------------------------------+ - | * :doc:`tangential_complex_user` | * :doc:`tangential_complex_ref` | - +----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | .. figure:: | A Tangential Delaunay complex is a simplicial complex designed to | :Author: Clément Jamin | + | ../../doc/Tangential_complex/tc_examples.png | reconstruct a :math:`k`-dimensional manifold embedded in :math:`d`- | | + | :figclass: align-center | dimensional Euclidean space. The input is a point sample coming from | :Introduced in: GUDHI 2.0.0 | + | | an unknown manifold. The running time depends only linearly on the | | + | | extrinsic dimension :math:`d` and exponentially on the intrinsic | :Copyright: MIT (`GPL v3 </licensing/>`_) | + | | dimension :math:`k`. | | + | | | :Requires: `Eigen <installation.html#eigen>`__ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 | + +----------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | * :doc:`tangential_complex_user` | * :doc:`tangential_complex_ref` | + +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/src/cython/doc/witness_complex_sum.inc b/src/cython/doc/witness_complex_sum.inc index 2be8b220..71b65a71 100644 --- a/src/cython/doc/witness_complex_sum.inc +++ b/src/cython/doc/witness_complex_sum.inc @@ -1,18 +1,18 @@ .. table:: :widths: 30 50 20 - +-------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | .. figure:: | Witness complex :math:`Wit(W,L)` is a simplicial complex defined on | :Author: Siargey Kachanovich | - | ../../doc/Witness_complex/Witness_complex_representation.png | two sets of points in :math:`\mathbb{R}^D`. | | - | :alt: Witness complex representation | | :Introduced in: GUDHI 2.0.0 | - | :figclass: align-center | The data structure is described in | | - | | :cite:`boissonnatmariasimplextreealgorithmica`. | :Copyright: MIT (`GPL v3 </licensing/>`_ for Euclidean versions only) | - | | | | - | | | :Requires: `Eigen3 <installation.html#eigen3>`__ and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 for Euclidean versions only | - +-------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | * :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | - | | * :doc:`strong_witness_complex_ref` | - | | * :doc:`euclidean_witness_complex_ref` | - | | * :doc:`euclidean_strong_witness_complex_ref` | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | .. figure:: | Witness complex :math:`Wit(W,L)` is a simplicial complex defined on | :Author: Siargey Kachanovich | + | ../../doc/Witness_complex/Witness_complex_representation.png | two sets of points in :math:`\mathbb{R}^D`. | | + | :alt: Witness complex representation | | :Introduced in: GUDHI 2.0.0 | + | :figclass: align-center | The data structure is described in | | + | | :cite:`boissonnatmariasimplextreealgorithmica`. | :Copyright: MIT (`GPL v3 </licensing/>`_ for Euclidean versions only) | + | | | | + | | | :Requires: `Eigen <installation.html#eigen>`__ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`__ :math:`\geq` 4.11.0 for Euclidean versions only | + +-------------------------------------------------------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | * :doc:`witness_complex_user` | * :doc:`witness_complex_ref` | + | | * :doc:`strong_witness_complex_ref` | + | | * :doc:`euclidean_witness_complex_ref` | + | | * :doc:`euclidean_strong_witness_complex_ref` | + +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |