From a424f92e94783648422edbd639da19d92a94cf90 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Tue, 31 Jan 2017 21:35:37 +0000 Subject: Rename Rips and Alpha concept file names GUDHI version 2.0.0 git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_doc_2.0.0@2038 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: be93fae5a69b15de05bfabe75a2d84ef606b589f --- CMakeGUDHIVersion.txt | 6 +- .../concept/SimplicialComplexForAlpha.h | 89 ++++++++++++++++++++++ .../concept/Simplicial_complex_for_alpha.h | 89 ---------------------- .../concept/SimplicialComplexForRips.h | 54 +++++++++++++ .../concept/Simplicial_complex_for_rips.h | 54 ------------- src/common/doc/main_page.h | 6 +- 6 files changed, 149 insertions(+), 149 deletions(-) create mode 100644 src/Alpha_complex/concept/SimplicialComplexForAlpha.h delete mode 100644 src/Alpha_complex/concept/Simplicial_complex_for_alpha.h create mode 100644 src/Rips_complex/concept/SimplicialComplexForRips.h delete mode 100644 src/Rips_complex/concept/Simplicial_complex_for_rips.h diff --git a/CMakeGUDHIVersion.txt b/CMakeGUDHIVersion.txt index a00ae1b2..bd0c57ac 100644 --- a/CMakeGUDHIVersion.txt +++ b/CMakeGUDHIVersion.txt @@ -1,6 +1,6 @@ -set (GUDHI_MAJOR_VERSION 1) -set (GUDHI_MINOR_VERSION 3) -set (GUDHI_PATCH_VERSION 1) +set (GUDHI_MAJOR_VERSION 2) +set (GUDHI_MINOR_VERSION 0) +set (GUDHI_PATCH_VERSION 0) set(GUDHI_VERSION ${GUDHI_MAJOR_VERSION}.${GUDHI_MINOR_VERSION}.${GUDHI_PATCH_VERSION}) message(STATUS "GUDHI version : ${GUDHI_VERSION}") diff --git a/src/Alpha_complex/concept/SimplicialComplexForAlpha.h b/src/Alpha_complex/concept/SimplicialComplexForAlpha.h new file mode 100644 index 00000000..2b8bff94 --- /dev/null +++ b/src/Alpha_complex/concept/SimplicialComplexForAlpha.h @@ -0,0 +1,89 @@ +/* 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): Vincent Rouvreau + * + * Copyright (C) 2016 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 . + */ + +#ifndef CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ +#define CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ + +namespace Gudhi { + +namespace alpha_complex { + +/** \brief The concept SimplicialComplexForAlpha describes the requirements for a type to implement a simplicial + * complex, that can be created from a `Alpha_complex`. + */ +struct SimplicialComplexForAlpha { + /** Handle to specify a simplex. */ + typedef unspecified Simplex_handle; + /** Handle to specify a vertex. Must be a non-negative integer. */ + typedef unspecified Vertex_handle; + /** Handle to specify the simplex filtration value. */ + typedef unspecified Filtration_value; + + /** Returns the number of vertices in the simplicial complex. */ + std::size_t num_vertices(); + + /** Sets the simplicial complex dimension. */ + void set_dimension(int dimension); + + /** Gets the 'simplex' dimension. */ + int dimension(Simplex_handle simplex); + + /** Assigns the 'simplex' with the given 'filtration' value. */ + int assign_filtration(Simplex_handle simplex, Filtration_value filtration); + + /** \brief Inserts a simplex with vertices from a given simplex (represented by a vector of Vertex_handle) in the + * simplicial complex with the given 'filtration' value. */ + void insert_simplex_and_subfaces(std::vector const & vertex_range, Filtration_value filtration); + + /** Browses the simplicial complex to make the filtration non-decreasing. */ + void make_filtration_non_decreasing(); + + /** Prune the simplicial complex above 'filtration' value given as parameter. */ + void prune_above_filtration(Filtration_value filtration); + + /** \brief Iterator over vertices of a simplex. + * + * 'value type' must be 'Vertex_handle'.*/ + typedef unspecified Simplex_vertex_range; + + /** \brief Returns a range over vertices of a given + * simplex. */ + Simplex_vertex_range simplex_vertex_range(Simplex_handle const & simplex); + + /** \brief Iterator over the boundaries of the complex, in an arbitrary order. + * + * 'value_type' must be 'Simplex_handle'.*/ + typedef unspecified Boundary_simplex_range; + + /** \brief Returns a range over boundaries of a given simplex. */ + Boundary_simplex_range boundary_simplex_range(Simplex_handle const & simplex); + + /** \brief Return type of an insertion of a simplex + */ + typedef unspecified Insertion_result_type; +}; + +} // namespace alpha_complex + +} // namespace Gudhi + +#endif // CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ diff --git a/src/Alpha_complex/concept/Simplicial_complex_for_alpha.h b/src/Alpha_complex/concept/Simplicial_complex_for_alpha.h deleted file mode 100644 index 2b8bff94..00000000 --- a/src/Alpha_complex/concept/Simplicial_complex_for_alpha.h +++ /dev/null @@ -1,89 +0,0 @@ -/* 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): Vincent Rouvreau - * - * Copyright (C) 2016 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 . - */ - -#ifndef CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ -#define CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ - -namespace Gudhi { - -namespace alpha_complex { - -/** \brief The concept SimplicialComplexForAlpha describes the requirements for a type to implement a simplicial - * complex, that can be created from a `Alpha_complex`. - */ -struct SimplicialComplexForAlpha { - /** Handle to specify a simplex. */ - typedef unspecified Simplex_handle; - /** Handle to specify a vertex. Must be a non-negative integer. */ - typedef unspecified Vertex_handle; - /** Handle to specify the simplex filtration value. */ - typedef unspecified Filtration_value; - - /** Returns the number of vertices in the simplicial complex. */ - std::size_t num_vertices(); - - /** Sets the simplicial complex dimension. */ - void set_dimension(int dimension); - - /** Gets the 'simplex' dimension. */ - int dimension(Simplex_handle simplex); - - /** Assigns the 'simplex' with the given 'filtration' value. */ - int assign_filtration(Simplex_handle simplex, Filtration_value filtration); - - /** \brief Inserts a simplex with vertices from a given simplex (represented by a vector of Vertex_handle) in the - * simplicial complex with the given 'filtration' value. */ - void insert_simplex_and_subfaces(std::vector const & vertex_range, Filtration_value filtration); - - /** Browses the simplicial complex to make the filtration non-decreasing. */ - void make_filtration_non_decreasing(); - - /** Prune the simplicial complex above 'filtration' value given as parameter. */ - void prune_above_filtration(Filtration_value filtration); - - /** \brief Iterator over vertices of a simplex. - * - * 'value type' must be 'Vertex_handle'.*/ - typedef unspecified Simplex_vertex_range; - - /** \brief Returns a range over vertices of a given - * simplex. */ - Simplex_vertex_range simplex_vertex_range(Simplex_handle const & simplex); - - /** \brief Iterator over the boundaries of the complex, in an arbitrary order. - * - * 'value_type' must be 'Simplex_handle'.*/ - typedef unspecified Boundary_simplex_range; - - /** \brief Returns a range over boundaries of a given simplex. */ - Boundary_simplex_range boundary_simplex_range(Simplex_handle const & simplex); - - /** \brief Return type of an insertion of a simplex - */ - typedef unspecified Insertion_result_type; -}; - -} // namespace alpha_complex - -} // namespace Gudhi - -#endif // CONCEPT_ALPHA_COMPLEX_SIMPLICIAL_COMPLEX_FOR_ALPHA_H_ diff --git a/src/Rips_complex/concept/SimplicialComplexForRips.h b/src/Rips_complex/concept/SimplicialComplexForRips.h new file mode 100644 index 00000000..7dab0615 --- /dev/null +++ b/src/Rips_complex/concept/SimplicialComplexForRips.h @@ -0,0 +1,54 @@ +/* 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): Vincent Rouvreau + * + * Copyright (C) 2016 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 . + */ + +#ifndef CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ +#define CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ + +namespace Gudhi { + +namespace rips_complex { + +/** \brief The concept SimplicialComplexForRips describes the requirements for a type to implement a simplicial + * complex, that can be created from a `Rips_complex`. The only available model for the moment is the `Simplex_tree`. + */ +struct SimplicialComplexForRips { + /** \brief Type used to store the filtration values of the simplicial complex. */ + typedef unspecified Filtration_value; + + /** \brief Inserts a given `Gudhi::rips_complex::Rips_complex::OneSkeletonGraph` in the simplicial complex. */ + template + void insert_graph(const OneSkeletonGraph& skel_graph); + + /** \brief Expands the simplicial complex containing only its one skeleton until a given maximal dimension as + * explained in \ref ripsdefinition. */ + void expansion(int max_dim); + + /** \brief Returns the number of vertices in the simplicial complex. */ + std::size_t num_vertices(); + +}; + +} // namespace rips_complex + +} // namespace Gudhi + +#endif // CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ diff --git a/src/Rips_complex/concept/Simplicial_complex_for_rips.h b/src/Rips_complex/concept/Simplicial_complex_for_rips.h deleted file mode 100644 index 7dab0615..00000000 --- a/src/Rips_complex/concept/Simplicial_complex_for_rips.h +++ /dev/null @@ -1,54 +0,0 @@ -/* 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): Vincent Rouvreau - * - * Copyright (C) 2016 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 . - */ - -#ifndef CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ -#define CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ - -namespace Gudhi { - -namespace rips_complex { - -/** \brief The concept SimplicialComplexForRips describes the requirements for a type to implement a simplicial - * complex, that can be created from a `Rips_complex`. The only available model for the moment is the `Simplex_tree`. - */ -struct SimplicialComplexForRips { - /** \brief Type used to store the filtration values of the simplicial complex. */ - typedef unspecified Filtration_value; - - /** \brief Inserts a given `Gudhi::rips_complex::Rips_complex::OneSkeletonGraph` in the simplicial complex. */ - template - void insert_graph(const OneSkeletonGraph& skel_graph); - - /** \brief Expands the simplicial complex containing only its one skeleton until a given maximal dimension as - * explained in \ref ripsdefinition. */ - void expansion(int max_dim); - - /** \brief Returns the number of vertices in the simplicial complex. */ - std::size_t num_vertices(); - -}; - -} // namespace rips_complex - -} // namespace Gudhi - -#endif // CONCEPT_RIPS_COMPLEX_SIMPLICIAL_COMPLEX_FOR_RIPS_H_ diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 60c9cd07..5e8f1dd7 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -62,7 +62,7 @@ Author: Clément Maria, Pawel Dlotko, Vincent Rouvreau
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
@@ -118,7 +118,7 @@ Author: Clément Jamin
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
@@ -155,7 +155,7 @@ Author: François Godi
- Introduced in: GUDHI 1.4.0
+ Introduced in: GUDHI 2.0.0
Copyright: GPL v3
Requires: \ref cgal ≥ 4.8.0 and \ref eigen3 -- cgit v1.2.3