Zp_field_shared.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) 2022 Inria
 *
 *    Modification(s):
 *      - YYYY/MM Author: Description of the modification
 */

 
#ifndef MATRIX_FIELD_ZP_VAR_H_
#define MATRIX_FIELD_ZP_VAR_H_
 
#include <utility>
#include <vector>
#include <climits>
#include <stdexcept>
 
namespace Gudhi {
namespace persistence_fields {

template <typename Unsigned_integer_type = unsigned int,
          class = std::enable_if_t<std::is_unsigned_v<Unsigned_integer_type> > >
class Shared_Zp_field_element
{
 public:
  using Element = Unsigned_integer_type; 
  using Characteristic = Element;        
  template <class T>
  using isInteger = std::enable_if_t<std::is_integral_v<T> >;

  Shared_Zp_field_element() : element_(0) {}

  template <typename Integer_type, class = isInteger<Integer_type> >
  Shared_Zp_field_element(Integer_type element) : element_(_get_value(element))
  {}

  Shared_Zp_field_element(const Shared_Zp_field_element& toCopy) = default;

  Shared_Zp_field_element(Shared_Zp_field_element&& toMove) noexcept : element_(std::exchange(toMove.element_, 0)) {}
 
  ~Shared_Zp_field_element() = default;

  static void initialize(Characteristic characteristic)
  {
    if (characteristic <= 1)
      throw std::invalid_argument("Characteristic must be strictly positive and a prime number.");
 
    inverse_.resize(characteristic);
    inverse_[0] = 0;
    for (Element i = 1; i < characteristic; ++i) {
      Element inv = 1;
      Element mult = inv * i;
      while ((mult % characteristic) != 1) {
        ++inv;
        if (mult == characteristic) throw std::invalid_argument("Characteristic must be a prime number.");
        mult = inv * i;
      }
      inverse_[i] = inv;
    }
 
    characteristic_ = characteristic;
  }

  Element get_value() const { return element_; }

  friend void operator+=(Shared_Zp_field_element& f1, const Shared_Zp_field_element& f2)
  {
    f1.element_ = Shared_Zp_field_element::_add(f1.element_, f2.element_);
  }

  friend Shared_Zp_field_element operator+(Shared_Zp_field_element f1, const Shared_Zp_field_element& f2)
  {
    f1 += f2;
    return f1;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend void operator+=(Shared_Zp_field_element& f, const Integer_type& v)
  {
    f.element_ = Shared_Zp_field_element::_add(f.element_, _get_value(v));
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Shared_Zp_field_element operator+(Shared_Zp_field_element f, const Integer_type& v)
  {
    f += v;
    return f;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Integer_type operator+(const Integer_type& v, Shared_Zp_field_element f)
  {
    f += v;
    return f.element_;
  }

  friend void operator-=(Shared_Zp_field_element& f1, const Shared_Zp_field_element& f2)
  {
    f1.element_ = Shared_Zp_field_element::_subtract(f1.element_, f2.element_);
  }

  friend Shared_Zp_field_element operator-(Shared_Zp_field_element f1, const Shared_Zp_field_element& f2)
  {
    f1 -= f2;
    return f1;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend void operator-=(Shared_Zp_field_element& f, const Integer_type& v)
  {
    f.element_ = Shared_Zp_field_element::_subtract(f.element_, _get_value(v));
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Shared_Zp_field_element operator-(Shared_Zp_field_element f, const Integer_type& v)
  {
    f -= v;
    return f;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Integer_type operator-(const Integer_type& v, const Shared_Zp_field_element& f)
  {
    return Shared_Zp_field_element::_subtract(_get_value(v), f.element_);
  }

  friend void operator*=(Shared_Zp_field_element& f1, const Shared_Zp_field_element& f2)
  {
    f1.element_ = Shared_Zp_field_element::_multiply(f1.element_, f2.element_);
  }

  friend Shared_Zp_field_element operator*(Shared_Zp_field_element f1, const Shared_Zp_field_element& f2)
  {
    f1 *= f2;
    return f1;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend void operator*=(Shared_Zp_field_element& f, const Integer_type& v)
  {
    f.element_ = Shared_Zp_field_element::_multiply(f.element_, _get_value(v));
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Shared_Zp_field_element operator*(Shared_Zp_field_element f, const Integer_type& v)
  {
    f *= v;
    return f;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend Integer_type operator*(const Integer_type& v, Shared_Zp_field_element f)
  {
    f *= v;
    return f.element_;
  }

  friend bool operator==(const Shared_Zp_field_element& f1, const Shared_Zp_field_element& f2)
  {
    return f1.element_ == f2.element_;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend bool operator==(const Integer_type& v, const Shared_Zp_field_element& f)
  {
    return Shared_Zp_field_element::_get_value(v) == f.element_;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend bool operator==(const Shared_Zp_field_element& f, const Integer_type& v)
  {
    return Shared_Zp_field_element::_get_value(v) == f.element_;
  }

  friend bool operator!=(const Shared_Zp_field_element& f1, const Shared_Zp_field_element& f2) { return !(f1 == f2); }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend bool operator!=(const Integer_type& v, const Shared_Zp_field_element& f)
  {
    return !(v == f);
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  friend bool operator!=(const Shared_Zp_field_element& f, const Integer_type& v)
  {
    return !(v == f);
  }

  Shared_Zp_field_element& operator=(Shared_Zp_field_element other)
  {
    std::swap(element_, other.element_);
    return *this;
  }

  Shared_Zp_field_element& operator=(Shared_Zp_field_element&& other) noexcept
  {
    if (this == &other) return *this;
 
    element_ = std::exchange(other.element_, 0);
    return *this;
  }

  template <typename Integer_type, class = isInteger<Integer_type> >
  Shared_Zp_field_element& operator=(const Integer_type& value)
  {
    element_ = Shared_Zp_field_element::_get_value(value);
    return *this;
  }

  friend void swap(Shared_Zp_field_element& f1, Shared_Zp_field_element& f2) noexcept
  {
    std::swap(f1.element_, f2.element_);
  }

  operator unsigned int() const { return element_; }

  Shared_Zp_field_element get_inverse() const { return Shared_Zp_field_element(inverse_[element_]); }

  std::pair<Shared_Zp_field_element, Characteristic> get_partial_inverse(Characteristic productOfCharacteristics) const
  {
    return {get_inverse(), productOfCharacteristics};
  }

  static Shared_Zp_field_element get_additive_identity() { return Shared_Zp_field_element(); }

  static Shared_Zp_field_element get_multiplicative_identity() { return Shared_Zp_field_element(1); }

  static Shared_Zp_field_element get_partial_multiplicative_identity(
      [[maybe_unused]] Characteristic productOfCharacteristics)
  {
    return Shared_Zp_field_element(1);
  }

  static Characteristic get_characteristic() { return characteristic_; }
 
  // static constexpr bool handles_only_z2() { return false; }
 
 private:
  Element element_;                             
  static inline Characteristic characteristic_; 
  static inline std::vector<Element> inverse_;  
 
  static Element _add(Element element, Element v)
  {
    if (UINT_MAX - element < v) {
      // automatic unsigned integer overflow behaviour will make it work
      element += v;
      element -= characteristic_;
      return element;
    }
 
    element += v;
    if (element >= characteristic_) element -= characteristic_;
 
    return element;
  }
 
  static Element _subtract(Element element, Element v)
  {
    if (element < v) {
      element += characteristic_;
    }
    element -= v;
 
    return element;
  }
 
  static Element _multiply(Element element, Element v)
  {
    Element a = element;
    element = 0;
    Element temp_b;
 
    while (a != 0) {
      if (a & 1) {
        if (v >= characteristic_ - element) element -= characteristic_;
        element += v;
      }
      a >>= 1;
 
      temp_b = v;
      if (v >= characteristic_ - v) temp_b -= characteristic_;
      v += temp_b;
    }
 
    return element;
  }
 
  template <typename Integer_type, class = isInteger<Integer_type> >
  static constexpr Element _get_value(Integer_type e)
  {
    if constexpr (std::is_signed_v<Integer_type>) {
      if (e < -static_cast<Integer_type>(characteristic_)) e = e % characteristic_;
      if (e < 0) return e += characteristic_;
      return e < static_cast<Integer_type>(characteristic_) ? e : e % characteristic_;
    } else {
      return e < characteristic_ ? e : e % characteristic_;
    }
  }
};
 
}  // namespace persistence_fields
}  // namespace Gudhi
 
#endif  // MATRIX_FIELD_ZP_VAR_H_