multipers 2.4.0b1__cp312-cp312-macosx_11_0_arm64.whl

multipers/gudhi/gudhi/Fields/Z2_field.h

@@ -0,0 +1,391 @@
+/*    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-24 Inria
+ *
+ *    Modification(s):
+ *      - YYYY/MM Author: Description of the modification
+ */
+
+/**
+ * @file Z2_field.h
+ * @author Hannah Schreiber
+ * @brief Contains the @ref Gudhi::persistence_fields::Z2_field_element class.
+ */
+
+#ifndef MATRIX_FIELD_Z2_H_
+#define MATRIX_FIELD_Z2_H_
+
+#include <utility>
+
+namespace Gudhi {
+namespace persistence_fields {
+
+/**
+ * @class Z2_field_element Z2_field.h gudhi/Fields/Z2_field.h
+ * @ingroup persistence_fields
+ *
+ * @brief Class representing an element of the \f$ \mathbb{F}_2 \f$ field.
+ */
+class Z2_field_element
+{
+ public:
+  using Element = bool; /**< Type for the elements in the field. */
+  template <class T>
+  using isInteger = std::enable_if_t<std::is_integral_v<T> >;
+
+  /**
+   * @brief Default constructor.
+   */
+  Z2_field_element() : element_(false) {}
+
+  /**
+   * @brief Constructor setting the element to the given value.
+   *
+   * @tparam Integer_type A native integer type. Should be able to contain the characteristic.
+   * @param element Value of the element.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  Z2_field_element(Integer_type element) : element_(_get_value(element))
+  {}
+
+  /**
+   * @brief Copy constructor.
+   *
+   * @param toCopy Element to copy.
+   */
+  Z2_field_element(const Z2_field_element& toCopy) = default;
+
+  /**
+   * @brief Move constructor.
+   *
+   * @param toMove Element to move.
+   */
+  Z2_field_element(Z2_field_element&& toMove) noexcept : element_(std::exchange(toMove.element_, false)) {}
+
+  ~Z2_field_element() = default;
+
+  /**
+   * @brief operator+=
+   */
+  friend void operator+=(Z2_field_element& f1, Z2_field_element const& f2)
+  {
+    f1.element_ = (f1.element_ != f2.element_);
+  }
+
+  /**
+   * @brief operator+
+   */
+  friend Z2_field_element operator+(Z2_field_element f1, Z2_field_element const& f2)
+  {
+    f1 += f2;
+    return f1;
+  }
+
+  /**
+   * @brief operator+=
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend void operator+=(Z2_field_element& f, const Integer_type& v)
+  {
+    f.element_ = (f.element_ != _get_value(v));
+  }
+
+  /**
+   * @brief operator+
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Z2_field_element operator+(Z2_field_element f, const Integer_type& v)
+  {
+    f += v;
+    return f;
+  }
+
+  /**
+   * @brief operator+
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Integer_type operator+(const Integer_type& v, const Z2_field_element& f)
+  {
+    return f.element_ != _get_value(v);
+  }
+
+  /**
+   * @brief operator-=
+   */
+  friend void operator-=(Z2_field_element& f1, Z2_field_element const& f2)
+  {
+    f1.element_ = (f1.element_ != f2.element_);
+  }
+
+  /**
+   * @brief operator-
+   */
+  friend Z2_field_element operator-(Z2_field_element f1, Z2_field_element const& f2)
+  {
+    f1 -= f2;
+    return f1;
+  }
+
+  /**
+   * @brief operator-=
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend void operator-=(Z2_field_element& f, const Integer_type& v)
+  {
+    f.element_ = (f.element_ != _get_value(v));
+  }
+
+  /**
+   * @brief operator-
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Z2_field_element operator-(Z2_field_element f, const Integer_type& v)
+  {
+    f -= v;
+    return f;
+  }
+
+  /**
+   * @brief operator-
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Integer_type operator-(const Integer_type v, Z2_field_element const& f)
+  {
+    return f.element_ != _get_value(v);
+  }
+
+  /**
+   * @brief operator*=
+   */
+  friend void operator*=(Z2_field_element& f1, Z2_field_element const& f2)
+  {
+    f1.element_ = (f1.element_ && f2.element_);
+  }
+
+  /**
+   * @brief operator*
+   */
+  friend Z2_field_element operator*(Z2_field_element f1, Z2_field_element const& f2)
+  {
+    f1 *= f2;
+    return f1;
+  }
+
+  /**
+   * @brief operator*=
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend void operator*=(Z2_field_element& f, const Integer_type& v)
+  {
+    f.element_ = (f.element_ && _get_value(v));
+  }
+
+  /**
+   * @brief operator*
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Z2_field_element operator*(Z2_field_element f, const Integer_type& v)
+  {
+    f *= v;
+    return f;
+  }
+
+  /**
+   * @brief operator*
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend Integer_type operator*(const Integer_type& v, Z2_field_element const& f)
+  {
+    return f.element_ && _get_value(v);
+  }
+
+  /**
+   * @brief operator==
+   */
+  friend bool operator==(const Z2_field_element& f1, const Z2_field_element& f2) { return f1.element_ == f2.element_; }
+
+  /**
+   * @brief operator==
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend bool operator==(const Integer_type& v, const Z2_field_element& f)
+  {
+    return _get_value(v) == f.element_;
+  }
+
+  /**
+   * @brief operator==
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend bool operator==(const Z2_field_element& f, const Integer_type& v)
+  {
+    return _get_value(v) == f.element_;
+  }
+
+  /**
+   * @brief operator!=
+   */
+  friend bool operator!=(const Z2_field_element& f1, const Z2_field_element& f2) { return !(f1 == f2); }
+
+  /**
+   * @brief operator!=
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend bool operator!=(const Integer_type v, const Z2_field_element& f)
+  {
+    return !(v == f);
+  }
+
+  /**
+   * @brief operator!=
+   *
+   * @tparam Integer_type A native integer type: int, unsigned int, long int, bool, etc.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  friend bool operator!=(const Z2_field_element& f, const Integer_type v)
+  {
+    return !(v == f);
+  }
+
+  /**
+   * @brief Assign operator.
+   */
+  Z2_field_element& operator=(Z2_field_element other)
+  {
+    std::swap(element_, other.element_);
+    return *this;
+  }
+
+  /**
+   * @brief Move assign operator.
+   */
+  Z2_field_element& operator=(Z2_field_element&& other) noexcept
+  {
+    if (this == &other) return *this;
+
+    element_ = std::exchange(other.element_, false);
+    return *this;
+  }
+
+  /**
+   * @brief Assign operator.
+   */
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  Z2_field_element& operator=(const Integer_type value)
+  {
+    element_ = _get_value(value);
+    return *this;
+  }
+
+  /**
+   * @brief Swap operator.
+   */
+  friend void swap(Z2_field_element& f1, Z2_field_element& f2) noexcept { std::swap(f1.element_, f2.element_); }
+
+  /**
+   * @brief Casts the element into an unsigned int.
+   */
+  operator unsigned int() const { return static_cast<unsigned int>(element_); }
+
+  /**
+   * @brief Returns the inverse of the element.
+   *
+   * @return The inverse.
+   */
+  [[nodiscard]] Z2_field_element get_inverse() const { return element_ ? Z2_field_element(1) : Z2_field_element(); }
+
+  /**
+   * @brief For interface purposes with multi-fields. Returns the inverse together with the second argument.
+   *
+   * @param productOfCharacteristics Some value.
+   * @return Pair whose first element is the inverse of @p e and the second element is @p productOfCharacteristics.
+   */
+  [[nodiscard]] std::pair<Z2_field_element, unsigned int> get_partial_inverse(
+      unsigned int productOfCharacteristics) const
+  {
+    return {get_inverse(), productOfCharacteristics};
+  }
+
+  /**
+   * @brief Returns the additive identity of the field.
+   *
+   * @return false.
+   */
+  static Z2_field_element get_additive_identity() { return {}; }
+
+  /**
+   * @brief Returns the multiplicative identity of the field.
+   *
+   * @return true.
+   */
+  static Z2_field_element get_multiplicative_identity() { return {1}; }
+
+  /**
+   * @brief For interface purposes with multi-fields. Returns the multiplicative identity of the field.
+   *
+   * @param productOfCharacteristics Some value.
+   * @return true.
+   */
+  static Z2_field_element get_partial_multiplicative_identity([[maybe_unused]] unsigned int productOfCharacteristics)
+  {
+    return {1};
+  }
+
+  /**
+   * @brief Returns the characteristic of the field, that is `2`.
+   *
+   * @return 2.
+   */
+  static constexpr unsigned int get_characteristic() { return 2; }
+
+  /**
+   * @brief Returns the value of the element.
+   *
+   * @return Value of the element.
+   */
+  [[nodiscard]] Element get_value() const { return element_; }
+
+ private:
+  Element element_;
+
+  template <typename Integer_type, class = isInteger<Integer_type> >
+  static constexpr Element _get_value(Integer_type e)
+  {
+    if constexpr (std::is_same_v<Integer_type, bool>) {
+      return e;
+    } else {
+      return e < 2 && e >= 0 ? e : e % 2;  // returns bool, so %2 won't be negative and is optimized to &
+    }
+  }
+};
+
+}  // namespace persistence_fields
+}  // namespace Gudhi
+
+#endif  // MATRIX_FIELD_Z2_H_