summaryrefslogtreecommitdiff
path: root/concept/Persistence_representations/Real_valued_topological_data.h
blob: 22ef6d724d636abbdbedc9f8bd853f62cf2c804d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*    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) 2016 Inria
 *
 *    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/>.
 */

#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.
  */
class Real_valued_topological_data {
 public:
  /**
* 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().
**/
  double project_to_R(size_t number_of_projection);
};

}  // namespace Persistence_representations

}  // namespace Gudhi

#endif  // CONCEPT_REAL_VALUED_TOPOLOGICAL_DATA_H_