multipers 2.3.3b6__cp310-cp310-manylinux_2_39_x86_64.whl

multipers/multiparameter_module_approximation/vineyards.h

@@ -0,0 +1,464 @@
+/*    This file is part of the MMA Library - https://gitlab.inria.fr/dloiseau/multipers - which is released under MIT.
+ *    See file LICENSE for full license details.
+ *    Author(s):       Mathieu Carrière, David Loiseaux
+ *
+ *    Copyright (C) 2021 Inria
+ *
+ *    Modification(s):
+ *      - 2022/03 Hannah Schreiber: Rewriting of the Vineyard_persistence class with new matrix data structure.
+ */
+/**
+ * @file vineyards.h
+ * @author Mathieu Carrière, David Loiseaux, Hannah Schreiber
+ * @brief Core vineyards functions.
+ */
+
+#ifndef VINEYARDS_H_INCLUDED
+#define VINEYARDS_H_INCLUDED
+
+#define set_insertion_sort
+
+#include <vector>
+#include <iostream>
+#include <limits>
+#include <unordered_map>
+
+#include "debug.h"
+#include "combinatory.h"
+
+#include "utilities.h"
+//#include "ru_matrix.h"
+//#include "list_column.h"
+
+namespace Gudhi::multiparameter::mma {
+
+struct Filtration_creator
+{
+    //assumes matrix in an valid filtration order and the all vertices
+    //are in the first cells of vertexOrder in the same order than in matrix
+    static void get_lower_star_filtration(
+            const boundary_matrix& matrix,
+            const std::vector<value_type>& vertexOrder,
+            filtration_type& resultingFilter)
+    {
+        resultingFilter.resize(matrix.size());
+        int currentVertexPosition = 0;
+
+        for (unsigned int i = 0; i < matrix.size(); i++)
+        {
+            const boundary_type& b = matrix.at(i);
+            if (b.size() == 0){
+                resultingFilter.at(i) = vertexOrder.at(currentVertexPosition++);
+            } else {
+                resultingFilter.at(i) = resultingFilter.at(b.front());
+                for (unsigned int j = 1; j < b.size(); j++)
+                    resultingFilter.at(i) = std::max(resultingFilter.at(i),
+                                                        resultingFilter.at(b.at(j)));
+            }
+        }
+    }
+    static void complete_lower_star_filters_list(
+        const boundary_matrix &matrix,
+        std::vector<filtration_type> &filtersList)
+    {
+
+        for (filtration_type &fi : filtersList){ // gives a value to the lower star simplices
+            unsigned int n = fi.size(); // the number of simplicies that already have a filtration value
+            fi.resize(matrix.size());
+            for( unsigned int simplex = n; simplex < matrix.size(); simplex++ ){
+                const boundary_type& b = matrix.at(simplex);
+
+                // if(b.size() == 0)
+                //     std::cout << " Invalid Filtration !!\n"; // vertices must have a filtration
+
+                value_type value = fi.at(b.front());
+                for (unsigned int j = 1; j < b.size(); j++)
+                    value = std::max(value, fi[b[j]]);
+
+                fi[simplex] = value;
+            }
+        }
+    }
+
+
+};
+
+template<class Vineyard_matrix_type/* = RU_matrix<List_column>*/>
+/**
+ * @brief Stores the variables to be able to apply a vineyard update
+ * 
+ */
+class Vineyard_persistence
+{
+public:
+    Vineyard_persistence();
+    Vineyard_persistence(
+            const boundary_matrix& matrix,
+            bool verbose = false);
+    Vineyard_persistence(
+            const boundary_matrix& matrix,
+            const filtration_type& filter,
+            bool verbose = false);
+    Vineyard_persistence(
+            const Vineyard_matrix_type& matrix,
+            bool verbose = false);
+    Vineyard_persistence(
+            const Vineyard_matrix_type& matrix,
+            const filtration_type& filter,
+            bool verbose = false);
+    Vineyard_persistence(
+            const Vineyard_matrix_type& matrix,
+            const filtration_type& filter,
+            const permutation_type& permutation,
+            bool verbose = false);
+
+    void initialize_barcode();
+    void update(filtration_type &newFilter);
+    const diagram_type &get_diagram();
+    void display_diagram();
+    void display_filtration();
+
+    Vineyard_persistence& operator=(Vineyard_persistence other);
+
+private:
+    Vineyard_matrix_type matrix_;
+    permutation_type currentToOriginalPositions_;  //new pos to origin pos
+    diagram_type diagram_;
+    filtration_type filter_;
+    const bool verbose_;
+
+    value_type _get_current_filtration_value(index index);
+    void _sort_matrix(const boundary_matrix& matrix);
+    void _initialize_permutations();
+    void _initialize_filter();
+//     void _update_old(filtration_type &newFilter);
+};
+
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence()
+{}
+
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence(
+        const boundary_matrix& matrix,
+        bool verbose)
+    : matrix_(matrix),
+      currentToOriginalPositions_(matrix.size()),
+      filter_(matrix.size()),
+      verbose_(verbose)
+{   Debug::Timer timer("Creating matrix... ",verbose_);
+//     if (verbose_) std::cout << "Creating matrix ..." << std::flush;
+
+    _initialize_filter();
+    _sort_matrix(matrix);
+
+    if constexpr (Debug::debug){
+        Debug::disp_vect(filter_);
+        matrix_.print_matrices();
+    }
+
+//     if (verbose_) std::cout << " Done !" << std::endl;
+}
+
+//assumes filter[i] corresponds to filtration value of matrix[i]
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence(
+        const boundary_matrix& matrix,
+        const filtration_type& filter,
+        bool verbose)
+    : currentToOriginalPositions_(matrix.size()),
+      filter_(filter),
+      verbose_(verbose)
+{   Debug::Timer timer("Creating matrix... ",verbose_);
+//     if (verbose_) std::cout << "Creating matrix ..." << std::flush;
+
+    _sort_matrix(matrix);
+
+    if constexpr (Debug::debug){
+        Debug::disp_vect(filter_);
+        matrix_.print_matrices();
+    }
+
+//     if (verbose_) std::cout << " Done !" << std::endl;
+}
+
+//copy, i.e. assumes matrix sorted
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence(
+        const Vineyard_matrix_type& matrix,
+        bool verbose)
+    : matrix_(matrix),
+      currentToOriginalPositions_(matrix.size()),
+      filter_(matrix.size()),
+      verbose_(verbose)
+{   Debug::Timer timer("Creating matrix... ",verbose_);
+//     if (verbose_) std::cout << "Creating matrix ..." << std::flush;
+
+    _initialize_permutations();
+    _initialize_filter();
+
+    if constexpr (Debug::debug){
+        Debug::disp_vect(filter_);
+        matrix_.print_matrices();
+    }
+
+//     if (verbose_) std::cout << " Done !" << std::endl;
+}
+
+//copy, i.e. assumes matrix sorted and filter[i] corresponds to
+//filtration value of matrix[i]
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence(
+        const Vineyard_matrix_type& matrix,
+        const filtration_type& filter,
+        bool verbose)
+    : matrix_(matrix),
+      currentToOriginalPositions_(matrix.size()),
+      filter_(filter),
+      verbose_(verbose)
+{   Debug::Timer timer("Creating matrix... ",verbose_);
+//     if (verbose_) std::cout << "Creating matrix ..." << std::flush;
+
+    _initialize_permutations();
+
+    if constexpr (Debug::debug){
+        Debug::disp_vect(filter_);
+        matrix_.print_matrices();
+    }
+
+//     if (verbose_) std::cout << " Done !" << std::endl;
+}
+
+//copy, i.e. assumes matrix sorted and filter[permutation[i]]
+//corresponds to filtration value of matrix[i]
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>::Vineyard_persistence(
+        const Vineyard_matrix_type& matrix,
+        const filtration_type& filter,
+        const permutation_type& permutation,    //new to original
+        bool verbose)
+    : matrix_(matrix),
+      currentToOriginalPositions_(permutation),
+      filter_(filter),
+      verbose_(verbose)
+{   Debug::Timer timer("Creating matrix",verbose_);
+//     if (verbose_) std::cout << "Creating matrix ..." << std::flush;
+
+    if constexpr (Debug::debug){
+        Debug::disp_vect(filter_);
+        matrix_.print_matrices();
+    }
+
+//     if (verbose_) std::cout << " Done !" << std::endl;
+}
+
+/**
+ * @brief Computes the first barcode, and fills the variables in the class.
+ * @param verbose
+ * @param debug
+ */
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::initialize_barcode()
+{
+    if (verbose_) {
+        std::cout << "Initializing barcode";
+    }
+    auto elapsed = clock();
+
+    matrix_.initialize();
+
+    if (verbose_)
+    {
+        elapsed = clock() - elapsed;
+        std::cout << "... Done ! It took " << ((float)elapsed) / CLOCKS_PER_SEC
+                  << " seconds." << std::endl;
+    }
+}
+
+// template<class Vineyard_matrix_type>
+// inline void Vineyard_persistence<Vineyard_matrix_type>::update(
+//         filtration_type &newFilter)
+// {
+//     _update_old(newFilter);
+// }
+
+/**
+ * @brief Gets diagram from RU decomposition.
+ */
+template<class Vineyard_matrix_type>
+inline const diagram_type& Vineyard_persistence<Vineyard_matrix_type>::get_diagram()
+{
+    const barcode_type& barcode = matrix_.get_current_barcode();
+    unsigned int size = barcode.size();
+
+    diagram_.resize(size);
+
+    for (unsigned int i = 0; i < size; i++){
+        const Bar& bar = barcode.at(i);
+        Diagram_point& point = diagram_.at(i);
+        point.dim = bar.dim;
+        point.birth = _get_current_filtration_value(bar.birth);
+		point.death = (bar.death == -1 ?
+						   inf
+						 : _get_current_filtration_value(bar.death));
+	}
+
+    return diagram_;
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::display_diagram()
+{
+    for (const Diagram_point& point : diagram_){
+        std::cout << point.dim << " " << point.birth << " "
+                  << point.death << std::endl;
+    }
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::display_filtration()
+{
+    std::cout << "filter:\n";
+    for (double filtValue : filter_)
+        std::cout << filtValue << " ";
+    std::cout << std::endl;
+}
+
+template<class Vineyard_matrix_type>
+inline Vineyard_persistence<Vineyard_matrix_type>&
+Vineyard_persistence<Vineyard_matrix_type>::operator=(
+        Vineyard_persistence<Vineyard_matrix_type> other)
+{
+    std::swap(matrix_, other.matrix_);
+    std::swap(currentToOriginalPositions_, other.currentToOriginalPositions_);
+    std::swap(diagram_, other.diagram_);
+    std::swap(filter_, other.filter_);
+    return *this;
+}
+
+template<class Vineyard_matrix_type>
+inline value_type
+Vineyard_persistence<Vineyard_matrix_type>::_get_current_filtration_value(
+        index index)
+{
+	return filter_.at(currentToOriginalPositions_.at(index));
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::_sort_matrix(
+        const boundary_matrix &matrix)
+{
+//     auto is_strict_less_than = [&matrix, this](
+//             unsigned int index1, unsigned int index2)
+//     {
+//         if (matrix.at(index1).size() != matrix.at(index2).size())
+//             return matrix.at(index1).size() < matrix.at(index2).size();
+//         return filter_.at(index1) < filter_.at(index2);
+//     };
+    auto is_less_filtration = [this]( // Dimension is already assumed to be sorted
+        unsigned int index1, unsigned int index2)
+    {
+        return filter_.at(index1) < filter_.at(index2);
+    };
+
+    permutation_type permutationInv(currentToOriginalPositions_.size());
+    _initialize_permutations();
+//     {Debug::Timer timer("Sorting matrix ...", verbose_);
+//         std::sort(currentToOriginalPositions_.begin(), currentToOriginalPositions_.end(), is_strict_less_than);
+    unsigned int iterator = 1;
+    while(iterator < matrix.size() ){
+        auto first = iterator-1;
+        while(iterator < matrix.size() && matrix.at(iterator).size() ==  matrix.at(iterator-1).size()){
+            iterator++;
+        }
+        std::sort(currentToOriginalPositions_.begin()+first , currentToOriginalPositions_.begin() + iterator, is_less_filtration );
+        iterator++;
+    }
+//     }
+//     {Debug::Timer timer("Initialisation permutation ...", verbose_);
+    for (unsigned int i = 0; i < permutationInv.size(); i++)
+        permutationInv.at(currentToOriginalPositions_.at(i)) = i;
+//     }
+    boundary_matrix sorted(matrix.size());
+//     {Debug::Timer timer("Transfering matrix ...", verbose_);
+    for (unsigned int i = 0; i < matrix.size(); i++){
+        boundary_type& b = sorted.at(permutationInv.at(i));
+        b = matrix.at(i);
+        for (index& id : b)
+            id = permutationInv.at(id);
+        std::sort(b.begin(), b.end());
+    }
+//     }
+
+    matrix_ = Vineyard_matrix_type(sorted);
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::_initialize_permutations()
+{
+    for (unsigned int i = 0; i < currentToOriginalPositions_.size(); i++)
+        currentToOriginalPositions_.at(i) = i;
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::_initialize_filter()
+{
+    for (unsigned int i = 0; i < filter_.size(); i++)
+        filter_.at(i) = i;
+}
+
+template<class Vineyard_matrix_type>
+inline void Vineyard_persistence<Vineyard_matrix_type>::update(
+        filtration_type &newFilter)
+{
+
+    filter_.swap(newFilter);
+
+//    uint k = 0;
+
+#ifndef set_insertion_sort
+    int n = matrix_.get_number_of_simplices();
+    bool sorted = false;
+    for (int i = n - 1; i > 0 && !sorted; i--)
+    {
+        sorted = true;
+        for (int j = 0; j < i; j++)
+        {
+            if (matrix_.get_dimension(j) == matrix_.get_dimension(j + 1) &&
+                _get_current_filtration_value(j) > _get_current_filtration_value(j + 1))
+            {
+                matrix_.vine_swap(j);
+                std::swap(currentToOriginalPositions_[j],
+                          currentToOriginalPositions_[j + 1]);
+                sorted = false;
+//                if (verbose_) k++;
+            }
+        }
+    }
+#else
+    unsigned int n = matrix_.get_number_of_simplices();
+    for (unsigned int i = 0; i < n; i++)
+    {
+        unsigned int j = i;
+        while (j > 0 && matrix_.get_dimension(j) == matrix_.get_dimension(j - 1) &&
+            _get_current_filtration_value(j) < _get_current_filtration_value(j - 1))
+        {
+            matrix_.vine_swap(j - 1);
+            std::swap(currentToOriginalPositions_[j - 1],
+                      currentToOriginalPositions_[j]);
+            j--;
+        }
+    }
+#endif
+
+
+
+
+//    if (verbose_)
+//        std::cout << "Permuted " << k << "times, with " << n
+//                  << " simplices." << std::endl;
+};
+
+}   //namespace Vineyard
+
+#endif // VINEYARDS_H_INCLUDED