scran_variances::ModelGeneVariancesBuffers< Stat_ > Struct Template Reference

Buffers for model_gene_variances() and friends. More...

#include <model_gene_variances.hpp>

Public Attributes
Stat_ *	mean
Stat_ *	variance
Stat_ *	fitted
Stat_ *	residual

Detailed Description

template<typename Stat_>
struct scran_variances::ModelGeneVariancesBuffers< Stat_ >

Buffers for model_gene_variances() and friends.

Template Parameters

Stat_

Floating-point type of the output statistics.

In general, the pointers in this class should not be set to NULL. The only exception is for instances of this class that are used as ModelGeneVariancesBlockedBuffers::average, where setting the pointer to NULL will omit calculation of the corresponding average statistic.

Member Data Documentation

mean

template<typename Stat_ >

Stat_* scran_variances::ModelGeneVariancesBuffers< Stat_ >::mean

Pointer to an array of length equal to the number of genes, to be filled with the mean log-expression for each gene.

variance

template<typename Stat_ >

Stat_* scran_variances::ModelGeneVariancesBuffers< Stat_ >::variance

Pointer to an array of length equal to the number of genes, containing the variance in the log-expression for each gene.

fitted

template<typename Stat_ >

Stat_* scran_variances::ModelGeneVariancesBuffers< Stat_ >::fitted

Pointer to an array of length equal to the number of genes, containing the fitted value of the mean-variance trend for each gene.

If this or ModelGeneVariancesBuffers::residual is NULL, no trend is fitted.

residual

template<typename Stat_ >

Stat_* scran_variances::ModelGeneVariancesBuffers< Stat_ >::residual

Vector of length equal to the number of genes, containing the residuals of the mean-variance trend for each gene.

If this or ModelGeneVariancesBuffers::fitted is NULL, no trend is fitted.

---

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

• scran_variances/model_gene_variances.hpp