summaryrefslogtreecommitdiff
path: root/src/Persistence_representations/concept
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 11:14:43 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2017-05-30 11:14:43 +0000
commit5de02a8e89ce7905281a0ef6d40f82ef04d426d6 (patch)
tree71fe2871fc6b73fb67c3fae0156ff4d470e0c8eb /src/Persistence_representations/concept
parentf9b84f79232ec2fa5935327e38e2862d9c33ab2c (diff)
Typo
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/persistence_representation_integration@2472 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 457b970258b8a99519db664358c19d0dee80d879
Diffstat (limited to 'src/Persistence_representations/concept')
-rw-r--r--src/Persistence_representations/concept/Real_valued_topological_data.h38
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_averages.h36
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_distances.h35
-rw-r--r--src/Persistence_representations/concept/Topological_data_with_scalar_product.h31
-rw-r--r--src/Persistence_representations/concept/Vectorized_topological_data.h39
5 files changed, 179 insertions, 0 deletions
diff --git a/src/Persistence_representations/concept/Real_valued_topological_data.h b/src/Persistence_representations/concept/Real_valued_topological_data.h
new file mode 100644
index 00000000..4d4ee8d3
--- /dev/null
+++ b/src/Persistence_representations/concept/Real_valued_topological_data.h
@@ -0,0 +1,38 @@
+/* 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 Real_valued_topological_data describes the requirements
+ * for a type to implement a container that allows computations of its projections to R.
+ */
+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.
+ **/
+ 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().
+ **/
+ double project_to_R( size_t number_of_projection );
+};
+
diff --git a/src/Persistence_representations/concept/Topological_data_with_averages.h b/src/Persistence_representations/concept/Topological_data_with_averages.h
new file mode 100644
index 00000000..aeeb94f0
--- /dev/null
+++ b/src/Persistence_representations/concept/Topological_data_with_averages.h
@@ -0,0 +1,36 @@
+
+/* 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_averages describes the requirements
+ * for a type to implement a container that allows computations of averages.
+ * Note that the average object after being computed is stored in *this.
+ */
+class Topological_data_with_averages
+{
+public:
+ void compute_average( const std::vector< Topological_data_with_averages* >& to_average );
+};
+
+
diff --git a/src/Persistence_representations/concept/Topological_data_with_distances.h b/src/Persistence_representations/concept/Topological_data_with_distances.h
new file mode 100644
index 00000000..1318b9d1
--- /dev/null
+++ b/src/Persistence_representations/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);
+};
+
diff --git a/src/Persistence_representations/concept/Topological_data_with_scalar_product.h b/src/Persistence_representations/concept/Topological_data_with_scalar_product.h
new file mode 100644
index 00000000..f32271c7
--- /dev/null
+++ b/src/Persistence_representations/concept/Topological_data_with_scalar_product.h
@@ -0,0 +1,31 @@
+/* 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_scalar_product describes the requirements
+ * for a type to implement a container that allows computations of scalar products.
+ */
+class Topological_data_with_scalar_product
+{
+public:
+ double compute_scalar_product( const Topological_data_with_scalar_product& second );
+};
diff --git a/src/Persistence_representations/concept/Vectorized_topological_data.h b/src/Persistence_representations/concept/Vectorized_topological_data.h
new file mode 100644
index 00000000..2dd966fd
--- /dev/null
+++ b/src/Persistence_representations/concept/Vectorized_topological_data.h
@@ -0,0 +1,39 @@
+/* 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 Vectorized_topological_data describes the requirements
+ * for a type to implement a container that allows vectorization.
+ */
+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.
+ **/
+ size_t number_of_vectorize_functions();
+ /**
+ * This is a function to vectorize given container. The parameter of a function have to be between 0 and the value returned by number_of_vectorize_functions().
+ **/
+ std::vector<double> vectorize( int number_of_function );
+};
+