cluster_multilevel.hpp

Go to the documentation of this file.

#ifndef SCRAN_CLUSTER_MULTILEVEL_HPP
#define SCRAN_CLUSTER_MULTILEVEL_HPP
 
#include <vector>
#include <algorithm>
 
#include "raiigraph/raiigraph.hpp"
#include "sanisizer/sanisizer.hpp"
 
#include "igraph.h"
 
namespace scran_graph_cluster {
 
struct ClusterMultilevelOptions {
    igraph_real_t resolution = 1;
 
    igraph_uint_t seed = 42;
 
    bool report_levels = true;
 
    bool report_modularity = true;
};
 
struct ClusterMultilevelResults {
    raiigraph::IntegerVector membership;
 
    raiigraph::IntegerMatrix levels;
 
    raiigraph::RealVector modularity;
};
 
inline void cluster_multilevel(const igraph_t* graph, const igraph_vector_t* weights, const ClusterMultilevelOptions& options, ClusterMultilevelResults& output) {
    const raiigraph::RNGScope rngs(options.seed);
 
    const auto modularity = (options.report_modularity ? output.modularity.get() : static_cast<igraph_vector_t*>(NULL));
    const auto membership = output.membership.get();
    const auto memberships = (options.report_levels ? output.levels.get() : static_cast<igraph_matrix_int_t*>(NULL));
 
    const auto status = igraph_community_multilevel(
        graph,
        weights,
        options.resolution,
        membership,
        memberships, 
        modularity
    );
 
    raiigraph::check_code(status);
}
 
inline ClusterMultilevelResults cluster_multilevel(const raiigraph::Graph& graph, const std::vector<igraph_real_t>& weights, const ClusterMultilevelOptions& options) {
    // No need to free this, as it's just a view.
    const auto weight_view = igraph_vector_view(weights.data(), sanisizer::cast<igraph_int_t>(weights.size()));
 
    ClusterMultilevelResults output;
    cluster_multilevel(graph.get(), &weight_view, options, output);
    return output;
}
 
}
 
#endif