boundary_matrix.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-24 Inria
 *
 *    Modification(s):
 *      - YYYY/MM Author: Description of the modification
 */
 
#ifndef PM_BOUNDARY_MATRIX_H
#define PM_BOUNDARY_MATRIX_H
 
#include <cassert>
#include <iostream> //print() only
#include <vector>
#include <utility>  //std::swap, std::move & std::exchange
 
namespace Gudhi {
namespace persistence_matrix {
 
// TODO: factorize/inheritate/compose with @ref basematrix "base matrix"?
template <class Master_matrix>
class Boundary_matrix : public Master_matrix::Matrix_dimension_option,
                        public Master_matrix::template Base_swap_option<Boundary_matrix<Master_matrix> >,
                        public Master_matrix::Base_pairing_option,
                        public Master_matrix::Matrix_row_access_option 
{
 public:
  using index = typename Master_matrix::index;                        
  using id_index = typename Master_matrix::id_index;                  
  using dimension_type = typename Master_matrix::dimension_type;      
  using Field_operators = typename Master_matrix::Field_operators;
  using Field_element_type = typename Master_matrix::element_type;    
  using Column_type = typename Master_matrix::Column_type;            
  using boundary_type = typename Master_matrix::boundary_type;        
  using Row_type = typename Master_matrix::Row_type;                  
  using Cell_constructor = typename Master_matrix::Cell_constructor;  
  using Column_settings = typename Master_matrix::Column_settings;    
  Boundary_matrix(Column_settings* colSettings);
  template <class Boundary_type = boundary_type>
  Boundary_matrix(const std::vector<Boundary_type>& orderedBoundaries, 
                  Column_settings* colSettings);
  Boundary_matrix(unsigned int numberOfColumns, Column_settings* colSettings);
  Boundary_matrix(const Boundary_matrix& matrixToCopy, 
                  Column_settings* colSettings = nullptr);
  Boundary_matrix(Boundary_matrix&& other) noexcept;
 
  template <class Boundary_type = boundary_type>
  index insert_boundary(const Boundary_type& boundary, dimension_type dim = -1);
  template <class Boundary_type = boundary_type>
  index insert_boundary(id_index faceIndex, const Boundary_type& boundary, dimension_type dim = -1);
  Column_type& get_column(index columnIndex);
  Row_type& get_row(index rowIndex);
  index remove_last();
  void erase_empty_row(index rowIndex);
 
  index get_number_of_columns() const;
 
  dimension_type get_column_dimension(index columnIndex) const;
 
  void add_to(index sourceColumnIndex, index targetColumnIndex);
  void multiply_target_and_add_to(index sourceColumnIndex, 
                                  const Field_element_type& coefficient,
                                  index targetColumnIndex);
  void multiply_source_and_add_to(const Field_element_type& coefficient, 
                                  index sourceColumnIndex,
                                  index targetColumnIndex);
 
  void zero_cell(index columnIndex, index rowIndex);
  void zero_column(index columnIndex);
  bool is_zero_cell(index columnIndex, index rowIndex) const;
  bool is_zero_column(index columnIndex);
 
  index get_pivot(index columnIndex);
 
  void reset(Column_settings* colSettings) {
    matrix_.clear();
    nextInsertIndex_ = 0;
    colSettings_ = colSettings;
  }
 
  Boundary_matrix& operator=(const Boundary_matrix& other);
  friend void swap(Boundary_matrix& matrix1, Boundary_matrix& matrix2) {
    swap(static_cast<typename Master_matrix::Matrix_dimension_option&>(matrix1),
         static_cast<typename Master_matrix::Matrix_dimension_option&>(matrix2));
    swap(static_cast<typename Master_matrix::template Base_swap_option<Boundary_matrix<Master_matrix> >&>(matrix1),
         static_cast<typename Master_matrix::template Base_swap_option<Boundary_matrix<Master_matrix> >&>(matrix2));
    swap(static_cast<typename Master_matrix::Base_pairing_option&>(matrix1),
         static_cast<typename Master_matrix::Base_pairing_option&>(matrix2));
    matrix1.matrix_.swap(matrix2.matrix_);
    std::swap(matrix1.nextInsertIndex_, matrix2.nextInsertIndex_);
    std::swap(matrix1.colSettings_, matrix2.colSettings_);
 
    if constexpr (Master_matrix::Option_list::has_row_access) {
      swap(static_cast<typename Master_matrix::Matrix_row_access_option&>(matrix1),
           static_cast<typename Master_matrix::Matrix_row_access_option&>(matrix2));
    }
  }
 
  void print();  // for debug
 
 private:
  using dim_opt = typename Master_matrix::Matrix_dimension_option;
  using swap_opt = typename Master_matrix::template Base_swap_option<Boundary_matrix<Master_matrix> >;
  using pair_opt = typename Master_matrix::Base_pairing_option;
  using ra_opt = typename Master_matrix::Matrix_row_access_option;
  using matrix_type = typename Master_matrix::column_container_type;
 
  friend swap_opt;
  friend pair_opt;
 
  matrix_type matrix_;          
  index nextInsertIndex_;       
  Column_settings* colSettings_;  
  static constexpr bool activeDimOption =
      Master_matrix::Option_list::has_matrix_maximal_dimension_access || Master_matrix::maxDimensionIsNeeded;
  static constexpr bool activeSwapOption =
      Master_matrix::Option_list::has_column_and_row_swaps || Master_matrix::Option_list::has_vine_update;
  static constexpr bool activePairingOption = Master_matrix::Option_list::has_column_pairings &&
                                              !Master_matrix::Option_list::has_vine_update &&
                                              !Master_matrix::Option_list::can_retrieve_representative_cycles;
 
  void _orderRowsIfNecessary();
  const Column_type& _get_column(index columnIndex) const;
  Column_type& _get_column(index columnIndex);
  index _get_real_row_index(index rowIndex) const;
  template <class Container_type>
  void _container_insert(const Container_type& column, index pos, dimension_type dim);
  void _container_insert(const Column_type& column, [[maybe_unused]] index pos = 0);
};
 
template <class Master_matrix>
inline Boundary_matrix<Master_matrix>::Boundary_matrix(Column_settings* colSettings)
    : dim_opt(-1),
      swap_opt(),
      pair_opt(),
      ra_opt(),
      nextInsertIndex_(0),
      colSettings_(colSettings)
{}
 
template <class Master_matrix>
template <class Boundary_type>
inline Boundary_matrix<Master_matrix>::Boundary_matrix(const std::vector<Boundary_type>& orderedBoundaries,
                                                       Column_settings* colSettings)
    : dim_opt(-1),
      swap_opt(orderedBoundaries.size()),
      pair_opt(),
      ra_opt(orderedBoundaries.size()),
      nextInsertIndex_(orderedBoundaries.size()),
      colSettings_(colSettings)
{
  matrix_.reserve(orderedBoundaries.size());
 
  for (index i = 0; i < orderedBoundaries.size(); i++) {
    _container_insert(orderedBoundaries[i], i, orderedBoundaries[i].size() == 0 ? 0 : orderedBoundaries[i].size() - 1);
  }
}
 
template <class Master_matrix>
inline Boundary_matrix<Master_matrix>::Boundary_matrix(unsigned int numberOfColumns, 
                                                       Column_settings* colSettings)
    : dim_opt(-1),
      swap_opt(numberOfColumns),
      pair_opt(),
      ra_opt(numberOfColumns),
      matrix_(!Master_matrix::Option_list::has_map_column_container && Master_matrix::Option_list::has_row_access
                  ? 0
                  : numberOfColumns),
      nextInsertIndex_(0),
      colSettings_(colSettings)
{
  if constexpr (!Master_matrix::Option_list::has_map_column_container && Master_matrix::Option_list::has_row_access)
    matrix_.reserve(numberOfColumns);
}
 
template <class Master_matrix>
inline Boundary_matrix<Master_matrix>::Boundary_matrix(const Boundary_matrix& matrixToCopy, 
                                                       Column_settings* colSettings)
    : dim_opt(static_cast<const dim_opt&>(matrixToCopy)),
      swap_opt(static_cast<const swap_opt&>(matrixToCopy)),
      pair_opt(static_cast<const pair_opt&>(matrixToCopy)),
      ra_opt(static_cast<const ra_opt&>(matrixToCopy)),
      nextInsertIndex_(matrixToCopy.nextInsertIndex_),
      colSettings_(colSettings == nullptr ? matrixToCopy.colSettings_ : colSettings) 
{
  matrix_.reserve(matrixToCopy.matrix_.size());
  for (const auto& cont : matrixToCopy.matrix_){
    if constexpr (Master_matrix::Option_list::has_map_column_container){
      _container_insert(cont.second, cont.first);
    } else {
      _container_insert(cont);
    }
  }
}
 
template <class Master_matrix>
inline Boundary_matrix<Master_matrix>::Boundary_matrix(Boundary_matrix&& other) noexcept
    : dim_opt(std::move(static_cast<dim_opt&>(other))),
      swap_opt(std::move(static_cast<swap_opt&>(other))),
      pair_opt(std::move(static_cast<pair_opt&>(other))),
      ra_opt(std::move(static_cast<ra_opt&>(other))),
      matrix_(std::move(other.matrix_)),
      nextInsertIndex_(std::exchange(other.nextInsertIndex_, 0)),
      colSettings_(std::exchange(other.colSettings_, nullptr)) 
{}
 
template <class Master_matrix>
template <class Boundary_type>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::insert_boundary(
    const Boundary_type& boundary, dimension_type dim) 
{
  return insert_boundary(nextInsertIndex_, boundary, dim);
}
 
template <class Master_matrix>
template <class Boundary_type>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::insert_boundary(
    id_index faceIndex, const Boundary_type& boundary, dimension_type dim) 
{
  if (dim == -1) dim = boundary.size() == 0 ? 0 : boundary.size() - 1;
 
  _orderRowsIfNecessary();
 
  //updates container sizes
  if constexpr (Master_matrix::Option_list::has_row_access && !Master_matrix::Option_list::has_removable_rows) {
    id_index pivot;
    if constexpr (Master_matrix::Option_list::is_z2) {
      pivot = *std::prev(boundary.end());
    } else {
      pivot = std::prev(boundary.end())->first;
    }
    //row container
    if (ra_opt::rows_->size() <= pivot) ra_opt::rows_->resize(pivot + 1);
  }
 
  //row swap map containers
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    if constexpr (activeSwapOption) {
      swap_opt::indexToRow_.emplace(faceIndex, faceIndex);
      swap_opt::rowToIndex_.emplace(faceIndex, faceIndex);
    }
  } else {
    if constexpr (activeSwapOption) {
      for (index i = swap_opt::indexToRow_.size(); i <= faceIndex; ++i) {
        swap_opt::indexToRow_.push_back(i);
        swap_opt::rowToIndex_.push_back(i);
      }
    }
  }
 
  _container_insert(boundary, nextInsertIndex_, dim);
 
  return nextInsertIndex_++;
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::Column_type& Boundary_matrix<Master_matrix>::get_column(
    index columnIndex) 
{
  _orderRowsIfNecessary();
 
  return _get_column(columnIndex);
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::Row_type& Boundary_matrix<Master_matrix>::get_row(index rowIndex) 
{
  static_assert(Master_matrix::Option_list::has_row_access, "'get_row' is not implemented for the chosen options.");
 
  _orderRowsIfNecessary();
 
  return ra_opt::get_row(rowIndex);
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::remove_last() 
{
  static_assert(Master_matrix::Option_list::has_removable_columns,
                "'remove_last' is not implemented for the chosen options.");
 
  if (nextInsertIndex_ == 0) return -1;  // empty matrix
  --nextInsertIndex_;
 
  //updates dimension max
  if constexpr (activeDimOption) {
    dim_opt::update_down(matrix_.at(nextInsertIndex_).get_dimension());
  }
 
  //computes pivot and removes column from matrix_
  id_index pivot;
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    auto it = matrix_.find(nextInsertIndex_);
    pivot = it->second.get_pivot();
    if constexpr (activeSwapOption) {
      // if the removed column is positive, the pivot won't change value
      if (swap_opt::rowSwapped_ && pivot != static_cast<id_index>(-1)) {
        swap_opt::_orderRows();
        pivot = it->second.get_pivot();
      }
    }
    matrix_.erase(it);
  } else {
    pivot = matrix_[nextInsertIndex_].get_pivot();
    if constexpr (activeSwapOption) {
      // if the removed column is positive, the pivot won't change value
      if (swap_opt::rowSwapped_ && pivot != static_cast<id_index>(-1)) {
        swap_opt::_orderRows();
        pivot = matrix_[nextInsertIndex_].get_pivot();
      }
    }
    if constexpr (Master_matrix::Option_list::has_row_access) {
      GUDHI_CHECK(nextInsertIndex_ == matrix_.size() - 1,
                  std::logic_error("Boundary_matrix::remove_last - Indexation problem."));
      matrix_.pop_back();
    } else {
      matrix_[nextInsertIndex_].clear();
    }
  }
 
  erase_empty_row(nextInsertIndex_);  // maximal, so empty
 
  //updates barcode
  if constexpr (activePairingOption) {
    pair_opt::_remove_last(nextInsertIndex_);
  }
 
  return pivot;
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::erase_empty_row(index rowIndex) 
{
  //computes real row index and erases it if necessary from the row swap map containers
  id_index rowID = rowIndex;
  if constexpr (activeSwapOption) {
    if constexpr (Master_matrix::Option_list::has_map_column_container) {
      auto it = swap_opt::indexToRow_.find(rowIndex);
      rowID = it->second;
      swap_opt::rowToIndex_.erase(rowID);
      swap_opt::indexToRow_.erase(it);
    } else {
      rowID = swap_opt::indexToRow_[rowIndex];
    }
  }
 
  if constexpr (Master_matrix::Option_list::has_row_access && Master_matrix::Option_list::has_removable_rows) {
    ra_opt::erase_empty_row(rowID);
  }
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::get_number_of_columns() const 
{
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    return matrix_.size();
  } else {
    return nextInsertIndex_;  // matrix could have been resized much bigger while insert
  }
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::dimension_type Boundary_matrix<Master_matrix>::get_column_dimension(
    index columnIndex) const 
{
  return _get_column(columnIndex).get_dimension();
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::add_to(index sourceColumnIndex, index targetColumnIndex) 
{
  _get_column(targetColumnIndex) += _get_column(sourceColumnIndex);
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::multiply_target_and_add_to(index sourceColumnIndex,
                                                                       const Field_element_type& coefficient,
                                                                       index targetColumnIndex) 
{
  _get_column(targetColumnIndex).multiply_target_and_add(coefficient, _get_column(sourceColumnIndex));
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::multiply_source_and_add_to(const Field_element_type& coefficient,
                                                                       index sourceColumnIndex,
                                                                       index targetColumnIndex) 
{
  _get_column(targetColumnIndex).multiply_source_and_add(_get_column(sourceColumnIndex), coefficient);
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::zero_cell(index columnIndex, index rowIndex) 
{
  _get_column(columnIndex).clear(_get_real_row_index(rowIndex));
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::zero_column(index columnIndex) 
{
  _get_column(columnIndex).clear();
}
 
template <class Master_matrix>
inline bool Boundary_matrix<Master_matrix>::is_zero_cell(index columnIndex, index rowIndex) const 
{
  return !(_get_column(columnIndex).is_non_zero(_get_real_row_index(rowIndex)));
}
 
template <class Master_matrix>
inline bool Boundary_matrix<Master_matrix>::is_zero_column(index columnIndex) 
{
  return _get_column(columnIndex).is_empty();
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::get_pivot(index columnIndex) 
{
  _orderRowsIfNecessary();
 
  return _get_column(columnIndex).get_pivot();
}
 
template <class Master_matrix>
inline Boundary_matrix<Master_matrix>& Boundary_matrix<Master_matrix>::operator=(const Boundary_matrix& other) 
{
  dim_opt::operator=(other);
  swap_opt::operator=(other);
  pair_opt::operator=(other);
  ra_opt::operator=(other);
 
  matrix_.clear();
  nextInsertIndex_ = other.nextInsertIndex_;
  colSettings_ = other.colSettings_;
 
  matrix_.reserve(other.matrix_.size());
  for (const auto& cont : other.matrix_){
    if constexpr (Master_matrix::Option_list::has_map_column_container){
      _container_insert(cont.second, cont.first);
    } else {
      _container_insert(cont);
    }
  }
 
  return *this;
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::print() 
{
  if constexpr (activeSwapOption) {
    if (swap_opt::rowSwapped_) swap_opt::_orderRows();
  }
  std::cout << "Boundary_matrix:\n";
  for (index i = 0; i < nextInsertIndex_; ++i) {
    Column_type& col = matrix_[i];
    for (auto e : col.get_content(nextInsertIndex_)) {
      if (e == 0u)
        std::cout << "- ";
      else
        std::cout << e << " ";
    }
    std::cout << "\n";
  }
  std::cout << "\n";
  if constexpr (Master_matrix::Option_list::has_row_access) {
    std::cout << "Row Matrix:\n";
    for (id_index i = 0; i < nextInsertIndex_; ++i) {
      const auto& row = ra_opt::rows_[i];
      for (const auto& cell : row) {
        std::cout << cell.get_column_index() << " ";
      }
      std::cout << "(" << i << ")\n";
    }
    std::cout << "\n";
  }
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::_orderRowsIfNecessary() 
{
  if constexpr (activeSwapOption) {
    if (swap_opt::rowSwapped_) swap_opt::_orderRows();
  }
}
 
template <class Master_matrix>
inline const typename Boundary_matrix<Master_matrix>::Column_type& Boundary_matrix<Master_matrix>::_get_column(
    index columnIndex) const
{
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    return matrix_.at(columnIndex);
  } else {
    return matrix_[columnIndex];
  }
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::Column_type& Boundary_matrix<Master_matrix>::_get_column(
    index columnIndex)
{
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    return matrix_.at(columnIndex);
  } else {
    return matrix_[columnIndex];
  }
}
 
template <class Master_matrix>
inline typename Boundary_matrix<Master_matrix>::index Boundary_matrix<Master_matrix>::_get_real_row_index(
    index rowIndex) const
{
  if constexpr (Master_matrix::Option_list::has_column_and_row_swaps || Master_matrix::Option_list::has_vine_update) {
    if constexpr (Master_matrix::Option_list::has_map_column_container) {
      return swap_opt::indexToRow_.at(rowIndex);
    } else {
      return swap_opt::indexToRow_[rowIndex];
    }
  } else {
    return rowIndex;
  }
}
 
template <class Master_matrix>
template <class Container_type>
inline void Boundary_matrix<Master_matrix>::_container_insert(const Container_type& column,
                                                              index pos,
                                                              dimension_type dim)
{
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    if constexpr (Master_matrix::Option_list::has_row_access) {
      matrix_.try_emplace(pos, Column_type(pos, column, dim, ra_opt::rows_, colSettings_));
    } else {
      matrix_.try_emplace(pos, Column_type(column, dim, colSettings_));
    }
  } else {
    if constexpr (Master_matrix::Option_list::has_row_access) {
      matrix_.emplace_back(pos, column, dim, ra_opt::rows_, colSettings_);
    } else {
      if (matrix_.size() <= pos) {
        matrix_.emplace_back(column, dim, colSettings_);
      } else {
        matrix_[pos] = Column_type(column, dim, colSettings_);
      }
    }
  }
  if constexpr (activeDimOption) {
    dim_opt::update_up(dim);
  }
}
 
template <class Master_matrix>
inline void Boundary_matrix<Master_matrix>::_container_insert(const Column_type& column, [[maybe_unused]] index pos)
{
  if constexpr (Master_matrix::Option_list::has_map_column_container) {
    if constexpr (Master_matrix::Option_list::has_row_access) {
      matrix_.try_emplace(pos, Column_type(column, column.get_column_index(), ra_opt::rows_, colSettings_));
    } else {
      matrix_.try_emplace(pos, Column_type(column, colSettings_));
    }
  } else {
    if constexpr (Master_matrix::Option_list::has_row_access) {
      matrix_.emplace_back(column, column.get_column_index(), ra_opt::rows_, colSettings_);
    } else {
      matrix_.emplace_back(column, colSettings_);
    }
  }
}
 
}  // namespace persistence_matrix
}  // namespace Gudhi
 
#endif  // PM_BOUNDARY_MATRIX_H