gsdecon
C++ port of the GSDecon algorithm
Loading...
Searching...
No Matches
compute.hpp
Go to the documentation of this file.
1#ifndef GSDECON_COMPUTE_HPP
2#define GSDECON_COMPUTE_HPP
3
4#include <algorithm>
5#include <numeric>
6
7#include "tatami/tatami.hpp"
8#include "irlba/irlba.hpp"
9#include "scran_pca/scran_pca.hpp"
10#include "sanisizer/sanisizer.hpp"
11
12#include "Options.hpp"
13#include "Results.hpp"
14#include "utils.hpp"
15
21namespace gsdecon {
22
46template<typename Value_, typename Index_, typename Float_>
47irlba::Metrics compute(const tatami::Matrix<Value_, Index_>& matrix, const Options& options, const Buffers<Float_>& output) {
48 if (check_edge_cases(matrix, options.rank, output)) {
49 irlba::Metrics metrics;
50 metrics.converged = true;
51 return metrics;
52 }
53
54 scran_pca::SimplePcaOptions sopt;
55 sopt.number = options.rank;
56 sopt.scale = options.scale;
57 sopt.realize_matrix = options.realize_matrix;
58 sopt.num_threads = options.num_threads;
59 sopt.irlba_options = options.irlba_options;
60 const auto res = scran_pca::simple_pca(matrix, sopt);
61
62 const Float_ shift = std::accumulate(res.center.begin(), res.center.end(), static_cast<Float_>(0)) / matrix.nrow();
63 std::fill_n(output.scores, matrix.ncol(), shift);
64 process_output(res.rotation, res.components, options.scale, res.scale, output);
65
66 return res.metrics;
67}
68
82template<typename Float_ = double, typename Value_, typename Index_>
84 Results<Float_> output;
85 sanisizer::resize(output.weights, matrix.nrow()
86#ifdef SCRAN_QC_TEST_INIT
87 , SCRAN_QC_TEST_INIT
88#endif
89 );
90 sanisizer::resize(output.scores, matrix.ncol()
91#ifdef SCRAN_QC_TEST_INIT
92 , SCRAN_QC_TEST_INIT
93#endif
94 );
95
96 Buffers<Float_> buffers;
97 buffers.weights = output.weights.data();
98 buffers.scores = output.scores.data();
99
100 output.metrics = compute(matrix, options, buffers);
101 return output;
102}
103
104}
105
106#endif
Options for the gsdecon algorithm.
Classes for storing the results.
virtual Index_ ncol() const=0
virtual Index_ nrow() const=0
Gene set scoring with gsdecon.
Definition blocked.hpp:21
irlba::Metrics compute(const tatami::Matrix< Value_, Index_ > &matrix, const Options &options, const Buffers< Float_ > &output)
Definition compute.hpp:47
Buffers for the results of compute() and compute_blocked().
Definition Results.hpp:20
Float_ * scores
Definition Results.hpp:25
Float_ * weights
Definition Results.hpp:31
Options for compute() and compute_blocked().
Definition Options.hpp:18
bool realize_matrix
Definition Options.hpp:64
int rank
Definition Options.hpp:34
irlba::Options< Eigen::VectorXd > irlba_options
Definition Options.hpp:69
int num_threads
Definition Options.hpp:58
bool scale
Definition Options.hpp:41
Results of compute() and compute_blocked().
Definition Results.hpp:39
std::vector< Float_ > weights
Definition Results.hpp:51
std::vector< Float_ > scores
Definition Results.hpp:44
irlba::Metrics metrics
Definition Results.hpp:56