summaryrefslogtreecommitdiff
path: root/src/Persistence_representations/concept
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
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')
-rw-r--r--src/Persistence_representations/concept/Real_valued_topological_data.h21
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_averages.h11
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_distances.h22
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_scalar_product.h15
-rw-r--r--src/Persistence_representations/concept/Vectorized_topological_data.h15
5 files changed, 74 insertions, 10 deletions
diff --git a/src/Persistence_representations/concept/Real_valued_topological_data.h b/src/Persistence_representations/concept/Real_valued_topological_data.h
index 4d4ee8d3..5a15c769 100644
--- a/src/Persistence_representations/concept/Real_valued_topological_data.h
+++ b/src/Persistence_representations/concept/Real_valued_topological_data.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,6 +20,14 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifndef CONCEPT_REAL_VALUED_TOPOLOGICAL_DATA_H_
+#define CONCEPT_REAL_VALUED_TOPOLOGICAL_DATA_H_
+
+namespace Gudhi {
+
+namespace Persistence_representations {
+
+
/** \brief The concept Real_valued_topological_data describes the requirements
* for a type to implement a container that allows computations of its projections to R.
*/
@@ -27,12 +35,19 @@ class Real_valued_topological_data
{
public:
/**
- * Typically there are various ways data can be projected to R. This function give us the number of functions for vectorization provided by a given class.
+ * Typically there are various ways data can be projected to R. This function gives us the number of functions for
+ * vectorization provided by a given class.
**/
size_t number_of_projections_to_R();
/**
- * This is a function to compute the projection from this container to reals. The parameter of a function have to be between 0 and the value returned by number_of_projections_to_R().
+ * This is a function to compute the projection from this container to reals. The parameter of a function have to
+ * be between 0 and the value returned by number_of_projections_to_R().
**/
double project_to_R( size_t number_of_projection );
};
+} // namespace Persistence_representations
+
+} // namespace Gudhi
+
+#endif // CONCEPT_REAL_VALUED_TOPOLOGICAL_DATA_H_
diff --git a/src/Persistence_representations/concept/Topological_data_with_averages.h b/src/Persistence_representations/concept/Topological_data_with_averages.h
index aeeb94f0..0501c306 100644
--- a/src/Persistence_representations/concept/Topological_data_with_averages.h
+++ b/src/Persistence_representations/concept/Topological_data_with_averages.h
@@ -5,7 +5,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
@@ -21,7 +21,12 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifndef CONCEPT_TOPOLOGICAL_DATA_WITH_AVERAGES_H_
+#define CONCEPT_TOPOLOGICAL_DATA_WITH_AVERAGES_H_
+namespace Gudhi {
+
+namespace Persistence_representations {
/** \brief The concept Topological_data_with_averages describes the requirements
* for a type to implement a container that allows computations of averages.
@@ -33,4 +38,8 @@ public:
void compute_average( const std::vector< Topological_data_with_averages* >& to_average );
};
+} // namespace Persistence_representations
+
+} // namespace Gudhi
+#endif // CONCEPT_TOPOLOGICAL_DATA_WITH_AVERAGES_H_
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_
diff --git a/src/Persistence_representations/concept/Topological_data_with_scalar_product.h b/src/Persistence_representations/concept/Topological_data_with_scalar_product.h
index f32271c7..203a1d91 100644
--- a/src/Persistence_representations/concept/Topological_data_with_scalar_product.h
+++ b/src/Persistence_representations/concept/Topological_data_with_scalar_product.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,6 +20,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifndef CONCEPT_TOPOLOGICAL_DATA_WITH_SCALAR_PRODUCT_H_
+#define CONCEPT_TOPOLOGICAL_DATA_WITH_SCALAR_PRODUCT_H_
+
+namespace Gudhi {
+
+namespace Persistence_representations {
+
/** \brief The concept Topological_data_with_scalar_product describes the requirements
* for a type to implement a container that allows computations of scalar products.
@@ -29,3 +36,9 @@ class Topological_data_with_scalar_product
public:
double compute_scalar_product( const Topological_data_with_scalar_product& second );
};
+
+} // namespace Persistence_representations
+
+} // namespace Gudhi
+
+#endif // CONCEPT_TOPOLOGICAL_DATA_WITH_SCALAR_PRODUCT_H_
diff --git a/src/Persistence_representations/concept/Vectorized_topological_data.h b/src/Persistence_representations/concept/Vectorized_topological_data.h
index 2dd966fd..8d4105a2 100644
--- a/src/Persistence_representations/concept/Vectorized_topological_data.h
+++ b/src/Persistence_representations/concept/Vectorized_topological_data.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,6 +20,12 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifndef CONCEPT_VECTORIZED_TOPOLOGICAL_DATA_H_
+#define CONCEPT_VECTORIZED_TOPOLOGICAL_DATA_H_
+
+namespace Gudhi {
+
+namespace Persistence_representations {
/** \brief The concept Vectorized_topological_data describes the requirements
* for a type to implement a container that allows vectorization.
@@ -28,7 +34,7 @@ class Vectorized_topological_data
{
public:
/**
- * There are various ways data can be verctorized. This function give us the number of functions for vectorization provided by a given class.
+ * There are various ways data can be vectorized. This function give us the number of functions for vectorization provided by a given class.
**/
size_t number_of_vectorize_functions();
/**
@@ -37,3 +43,8 @@ public:
std::vector<double> vectorize( int number_of_function );
};
+} // namespace Persistence_representations
+
+} // namespace Gudhi
+
+#endif // CONCEPT_VECTORIZED_TOPOLOGICAL_DATA_H_