diff options
Diffstat (limited to 'src/common/doc')
| -rw-r--r-- | src/common/doc/file_formats.h | 30 | ||||
| -rw-r--r-- | src/common/doc/footer.html | 2 | ||||
| -rw-r--r-- | src/common/doc/installation.h | 14 | ||||
| -rw-r--r-- | src/common/doc/main_page.md | 50 |
4 files changed, 38 insertions, 58 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h index 235296d3..4af5d45c 100644 --- a/src/common/doc/file_formats.h +++ b/src/common/doc/file_formats.h @@ -1,24 +1,12 @@ -/* This file is part of the Gudhi Library. The Gudhi library -* (Geometric Understanding in Higher Dimensions) is a generic C++ -* library for computational topology. -* -* Author(s): Clément Jamin -* -* Copyright (C) 2017 Inria -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation, either version 3 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ +/* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT. + * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details. + * Author(s): Clément Jamin + * + * Copyright (C) 2017 Inria + * + * Modification(s): + * - YYYY/MM Author: Description of the modification + */ #ifndef DOC_COMMON_FILE_FORMAT_H_ #define DOC_COMMON_FILE_FORMAT_H_ diff --git a/src/common/doc/footer.html b/src/common/doc/footer.html index a557922b..4168c6bc 100644 --- a/src/common/doc/footer.html +++ b/src/common/doc/footer.html @@ -6,7 +6,7 @@ <!--BEGIN PROJECT_NAME--> $projectname <!--BEGIN PROJECT_NUMBER--> Version $projectnumber<!--END PROJECT_NUMBER--> <!--BEGIN PROJECT_BRIEF--> - $projectbrief<!--END PROJECT_BRIEF--> -<!--BEGIN PROJECT_BRIEF--> - Copyright : GPL v3<!--END PROJECT_BRIEF--> +<!--BEGIN PROJECT_BRIEF--> - Copyright : MIT<!--END PROJECT_BRIEF--> <!--END PROJECT_NAME--> </td> <td class="network-entypo"> diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 5d581b08..2629d12c 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -64,18 +64,16 @@ make doxygen * library which 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> for CGAL version ≥ 4.8.0), thereafter you will be able to compile + * <CODE>cmake -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to compile * GUDHI by calling <CODE>cmake -DCGAL_DIR=/your/path/to/CGAL-X.Y .. && make</CODE> * - * Having CGAL version 4.4.0 or higher installed is recommended. The procedure to install this library according to + * The procedure to install this library according to * your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html * * The following examples/utilities require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms - * Library</a> (CGAL \cite cgal:eb-15b) and will not be built if CGAL is not installed: + * Library</a> (CGAL \cite cgal:eb-15b) and will not be built if CGAL version 4.11.0 or higher is not installed: * \li <a href="_simplex_tree_2example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> * Simplex_tree/example_alpha_shapes_3_simplex_tree_from_off_file.cpp</a> - * - * The following examples/utilities require CGAL version ≥ 4.6.0: * \li <a href="_witness_complex_2strong_witness_persistence_8cpp-example.html"> * Witness_complex/strong_witness_persistence.cpp</a> * \li <a href="_witness_complex_2weak_witness_persistence_8cpp-example.html"> @@ -86,8 +84,6 @@ make doxygen * Witness_complex/example_witness_complex_off.cpp</a> * \li <a href="_witness_complex_2example_witness_complex_sphere_8cpp-example.html"> * Witness_complex/example_witness_complex_sphere.cpp</a> - * - * The following example requires CGAL version ≥ 4.7.0: * \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"> @@ -96,8 +92,6 @@ make doxygen * Alpha_complex/alpha_complex_persistence.cpp</a> * \li <a href="_persistent_cohomology_2custom_persistence_sort_8cpp-example.html"> * Persistent_cohomology/custom_persistence_sort.cpp</a> - * - * The following example requires CGAL version ≥ 4.8.1: * \li <a href="_bottleneck_distance_2alpha_rips_persistence_bottleneck_distance_8cpp-example.html"> * Bottleneck_distance/alpha_rips_persistence_bottleneck_distance.cpp.cpp</a> * \li <a href="_bottleneck_distance_2bottleneck_basic_example_8cpp-example.html"> @@ -126,8 +120,6 @@ make doxygen * Tangential_complex/example_basic.cpp</a> * \li <a href="_tangential_complex_2example_with_perturb_8cpp-example.html"> * Tangential_complex/example_with_perturb.cpp</a> - * - * The following example requires CGAL version ≥ 4.11.0: * \li <a href="_alpha_complex_2_weighted_alpha_complex_3d_from_points_8cpp-example.html"> * Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp</a> * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index 98169f82..ea2474be 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -19,7 +19,7 @@ <td width="15%"> <b>Author:</b> Pawel Dlotko<br> <b>Introduced in:</b> GUDHI 1.3.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -49,10 +49,8 @@ <td width="15%"> <b>Author:</b> Vincent Rouvreau<br> <b>Introduced in:</b> GUDHI 1.3.0<br> - <b>Copyright:</b> GPL v3<br> - <b>Requires:</b> \ref eigen3 and<br> - \ref cgal ≥ 4.7.0 for Alpha_complex<br> - \ref cgal ≥ 4.11.0 for Alpha_complex_3d + <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> + <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -76,7 +74,8 @@ <td width="15%"> <b>Author:</b> Vincent Rouvreau<br> <b>Introduced in:</b> GUDHI 2.2.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> + <b>Includes:</b> [Miniball](https://people.inf.ethz.ch/gaertner/subdir/software/miniball.html)<br> </td> </tr> <tr> @@ -102,7 +101,7 @@ <td width="15%"> <b>Author:</b> Clément Maria, Pawel Dlotko, Vincent Rouvreau, Marc Glisse<br> <b>Introduced in:</b> GUDHI 2.0.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -126,8 +125,8 @@ <td width="15%"> <b>Author:</b> Siargey Kachanovich<br> <b>Introduced in:</b> GUDHI 1.3.0<br> - <b>Copyright:</b> GPL v3<br> - <b>Euclidean version requires:</b> \ref cgal ≥ 4.6.0 and \ref eigen3 + <b>Copyright:</b> MIT ([GPL v3](../../licensing/) for Euclidean version)<br> + <b>Euclidean version requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -152,8 +151,8 @@ <td width="15%"> <b>Author:</b> Mathieu Carrière<br> <b>Introduced in:</b> GUDHI 2.1.0<br> - <b>Copyright:</b> GPL v3<br> - <b>Requires:</b> \ref cgal ≥ 4.8.1 + <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> + <b>Requires:</b> \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -181,7 +180,7 @@ <td width="15%"> <b>Author:</b> Clément Maria<br> <b>Introduced in:</b> GUDHI 1.0.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -209,7 +208,7 @@ <td width="15%"> <b>Author:</b> David Salinas<br> <b>Introduced in:</b> GUDHI 1.1.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -234,7 +233,7 @@ <td width="15%"> <b>Author:</b> François Godi<br> <b>Introduced in:</b> GUDHI 2.1.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -253,17 +252,18 @@ <td width="35%" rowspan=2> \image html "sphere_contraction_representation.png" </td> - <td width="15%"> - <b>Author:</b> David Salinas<br> - <b>Introduced in:</b> GUDHI 1.1.0<br> - <b>Copyright:</b> GPL v3<br> - </td> <td width="50%"> 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. </td> + <td width="15%"> + <b>Author:</b> David Salinas<br> + <b>Introduced in:</b> GUDHI 1.1.0<br> + <b>Copyright:</b> MIT [(LGPL v3)](../../licensing/)<br> + <b>Requires:</b> \ref cgal ≥ 4.11.0 + </td> </tr> <tr> <td colspan=2 height="25"> @@ -294,7 +294,7 @@ <td width="15%"> <b>Author:</b> Clément Maria<br> <b>Introduced in:</b> GUDHI 1.0.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> @@ -323,8 +323,8 @@ <td width="15%"> <b>Author:</b> Clément Jamin<br> <b>Introduced in:</b> GUDHI 2.0.0<br> - <b>Copyright:</b> GPL v3<br> - <b>Requires:</b> \ref cgal ≥ 4.8.1 and \ref eigen3 + <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> + <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -354,8 +354,8 @@ <td width="15%"> <b>Author:</b> François Godi<br> <b>Introduced in:</b> GUDHI 2.0.0<br> - <b>Copyright:</b> GPL v3<br> - <b>Requires:</b> \ref cgal ≥ 4.8.1 + <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> + <b>Requires:</b> \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -380,7 +380,7 @@ <td width="15%"> <b>Author:</b> Pawel Dlotko<br> <b>Introduced in:</b> GUDHI 2.1.0<br> - <b>Copyright:</b> GPL v3<br> + <b>Copyright:</b> MIT<br> </td> </tr> <tr> |