ClusteringMetrics.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <vector>
// ttk common includes
#include <Debug.h>
 
namespace ttk {
 
  class ClusteringMetrics : virtual public Debug {
 
  public:
    ClusteringMetrics();
 
    int execute(const int *clustering1,
                const int *clustering2,
                const size_t n,
                double &nmiValue,
                double &ariValue) const;
 
    int
      computeContingencyTables(const int *clust1,
                               const int *clust2,
                               const size_t nPoint,
                               std::vector<std::vector<int>> &contingencyMatrix,
                               std::vector<int> &sumLin,
                               std::vector<int> &sumCol) const;
 
    // For single ARI or single NMI computing, the contingency matrix, as well
    // as the sums of each lines and each column must be provided as arguments.
    int computeARI(const std::vector<std::vector<int>> &contingencyMatrix,
                   const std::vector<int> &sumLin,
                   const std::vector<int> &sumCol,
                   const size_t nPoint,
                   double &ariValue) const;
    int computeNMI(const std::vector<std::vector<int>> &contingencyMatrix,
                   const std::vector<int> &sumLin,
                   const std::vector<int> &sumCol,
                   const size_t nPoint,
                   double &nmiValue) const;
  }; // ClusteringMetrics class
 
} // namespace ttk