summaryrefslogtreecommitdiff
path: root/src/Gudhi_stat/concept/Topological_data_with_distances.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 09:09:22 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 09:09:22 +0000
commit8deef56f7bdce0657fe8253ff1a7a18b97f11cba (patch)
tree7fed4f0d3e4923a32fd6b1f0fc8a0a4f01aedbbd /src/Gudhi_stat/concept/Topological_data_with_distances.h
parentcfe1bf1d74a78ccb7b6e275ba780ebba40f3adcc (diff)
parent29a0fe31bb44453bd83045859b512ca4de8d731a (diff)
Merge gudhi_stat branch
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/persistence_representation_integration@2470 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 2067fcd13bd6d8549fccf63f1d03fd31bc783cc8
Diffstat (limited to 'src/Gudhi_stat/concept/Topological_data_with_distances.h')
-rw-r--r--src/Gudhi_stat/concept/Topological_data_with_distances.h35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/Gudhi_stat/concept/Topological_data_with_distances.h b/src/Gudhi_stat/concept/Topological_data_with_distances.h
new file mode 100644
index 00000000..1318b9d1
--- /dev/null
+++ b/src/Gudhi_stat/concept/Topological_data_with_distances.h
@@ -0,0 +1,35 @@
+/* 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): Pawel Dlotko
+ *
+ * Copyright (C) 2015 INRIA (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 The concept Topological_data_with_distances describes the requirements
+ * for a type to implement a container that allows computations of distance to another contained of that type.
+ * The second parameter of the distance function allow to declare power of a distance. The exact meaning of that
+ * number will be different for different distances. A few examples are given below:
+ * In case of p-Wasserstein distance, the power is equal to p. power = std::limit<double>::max() for bottleneck distance.
+ * In case of L^p landscape distance, the power is equal to p. s
+ */
+class Topological_data_with_distances
+{
+public:
+ double distance( const Topological_data_with_distances& second , double power = 1);
+};
+