summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/concept/FiltrationValue.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/Simplex_tree/concept/FiltrationValue.h')
-rw-r--r--src/Simplex_tree/concept/FiltrationValue.h23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/Simplex_tree/concept/FiltrationValue.h b/src/Simplex_tree/concept/FiltrationValue.h
new file mode 100644
index 00000000..6cf314fa
--- /dev/null
+++ b/src/Simplex_tree/concept/FiltrationValue.h
@@ -0,0 +1,23 @@
+/* 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 Maria
+ *
+ * Copyright (C) 2014 Inria
+ *
+ * Modification(s):
+ * - YYYY/MM Author: Description of the modification
+ */
+
+/** \brief Value type for a filtration function on a cell complex.
+ *
+ * A <EM>filtration</EM> of a cell complex (see FilteredComplex) is
+ * a function \f$f:\mathbf{K} \rightarrow \mathbb{R}\f$ satisfying \f$f(\tau)\leq
+ * f(\sigma)\f$ whenever \f$\tau \subseteq \sigma\f$. Ordering the simplices
+ * by increasing filtration values (breaking ties so as a simplex appears after
+ * its subsimplices of same filtration value) provides an indexing scheme
+ * (see IndexingTag).
+ */
+ struct FiltrationValue {
+ /** \brief Operator < is a StrictWeakOrdering. */
+ bool operator<(FiltrationValue f1, FiltrationValue f2);
+ };