summarize_effects.hpp

Go to the documentation of this file.

#ifndef SCRAN_MARKERS_SUMMARIZE_EFFECTS_HPP
#define SCRAN_MARKERS_SUMMARIZE_EFFECTS_HPP
 
#include <vector>
#include <cstddef>
 
#include "summarize_comparisons.hpp"
#include "utils.hpp"
 
namespace scran_markers {
 
struct SummarizeEffectsOptions {
    int num_threads = 1;
 
    bool compute_min = true;
 
    bool compute_mean = true;
 
    bool compute_median = true;
 
    bool compute_max = true;
 
    bool compute_min_rank = true;
 
    std::optional<std::vector<double> > compute_quantiles;
 
    bool min_rank_preserve_ties = false;
};
 
template<typename Gene_, typename Stat_, typename Rank_>
void summarize_effects(
    const Gene_ ngenes,
    const std::size_t ngroups,
    const Stat_* const effects,
    const std::vector<SummaryBuffers<Stat_, Rank_> >& summaries,
    const SummarizeEffectsOptions& options
) {
    internal::compute_min_rank_pairwise(ngenes, ngroups, effects, summaries, options.min_rank_preserve_ties, options.num_threads);
    internal::validate_quantiles(options.compute_quantiles);
    internal::summarize_comparisons(ngenes, ngroups, effects, options.compute_quantiles, summaries, options.num_threads); 
}
 
template<typename Stat_ = double, typename Rank_ = int, typename Gene_>
std::vector<SummaryResults<Stat_, Rank_> > summarize_effects(
    const Gene_ ngenes,
    const std::size_t ngroups,
    const Stat_* const effects,
    const SummarizeEffectsOptions& options
) {
    std::vector<SummaryResults<Stat_, Rank_> > output;
    const auto ptrs = internal::fill_summary_results(
        ngenes,
        ngroups,
        output,
        options.compute_min,
        options.compute_mean,
        options.compute_median,
        options.compute_max,
        options.compute_quantiles,
        options.compute_min_rank
    );
    summarize_effects(ngenes, ngroups, effects, ptrs, options);
    return output;
}
 
}
 
#endif