FieldOperators.h

Go to the documentation of this file.

/*    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):       Hannah Schreiber
 *
 *    Copyright (C) 2024 Inria
 *
 *    Modification(s):
 *      - YYYY/MM Author: Description of the modification
 */

 
namespace Gudhi {
namespace persistence_matrix {

class FieldOperators 
{
 public:
  using Element = unspecified;         
  using Characteristic = unspecified;  

  inline static const Characteristic nullCharacteristic;

  FieldOperators(Characteristic characteristic = 0);

  void set_characteristic(const Characteristic& characteristic);
  const Characteristic& get_characteristic() const;

  template <typename Integer_type>
  Element get_value(Integer_type e) const;
 
  // void get_value(Element& e) const;

  void add_inplace(Element& e1, const Element& e2) const;

  void multiply_inplace(Element& e1, const Element& e2) const;

  void multiply_and_add_inplace_front(Element& e, const Element& m, const Element& a) const;
  void multiply_and_add_inplace_back(const Element& e, const Element& m, Element& a) const;

  Element get_inverse(const Element& e) const;

  static const Element& get_additive_identity();
  static const Element& get_multiplicative_identity();

  FieldOperators& operator=(FieldOperators other);
  friend void swap(FieldOperators& f1, FieldOperators& f2);
};
 
}  // namespace persistence_matrix
}  // namespace Gudhi