summaryrefslogtreecommitdiff
path: root/concept/Persistent_cohomology/CoefficientField.h
blob: 953b06c2d22a79728c05566c81ce821031af2d10 (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
 /*    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):       Clément Maria
  *
  *    Copyright (C) 2014  INRIA Sophia Antipolis-Méditerranée (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 Concept describing the requirements for a class to represent 
  * a field of coefficients to compute persistent homology.
  */
struct CoefficientField {

/** \brief Type of element of the field.
  *
  * Must be Assignable. */
  typedef unspecified Element;

/** Default constructible. */
  CoefficientField();
  
  void init(Element charac);
  void init(Element charac_min, Element charac_max);

/** Return the characteristic of the field. */
  Element characteristic();
/** Return the element 1 of the field. */
  Element multiplicative_identity();
/** Return the element 0 of the field. */
  Element additive_identity();

/** Assign: x <- x + y */
  void plus_equal(Element x, Element y);

/** */
//... inverse()

  };