summaryrefslogtreecommitdiff
path: root/src/Coxeter_triangulation/include/gudhi/Functions/Function.h
blob: eddfedf5f4ca6c3b0a29cb335ac9b08e18ccd693 (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
/*    This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
 *    See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
 *    Author(s):       Siargey Kachanovich
 *
 *    Copyright (C) 2019 Inria
 *
 *    Modification(s):
 *      - YYYY/MM Author: Description of the modification
 */

#ifndef FUNCTIONS_FUNCTION_H_
#define FUNCTIONS_FUNCTION_H_

#include <Eigen/Dense>

namespace Gudhi {

namespace coxeter_triangulation {

/**
 * \class Function
 * \brief The parent class for all functions implemented in the module.
 *  Contains virtual methods needed to be a model of the concept FunctionForImplicitManifold.
 *
 * \ingroup coxeter_triangulation
 */
struct Function {
  /** \brief Virtual method for the value of the function at a specified point.
   * @param[in] p The input point.
   */
  virtual Eigen::VectorXd operator()(const Eigen::VectorXd& p) const = 0;

  /** \brief Virtual method for the domain dimension. */
  virtual std::size_t amb_d() const = 0;

  /** \brief Virtual method for the codomain dimension. */
  virtual std::size_t cod_d() const = 0;

  /** \brief Virtual method for the seed point. */
  virtual Eigen::VectorXd seed() const = 0;

  /** \brief Virtual destructor. */
  virtual ~Function() {}
};

}  // namespace coxeter_triangulation

}  // namespace Gudhi

#endif