cluster_leiden.hpp

Go to the documentation of this file.

#ifndef SCRAN_GRAPH_CLUSTER_CLUSTER_LEIDEN_HPP
#define SCRAN_GRAPH_CLUSTER_CLUSTER_LEIDEN_HPP
 
#include <vector>
#include <algorithm>
 
#include "raiigraph/raiigraph.hpp"
#include "sanisizer/sanisizer.hpp"
 
#include "igraph.h"
 
namespace scran_graph_cluster {
 
struct ClusterLeidenOptions {
    igraph_real_t resolution = 1;
 
    igraph_real_t beta = 0.01;
 
    igraph_int_t iterations = 2;
 
    igraph_leiden_objective_t objective = IGRAPH_LEIDEN_OBJECTIVE_CPM;
 
    bool report_quality = true;
 
    igraph_uint_t seed = 42;
};
 
struct ClusterLeidenResults {
    raiigraph::IntegerVector membership;
 
    igraph_real_t quality = 0;
};
 
inline void cluster_leiden(const igraph_t* graph, const igraph_vector_t* weights, const ClusterLeidenOptions& options, ClusterLeidenResults& output) {
    const auto membership = output.membership.get();
    const auto quality = (options.report_quality ? &(output.quality) : static_cast<igraph_real_t*>(NULL));
 
    const raiigraph::RNGScope rngs(options.seed);
 
    const auto status = igraph_community_leiden_simple(
        graph, 
        weights, 
        options.objective,
        options.resolution, 
        options.beta, 
        false, 
        options.iterations, 
        membership, 
        NULL, 
        quality
    );
 
    raiigraph::check_code(status);
}
 
inline ClusterLeidenResults cluster_leiden(const raiigraph::Graph& graph, const std::vector<igraph_real_t>& weights, const ClusterLeidenOptions& 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()));
 
    ClusterLeidenResults output;
    cluster_leiden(graph.get(), &weight_view, options, output);
    return output;
}
 
}
 
#endif