summaryrefslogtreecommitdiff
path: root/include/gudhi/Persistence_intervals_with_distances.h
blob: 7990888332ca828de78e5cd2f9e3d95150a2cd40 (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
52
53
54
55
56
57
58
59
60
61
62
63
/*    This file is part of the Gudhi hiLibrary. The Gudhi library
 *    (Geometric Understanding in Higher Dimensions) is a generic C++
 *    library for computational topology.
 *
 *    Author(s):       Pawel Dlotko
 *
 *    Copyright (C) 2016  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/>.
 */

#ifndef PERSISTENCE_INTERVALS_WITH_DISTANCES_H_
#define PERSISTENCE_INTERVALS_WITH_DISTANCES_H_

#include <gudhi/Persistence_intervals.h>
#include <gudhi/Bottleneck.h>

#include <limits>

namespace Gudhi {
namespace Persistence_representations {

class Persistence_intervals_with_distances : public Persistence_intervals {
 public:
  using Persistence_intervals::Persistence_intervals;

  /**
   *Computations of distance from the current persistnce diagram to the persistence diagram given as a parameter of this
   *function.
   *The last but one parameter, power, is here in case we would like to compute p=th Wasserstein distance. At the
   *moment, this method only implement Bottleneck distance,
   * which is infinity Wasserstein distance. Therefore any power which is not the default std::numeric_limits< double
   *>::max() will be ignored and an
   * exception will be thrown.
   * The last parameter, tolerance, it is an additiv error of the approimation, set by default to zero.
  **/
  double distance(const Persistence_intervals_with_distances& second, double power = std::numeric_limits<double>::max(),
                  double tolerance = (std::numeric_limits<double>::min)()) const {
    if (power >= std::numeric_limits<double>::max()) {
      return Gudhi::persistence_diagram::bottleneck_distance(this->intervals, second.intervals, tolerance);
    } else {
      std::cerr << "At the moment Gudhi do not support Wasserstein distances. We only support Bottleneck distance."
                << std::endl;
      throw "At the moment Gudhi do not support Wasserstein distances. We only support Bottleneck distance.";
    }
  }
};

}  // namespace Persistence_representations
}  // namespace Gudhi

#endif  // PERSISTENCE_INTERVALS_WITH_DISTANCES_H_