scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ > Struct Template Reference

Buffers for per_cell_qc_metrics(). More...

#include <per_cell_qc_metrics.hpp>

Public Attributes
Sum_ *	sum = NULL
Detected_ *	detected = NULL
Index_ *	max_index = NULL
Value_ *	max_value = NULL
std::vector< Sum_ * >	subset_sum
std::vector< Detected_ * >	subset_detected

Detailed Description

template<typename Sum_, typename Detected_, typename Value_, typename Index_>
struct scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >

Buffers for per_cell_qc_metrics().

Template Parameters

Sum_	Floating point type to store the sums.
Detected_	Integer type to store the number of detected cells.
Value_	Type of the matrix value.
Index_	Integer type of the matrix index.

Member Data Documentation

sum

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

Sum_* scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::sum = NULL

Pointer to an array of length equal to the number of cells, equivalent to PerCellQcMetricsResults::sum. Set to NULL to skip this calculation.

detected

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

Detected_* scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::detected = NULL

Pointer to an array of length equal to the number of cells, equivalent to PerCellQcMetricsResults::detected. Set to NULL to skip this calculation.

max_index

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

Index_* scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::max_index = NULL

Pointer to an array of length equal to the number of cells, equivalent to PerCellQcMetricsResults::max_index. Set to NULL to skip this calculation.

max_value

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

Value_* scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::max_value = NULL

Pointer to an array of length equal to the number of cells, equivalent to PerCellQcMetricsResults::max_value. Set to NULL to skip this calculation.

subset_sum

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Sum_*> scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::subset_sum

Vector of pointers of length equal to the number of feature subsets, where each point is to an array of length equal to the number of cells; equivalent to PerCellQcMetricsResults::subset_sum. Set any value to NULL to skip the calculation for the corresponding feature subset, or leave empty to skip calculations for all feature subsets.

subset_detected

template<typename Sum_ , typename Detected_ , typename Value_ , typename Index_ >

std::vector<Detected_*> scran_qc::PerCellQcMetricsBuffers< Sum_, Detected_, Value_, Index_ >::subset_detected

Vector of pointers of length equal to the number of feature subsets, where each point is to an array of length equal to the number of cells; equivalent to PerCellQcMetricsResults::subset_detected. Set any value to NULL to skip the calculation for the corresponding feature subset, or leave empty to skip calculations for all feature subsets.

---

The documentation for this struct was generated from the following file:

• scran_qc/per_cell_qc_metrics.hpp