multipers 2.3.3b6__cp313-cp313-macosx_11_0_arm64.whl

multipers/gudhi/gudhi/Persistence_matrix/ru_vine_swap.h

@@ -0,0 +1,540 @@
+/*    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 ru_vine_swap.h
+ * @author Hannah Schreiber
+ * @brief Contains the @ref Gudhi::persistence_matrix::RU_vine_swap class, as well as the
+ * @ref Gudhi::persistence_matrix::Dummy_ru_vine_swap and
+ * @ref Gudhi::persistence_matrix::Dummy_ru_vine_pairing structures.
+ */
+
+#ifndef PM_RU_VINE_SWAP_H
+#define PM_RU_VINE_SWAP_H
+
+#include <utility>      //std::move
+#include <type_traits>  //std::conditional
+#include <cassert>
+#include <stdexcept>    //std::invalid_argument
+
+#include "ru_pairing.h"
+#include "boundary_cell_position_to_id_mapper.h"
+
+namespace Gudhi {
+namespace persistence_matrix {
+
+/**
+ * @ingroup persistence_matrix
+ *
+ * @brief Empty structure.
+ * Inherited instead of @ref RU_vine_swap, when vine swaps are not enabled.
+ */
+struct Dummy_ru_vine_swap
+{
+  friend void swap([[maybe_unused]] Dummy_ru_vine_swap& d1, [[maybe_unused]] Dummy_ru_vine_swap& d2) {}
+};
+
+/**
+ * @ingroup persistence_matrix
+ *
+ * @brief Empty structure.
+ * Inherited instead of @ref RU_pairing, when the barcode is not stored.
+ */
+struct Dummy_ru_vine_pairing
+{
+  friend void swap([[maybe_unused]] Dummy_ru_vine_pairing& d1, [[maybe_unused]] Dummy_ru_vine_pairing& d2) {}
+};
+
+/**
+ * @class RU_vine_swap ru_vine_swap.h gudhi/Persistence_matrix/ru_vine_swap.h
+ * @ingroup persistence_matrix
+ *
+ * @brief Class managing the vine swaps for @ref RU_matrix.
+ * 
+ * @tparam Master_matrix An instantiation of @ref Matrix from which all types and options are deduced.
+ */
+template <class Master_matrix>
+class RU_vine_swap : public std::conditional<Master_matrix::Option_list::has_column_pairings, 
+                                             RU_pairing<Master_matrix>,
+                                             Dummy_ru_vine_pairing
+                                            >::type,
+                     public std::conditional<Master_matrix::Option_list::has_column_pairings &&
+                                                Master_matrix::Option_list::has_removable_columns, 
+                                             Dummy_pos_mapper,
+                                             Cell_position_to_ID_mapper<typename Master_matrix::ID_index,
+                                                                        typename Master_matrix::Pos_index>
+                                            >::type
+{
+ public:
+  using Index = typename Master_matrix::Index;          /**< @ref MatIdx index type. */
+  using ID_index = typename Master_matrix::ID_index;    /**< @ref IDIdx index type. */
+  using Pos_index = typename Master_matrix::Pos_index;  /**< @ref PosIdx index type. */
+
+  /**
+   * @brief Default constructor.
+   */
+  RU_vine_swap();
+  /**
+   * @brief Copy constructor.
+   * 
+   * @param matrixToCopy Matrix to copy.
+   */
+  RU_vine_swap(const RU_vine_swap& matrixToCopy);
+  /**
+   * @brief Move constructor.
+   * 
+   * @param other Matrix to move.
+   */
+  RU_vine_swap(RU_vine_swap&& other) noexcept;
+
+  /**
+   * @brief Does the same than @ref vine_swap, but assumes that the swap is non trivial and
+   * therefore skips a part of the case study.
+   * 
+   * @param index @ref PosIdx index of the first cell to swap. The second one has to be at `position + 1`.
+   * @return true If the barcode changed from the swap.
+   * @return false Otherwise.
+   */
+  bool vine_swap_with_z_eq_1_case(Pos_index index);
+  /**
+   * @brief Does a vine swap between two cells which are consecutive in the filtration.
+   * Roughly, if \f$ F \f$ is the current filtration represented by the matrix, the method modifies the matrix
+   * such that the new state corresponds to a valid state for the filtration \f$ F' \f$ equal to \f$ F \f$ but
+   * with the two cells at position `position` and `position + 1` swapped. Of course, the two cells should
+   * not have a face/coface relation which each other ; \f$ F' \f$ has to be a valid filtration.
+   * See @cite vineyards for more information about vine and vineyards.
+   * 
+   * @param index @ref PosIdx index of the first cell to swap. The second one has to be at `position + 1`.
+   * @return true If the barcode changed from the swap.
+   * @return false Otherwise.
+   */
+  bool vine_swap(Pos_index index);
+
+  /**
+   * @brief Assign operator.
+   */
+  RU_vine_swap& operator=(RU_vine_swap other);
+  /**
+   * @brief Swap operator.
+   */
+  friend void swap(RU_vine_swap& swap1, RU_vine_swap& swap2) {
+    if constexpr (Master_matrix::Option_list::has_column_pairings) {
+      swap(static_cast<RU_pairing<Master_matrix>&>(swap1), static_cast<RU_pairing<Master_matrix>&>(swap2));
+    }
+    if (!Master_matrix::Option_list::has_column_pairings || !Master_matrix::Option_list::has_removable_columns) {
+      swap(static_cast<Cell_position_to_ID_mapper<ID_index, Pos_index>&>(swap1),
+           static_cast<Cell_position_to_ID_mapper<ID_index, Pos_index>&>(swap2));
+    }
+  }
+
+ protected:
+  //RUP = RU matrix Pairing
+  using RUP = typename std::conditional<Master_matrix::Option_list::has_column_pairings, 
+                                        RU_pairing<Master_matrix>,
+                                        Dummy_ru_vine_pairing
+                                       >::type;
+  //RUM = RU matrix position to id Map
+  using RUM = typename std::conditional<Master_matrix::Option_list::has_column_pairings &&
+                                            Master_matrix::Option_list::has_removable_columns,
+                                        Dummy_pos_mapper,
+                                        Cell_position_to_ID_mapper<ID_index, Pos_index>
+                                       >::type;
+  constexpr auto& _positionToRowIdx();
+
+ private:
+  using Master_RU_matrix = typename Master_matrix::Master_RU_matrix;
+
+  bool _is_paired(Index columnIndex);
+
+  void _swap_at_index(Index columnIndex);
+  void _add_to(Index sourceIndex, Index targetIndex);
+  void _positive_transpose(Index columnIndex);
+  void _negative_transpose(Index columnIndex);
+  void _positive_negative_transpose(Index columnIndex);
+  void _negative_positive_transpose(Index columnIndex);
+  bool _positive_vine_swap(Index columnIndex);
+  bool _negative_vine_swap(Index columnIndex);
+  bool _positive_negative_vine_swap(Index columnIndex);
+  bool _negative_positive_vine_swap(Index columnIndex);
+
+  Pos_index& _death(Pos_index simplexIndex);
+  Pos_index& _birth(Pos_index simplexIndex);
+  Pos_index _get_death(Index simplexIndex);
+  Pos_index _get_birth(Index simplexIndex);
+
+  ID_index _get_row_id_from_position(Pos_index position);
+
+  constexpr Master_RU_matrix* _matrix() { return static_cast<Master_RU_matrix*>(this); }
+  constexpr const Master_RU_matrix* _matrix() const { return static_cast<const Master_RU_matrix*>(this); }
+};
+
+template <class Master_matrix>
+inline RU_vine_swap<Master_matrix>::RU_vine_swap() : RUP(), RUM()
+{}
+
+template <class Master_matrix>
+inline RU_vine_swap<Master_matrix>::RU_vine_swap(const RU_vine_swap& matrixToCopy)
+    : RUP(static_cast<const RUP&>(matrixToCopy)),
+      RUM(static_cast<const RUM&>(matrixToCopy))
+{}
+
+template <class Master_matrix>
+inline RU_vine_swap<Master_matrix>::RU_vine_swap(RU_vine_swap<Master_matrix>&& other) noexcept
+    : RUP(std::move(static_cast<RUP&>(other))),
+      RUM(std::move(static_cast<RUM&>(other)))
+{}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::vine_swap_with_z_eq_1_case(Pos_index index) 
+{
+  GUDHI_CHECK(index < _matrix()->reducedMatrixR_.get_number_of_columns() - 1,
+              std::invalid_argument("RU_vine_swap::vine_swap_with_z_eq_1_case - Index to swap out of bound."));
+
+  bool iIsPositive = _matrix()->reducedMatrixR_.is_zero_column(index);
+  bool iiIsPositive = _matrix()->reducedMatrixR_.is_zero_column(index + 1);
+
+  if (iIsPositive && iiIsPositive) {
+    _matrix()->mirrorMatrixU_.zero_entry(index, _get_row_id_from_position(index + 1));
+    return _positive_vine_swap(index);
+  } else if (!iIsPositive && !iiIsPositive) {
+    return _negative_vine_swap(index);
+  } else if (iIsPositive && !iiIsPositive) {
+    return _positive_negative_vine_swap(index);
+  } else {
+    return _negative_positive_vine_swap(index);
+  }
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::vine_swap(Pos_index index) 
+{
+  GUDHI_CHECK(index < _matrix()->reducedMatrixR_.get_number_of_columns() - 1,
+              std::invalid_argument("RU_vine_swap::vine_swap - Index to swap out of bound."));
+
+  bool iIsPositive = _matrix()->reducedMatrixR_.is_zero_column(index);
+  bool iiIsPositive = _matrix()->reducedMatrixR_.is_zero_column(index + 1);
+
+  if (iIsPositive && iiIsPositive) {
+    if (_matrix()->reducedMatrixR_.get_column_dimension(index) !=
+        _matrix()->reducedMatrixR_.get_column_dimension(index + 1)) {
+      _positive_transpose(index);
+      _swap_at_index(index);
+      return true;
+    }
+    if (!_matrix()->mirrorMatrixU_.is_zero_entry(index, _get_row_id_from_position(index + 1))) {
+      _matrix()->mirrorMatrixU_.zero_entry(index, _get_row_id_from_position(index + 1));
+    }
+    return _positive_vine_swap(index);
+  } else if (!iIsPositive && !iiIsPositive) {
+    if (_matrix()->reducedMatrixR_.get_column_dimension(index) !=
+            _matrix()->reducedMatrixR_.get_column_dimension(index + 1) ||
+        _matrix()->mirrorMatrixU_.is_zero_entry(index, _get_row_id_from_position(index + 1))) {
+      _negative_transpose(index);
+      _swap_at_index(index);
+      return true;
+    }
+    return _negative_vine_swap(index);
+  } else if (iIsPositive && !iiIsPositive) {
+    if (_matrix()->reducedMatrixR_.get_column_dimension(index) !=
+            _matrix()->reducedMatrixR_.get_column_dimension(index + 1) ||
+        _matrix()->mirrorMatrixU_.is_zero_entry(index, _get_row_id_from_position(index + 1))) {
+      _positive_negative_transpose(index);
+      _swap_at_index(index);
+      return true;
+    }
+    return _positive_negative_vine_swap(index);
+  } else {
+    if (_matrix()->reducedMatrixR_.get_column_dimension(index) !=
+            _matrix()->reducedMatrixR_.get_column_dimension(index + 1) ||
+        _matrix()->mirrorMatrixU_.is_zero_entry(index, _get_row_id_from_position(index + 1))) {
+      _negative_positive_transpose(index);
+      _swap_at_index(index);
+      return true;
+    }
+    return _negative_positive_vine_swap(index);
+  }
+}
+
+template <class Master_matrix>
+inline RU_vine_swap<Master_matrix>& RU_vine_swap<Master_matrix>::operator=(RU_vine_swap<Master_matrix> other) 
+{
+  RUP::operator=(other);
+  RUM::operator=(other);
+  return *this;
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::_is_paired(Index columnIndex) 
+{
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    return _get_death(columnIndex) != static_cast<Pos_index>(-1);
+  } else {
+    if (!_matrix()->reducedMatrixR_.is_zero_column(columnIndex)) return true;
+
+    if constexpr (Master_matrix::Option_list::has_map_column_container) {
+      if (_matrix()->pivotToColumnIndex_.find(columnIndex) == _matrix()->pivotToColumnIndex_.end()) return false;
+    } else {
+      if (_matrix()->pivotToColumnIndex_.operator[](columnIndex) == static_cast<Index>(-1)) return false;
+    }
+
+    return true;
+  }
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_swap_at_index(Index columnIndex)
+{
+  _matrix()->reducedMatrixR_.swap_columns(columnIndex, columnIndex + 1);
+  _matrix()->reducedMatrixR_.swap_rows(_get_row_id_from_position(columnIndex),
+                                       _get_row_id_from_position(columnIndex + 1));
+  _matrix()->mirrorMatrixU_.swap_columns(columnIndex, columnIndex + 1);
+  _matrix()->mirrorMatrixU_.swap_rows(_get_row_id_from_position(columnIndex),
+                                      _get_row_id_from_position(columnIndex + 1));
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_add_to(Index sourceIndex, Index targetIndex) 
+{
+  _matrix()->reducedMatrixR_.add_to(sourceIndex, targetIndex);
+  _matrix()->mirrorMatrixU_.add_to(targetIndex, sourceIndex);
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_positive_transpose(Index columnIndex) 
+{
+  if constexpr (Master_matrix::Option_list::has_map_column_container) {
+    if (_is_paired(columnIndex) && _is_paired(columnIndex + 1)) {
+      std::swap(_matrix()->pivotToColumnIndex_.at(columnIndex), _matrix()->pivotToColumnIndex_.at(columnIndex + 1));
+    } else if (_is_paired(columnIndex)) {
+      _matrix()->pivotToColumnIndex_.emplace(columnIndex + 1, _matrix()->pivotToColumnIndex_.at(columnIndex));
+      _matrix()->pivotToColumnIndex_.erase(columnIndex);
+    } else if (_is_paired(columnIndex + 1)) {
+      _matrix()->pivotToColumnIndex_.emplace(columnIndex, _matrix()->pivotToColumnIndex_.at(columnIndex + 1));
+      _matrix()->pivotToColumnIndex_.erase(columnIndex + 1);
+    }
+  } else {
+    std::swap(_matrix()->pivotToColumnIndex_.operator[](columnIndex),
+              _matrix()->pivotToColumnIndex_.operator[](columnIndex + 1));
+  }
+
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    _birth(columnIndex) = columnIndex + 1;
+    _birth(columnIndex + 1) = columnIndex;
+    std::swap(RUP::indexToBar_.at(columnIndex), RUP::indexToBar_.at(columnIndex + 1));
+  }
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_negative_transpose(Index columnIndex) 
+{
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    _death(columnIndex) = columnIndex + 1;
+    _death(columnIndex + 1) = columnIndex;
+    std::swap(RUP::indexToBar_.at(columnIndex), RUP::indexToBar_.at(columnIndex + 1));
+  }
+  std::swap(_matrix()->pivotToColumnIndex_.at(_get_birth(columnIndex)),
+            _matrix()->pivotToColumnIndex_.at(_get_birth(columnIndex + 1)));
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_positive_negative_transpose(Index columnIndex) 
+{
+  _matrix()->pivotToColumnIndex_.at(_get_birth(columnIndex + 1)) = columnIndex;
+  if constexpr (Master_matrix::Option_list::has_map_column_container) {
+    if (_is_paired(columnIndex)) {
+      _matrix()->pivotToColumnIndex_.emplace(columnIndex + 1, _matrix()->pivotToColumnIndex_.at(columnIndex));
+      _matrix()->pivotToColumnIndex_.erase(columnIndex);
+    }
+  } else {
+    _matrix()->pivotToColumnIndex_.operator[](columnIndex + 1) = _matrix()->pivotToColumnIndex_.operator[](columnIndex);
+    _matrix()->pivotToColumnIndex_.operator[](columnIndex) = -1;
+  }
+
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    _birth(columnIndex) = columnIndex + 1;
+    _death(columnIndex + 1) = columnIndex;
+    std::swap(RUP::indexToBar_.at(columnIndex), RUP::indexToBar_.at(columnIndex + 1));
+  }
+}
+
+template <class Master_matrix>
+inline void RU_vine_swap<Master_matrix>::_negative_positive_transpose(Index columnIndex) 
+{
+  _matrix()->pivotToColumnIndex_.at(_get_birth(columnIndex)) = columnIndex + 1;
+  if constexpr (Master_matrix::Option_list::has_map_column_container) {
+    if (_is_paired(columnIndex + 1)) {
+      _matrix()->pivotToColumnIndex_.emplace(columnIndex, _matrix()->pivotToColumnIndex_.at(columnIndex + 1));
+      _matrix()->pivotToColumnIndex_.erase(columnIndex + 1);
+    }
+  } else {
+    _matrix()->pivotToColumnIndex_.operator[](columnIndex) = _matrix()->pivotToColumnIndex_.operator[](columnIndex + 1);
+    _matrix()->pivotToColumnIndex_.operator[](columnIndex + 1) = -1;
+  }
+
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    _death(columnIndex) = columnIndex + 1;
+    _birth(columnIndex + 1) = columnIndex;
+    std::swap(RUP::indexToBar_.at(columnIndex), RUP::indexToBar_.at(columnIndex + 1));
+  }
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::_positive_vine_swap(Index columnIndex) 
+{
+  const Pos_index iDeath = _get_death(columnIndex);
+  const Pos_index iiDeath = _get_death(columnIndex + 1);
+
+  if (iDeath != static_cast<Pos_index>(-1) && iiDeath != static_cast<Pos_index>(-1) &&
+      !(_matrix()->reducedMatrixR_.is_zero_entry(iiDeath, _get_row_id_from_position(columnIndex)))) {
+    if (iDeath < iiDeath) {
+      _swap_at_index(columnIndex);
+      _add_to(iDeath, iiDeath);
+      _positive_transpose(columnIndex);
+      return true;
+    }
+
+    _swap_at_index(columnIndex);
+    _add_to(iiDeath, iDeath);
+    return false;
+  }
+
+  _swap_at_index(columnIndex);
+
+  if (iDeath != static_cast<Pos_index>(-1) || iiDeath == static_cast<Pos_index>(-1) ||
+      _matrix()->reducedMatrixR_.is_zero_entry(iiDeath, _get_row_id_from_position(columnIndex + 1))) {
+    _positive_transpose(columnIndex);
+    return true;
+  }
+  return false;
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::_negative_vine_swap(Index columnIndex) 
+{
+  const Pos_index iBirth = _get_birth(columnIndex);
+  const Pos_index iiBirth = _get_birth(columnIndex + 1);
+
+  _add_to(columnIndex, columnIndex + 1);
+  _swap_at_index(columnIndex);
+
+  if (iBirth < iiBirth) {
+    _negative_transpose(columnIndex);
+    return true;
+  }
+
+  _add_to(columnIndex, columnIndex + 1);
+
+  return false;
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::_positive_negative_vine_swap(Index columnIndex) 
+{
+  _matrix()->mirrorMatrixU_.zero_entry(columnIndex, _get_row_id_from_position(columnIndex + 1));
+
+  _swap_at_index(columnIndex);
+  _positive_negative_transpose(columnIndex);
+
+  return true;
+}
+
+template <class Master_matrix>
+inline bool RU_vine_swap<Master_matrix>::_negative_positive_vine_swap(Index columnIndex) 
+{
+  _add_to(columnIndex, columnIndex + 1);  // useless for R?
+  _swap_at_index(columnIndex);      // if additions not made for R, do not swap R columns, just rows
+  _add_to(columnIndex, columnIndex + 1);  // useless for R?
+
+  return false;
+}
+
+template <class Master_matrix>
+inline typename RU_vine_swap<Master_matrix>::Pos_index& RU_vine_swap<Master_matrix>::_death(Pos_index simplexIndex) 
+{
+  static_assert(Master_matrix::Option_list::has_column_pairings, "Pairing necessary to modify death value.");
+
+  if constexpr (Master_matrix::Option_list::has_removable_columns) {
+    return RUP::indexToBar_.at(simplexIndex)->death;
+  } else {
+    return RUP::barcode_.at(RUP::indexToBar_.at(simplexIndex)).death;
+  }
+}
+
+template <class Master_matrix>
+inline typename RU_vine_swap<Master_matrix>::Pos_index& RU_vine_swap<Master_matrix>::_birth(Pos_index simplexIndex) 
+{
+  static_assert(Master_matrix::Option_list::has_column_pairings, "Pairing necessary to modify birth value.");
+
+  if constexpr (Master_matrix::Option_list::has_removable_columns) {
+    return RUP::indexToBar_.at(simplexIndex)->birth;
+  } else {
+    return RUP::barcode_.at(RUP::indexToBar_.at(simplexIndex)).birth;
+  }
+}
+
+template <class Master_matrix>
+inline typename RU_vine_swap<Master_matrix>::Pos_index RU_vine_swap<Master_matrix>::_get_death(Index simplexIndex) 
+{
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    if constexpr (Master_matrix::Option_list::has_removable_columns) {
+      return RUP::indexToBar_.at(simplexIndex)->death;
+    } else {
+      return RUP::barcode_.at(RUP::indexToBar_.at(simplexIndex)).death;
+    }
+  } else {
+    if (!_matrix()->reducedMatrixR_.is_zero_column(simplexIndex))
+      return _matrix()->reducedMatrixR_.get_column(simplexIndex).get_pivot();
+
+    if constexpr (Master_matrix::Option_list::has_map_column_container) {
+      auto it = _matrix()->pivotToColumnIndex_.find(simplexIndex);
+      if (it == _matrix()->pivotToColumnIndex_.end()) return -1;
+      return it->second;
+    } else {
+      return _matrix()->pivotToColumnIndex_.operator[](simplexIndex);
+    }
+  }
+}
+
+template <class Master_matrix>
+inline typename RU_vine_swap<Master_matrix>::Pos_index RU_vine_swap<Master_matrix>::_get_birth(
+    Index negativeSimplexIndex) 
+{
+  if constexpr (Master_matrix::Option_list::has_column_pairings) {
+    if constexpr (Master_matrix::Option_list::has_removable_columns) {
+      return RUP::indexToBar_.at(negativeSimplexIndex)->birth;
+    } else {
+      return RUP::barcode_.at(RUP::indexToBar_.at(negativeSimplexIndex)).birth;
+    }
+  } else {
+    return _matrix()->reducedMatrixR_.get_pivot(negativeSimplexIndex);
+  }
+}
+
+template <class Master_matrix>
+inline typename RU_vine_swap<Master_matrix>::ID_index RU_vine_swap<Master_matrix>::_get_row_id_from_position(
+    Pos_index position)
+{
+  auto it = _positionToRowIdx().find(position);
+  return it == _positionToRowIdx().end() ? position : it->second;
+}
+
+template <class Master_matrix>
+inline constexpr auto& RU_vine_swap<Master_matrix>::_positionToRowIdx()
+{
+  if constexpr (Master_matrix::Option_list::has_column_pairings && Master_matrix::Option_list::has_removable_columns)
+    return RUP::PIDM::map_;
+  else
+    return RUM::map_;
+}
+
+}  // namespace persistence_matrix
+}  // namespace Gudhi
+
+#endif  // PM_RU_VINE_SWAP_H

multipers/gudhi/gudhi/Persistent_cohomology/Field_Zp.h

@@ -0,0 +1,118 @@
+/*    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):       Clément Maria
+ *
+ *    Copyright (C) 2014 Inria
+ *
+ *    Modification(s):
+ *      - YYYY/MM Author: Description of the modification
+ */
+
+#ifndef PERSISTENT_COHOMOLOGY_FIELD_ZP_H_
+#define PERSISTENT_COHOMOLOGY_FIELD_ZP_H_
+
+#include <utility>
+#include <vector>
+#include <stdexcept>
+
+namespace Gudhi {
+
+namespace persistent_cohomology {
+
+/** \brief Structure representing the coefficient field \f$\mathbb{Z}/p\mathbb{Z}\f$
+ *
+ * \implements CoefficientField
+ * \ingroup persistent_cohomology
+ */
+class Field_Zp {
+ public:
+  typedef int Element;
+
+  Field_Zp()
+      : Prime(0),
+        inverse_() {
+  }
+
+  void init(int charac) {
+    Prime = charac;
+
+    // Check that the provided prime is less than the maximum allowed as int, calculation below, and 'plus_times_equal' function : 46337 ; i.e (max_prime-1)*max_prime <= INT_MAX
+    if(Prime > 46337)
+        throw std::invalid_argument("Maximum homology_coeff_field allowed value is 46337");
+
+    // Check for primality
+    if (Prime <= 1)
+        throw std::invalid_argument("homology_coeff_field must be a prime number");
+
+    inverse_.clear();
+    inverse_.reserve(charac);
+    inverse_.push_back(0);
+    for (int i = 1; i < Prime; ++i) {
+      int inv = 1;
+      int mult = inv * i;
+      while ( (mult % Prime) != 1) {
+        ++inv;
+        if(mult == Prime)
+            throw std::invalid_argument("homology_coeff_field must be a prime number");
+        mult = inv * i;
+      }
+      inverse_.push_back(inv);
+    }
+  }
+
+  /** Set x <- x + w * y*/
+  Element plus_times_equal(const Element& x, const Element& y, const Element& w) {
+    assert(Prime > 0);  // division by zero + non negative values
+    Element result = (x + w * y) % Prime;
+    if (result < 0)
+      result += Prime;
+    return result;
+  }
+
+// operator= defined on Element
+
+  /** Returns y * w */
+  Element times(const Element& y, const Element& w) {
+    return plus_times_equal(0, y, (Element)w);
+  }
+
+  Element plus_equal(const Element& x, const Element& y) {
+    return plus_times_equal(x, y, (Element)1);
+  }
+
+  /** \brief Returns the additive idendity \f$0_{\Bbbk}\f$ of the field.*/
+  Element additive_identity() const {
+    return 0;
+  }
+  /** \brief Returns the multiplicative identity \f$1_{\Bbbk}\f$ of the field.*/
+  Element multiplicative_identity(Element = 0) const {
+    return 1;
+  }
+  /** Returns the inverse in the field. Modifies P. ??? */
+  std::pair<Element, Element> inverse(Element x, Element P) {
+    return std::pair<Element, Element>(inverse_[x], P);
+  }  // <------ return the product of field characteristic for which x is invertible
+
+  /** Returns -x * y.*/
+  Element times_minus(Element x, Element y) {
+    assert(Prime > 0);  // division by zero + non negative values
+    Element out = (-x * y) % Prime;
+    return (out < 0) ? out + Prime : out;
+  }
+
+  /** \brief Returns the characteristic \f$p\f$ of the field.*/
+  int characteristic() const {
+    return Prime;
+  }
+
+ private:
+  int Prime;
+  /** Property map Element -> Element, which associate to an element its inverse in the field.*/
+  std::vector<Element> inverse_;
+};
+
+}  // namespace persistent_cohomology
+
+}  // namespace Gudhi
+
+#endif  // PERSISTENT_COHOMOLOGY_FIELD_ZP_H_