summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/concept/SimplexTreeOptions.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-10-02 13:13:38 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2015-10-02 13:13:38 +0000
commitc14909eae41883308428095758360de3a7202a0d (patch)
tree6c3c40dbe6c006ec65a54a6373b5e6129012a4fb /src/Simplex_tree/concept/SimplexTreeOptions.h
parent91b4846b860988f94346cdf1302c1cfd965c3d27 (diff)
Backmerge of trunk
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alphashapes@820 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 812e0b84d187dd5e30a6a18c12612ebc9bf9206a
Diffstat (limited to 'src/Simplex_tree/concept/SimplexTreeOptions.h')
-rw-r--r--src/Simplex_tree/concept/SimplexTreeOptions.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/Simplex_tree/concept/SimplexTreeOptions.h b/src/Simplex_tree/concept/SimplexTreeOptions.h
new file mode 100644
index 00000000..a50a2bf1
--- /dev/null
+++ b/src/Simplex_tree/concept/SimplexTreeOptions.h
@@ -0,0 +1,41 @@
+ /* 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): Marc Glisse
+ *
+ * Copyright (C) 2015 INRIA Saclay - Ile-de-France (France)
+ *
+ * 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/>.
+ */
+
+/** \brief Concept of the template parameter for the class `Gudhi::Simplex_tree<SimplexTreeOptions>`.
+ *
+ * One model for this is `Gudhi::Simplex_tree_options_full_featured`. If you want to provide your own, it is recommended that you derive from it and override some parts instead of writing a class from scratch.
+ */
+struct SimplexTreeOptions {
+ /// Forced for now.
+ typedef IndexingTag Indexing_tag;
+ /// Must be a signed integer type. It admits a total order <.
+ typedef VertexHandle Vertex_handle;
+ /// Must be comparable with operator<.
+ typedef FiltrationValue Filtration_value;
+ /// Must be a signed integer type.
+ typedef SimplexKey Simplex_key;
+ /// If true, each simplex has extra storage for one `Simplex_key`. Necessary for `Persistent_cohomology`.
+ static constexpr bool store_key;
+ /// If true, each simplex has extra storage for one `Filtration_value`, and this value is propagated by operations like `Gudhi::Simplex_tree<SimplexTreeOptions>::expansion`. Without it, `Persistent_cohomology` degenerates to computing usual (non-persistent) cohomology.
+ static constexpr bool store_filtration;
+};
+