summaryrefslogtreecommitdiff
path: root/src/Gudhi_stat/concept/Topological_data_with_distances.h
diff options
context:
space:
mode:
authorpdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-24 20:22:47 +0000
committerpdlotko <pdlotko@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-03-24 20:22:47 +0000
commitee086a78f61f1ac6dd14ecab6e34d6710c971f64 (patch)
tree91d7bec2f0d8bca9b84f31d523a82240d79cd12a /src/Gudhi_stat/concept/Topological_data_with_distances.h
parent5b6290423812b24cc3f67a4a8e9c9027b9d95cd6 (diff)
Answer to Marc's comments.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/gudhi_stat@2240 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 20c02d536373553322a3e10eb4aacc2959db654a
Diffstat (limited to 'src/Gudhi_stat/concept/Topological_data_with_distances.h')
-rw-r--r--src/Gudhi_stat/concept/Topological_data_with_distances.h4
1 files changed, 4 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
index 536ae821..1318b9d1 100644
--- a/src/Gudhi_stat/concept/Topological_data_with_distances.h
+++ b/src/Gudhi_stat/concept/Topological_data_with_distances.h
@@ -22,6 +22,10 @@
/** \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
{