summaryrefslogtreecommitdiff
path: root/src/Persistence_representations/concept/Topological_data_with_distances.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 15:20:29 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 15:20:29 +0000
commit0654bfbab17fe16edf90445f0a351454b460028f (patch)
treee8cc47decaf74d44cc1d82ac01f105676ad5248a /src/Persistence_representations/concept/Topological_data_with_distances.h
parent5de02a8e89ce7905281a0ef6d40f82ef04d426d6 (diff)
Fix spell checker errors
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/persistence_representation_integration@2475 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 94422e6f356532b2db4dc5a55cbb851210b3c36d
Diffstat (limited to 'src/Persistence_representations/concept/Topological_data_with_distances.h')
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_distances.h22
1 files changed, 19 insertions, 3 deletions
diff --git a/src/Persistence_representations/concept/Topological_data_with_distances.h b/src/Persistence_representations/concept/Topological_data_with_distances.h
index 1318b9d1..2e6de729 100644
--- a/src/Persistence_representations/concept/Topological_data_with_distances.h
+++ b/src/Persistence_representations/concept/Topological_data_with_distances.h
@@ -4,7 +4,7 @@
*
* Author(s): Pawel Dlotko
*
- * Copyright (C) 2015 INRIA (France)
+ * Copyright (C) 2017 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
@@ -20,11 +20,22 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifndef CONCEPT_TOPOLOGICAL_DATA_WITH_DISTANCES_H_
+#define CONCEPT_TOPOLOGICAL_DATA_WITH_DISTANCES_H_
+
+namespace Gudhi {
+
+namespace Persistence_representations {
+
+
/** \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.
+ * for a type to implement a container that allows computations of distance to another contained of that type.
+ * \details
* 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 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
@@ -33,3 +44,8 @@ public:
double distance( const Topological_data_with_distances& second , double power = 1);
};
+} // namespace Persistence_representations
+
+} // namespace Gudhi
+
+#endif // CONCEPT_TOPOLOGICAL_DATA_WITH_DISTANCES_H_