scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ > Struct Template Reference

Gene set to use in aggregate_across_genes(). More...

#include <aggregate_across_genes.hpp>

Public Member Functions
	AggregateAcrossGenesSet ()=default
	AggregateAcrossGenesSet (std::size_t number, const Gene_ *gene, const Weight_ *weight)

Public Attributes
std::size_t	number = 0
const Gene_ *	gene = NULL
const Weight_ *	weight = NULL

Detailed Description

template<typename Gene_, typename Weight_>
struct scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >

Gene set to use in aggregate_across_genes().

Template Parameters

Gene_	Integer type of the indices of genes in each set.
Weight_	Floating-point type of the weights of genes in each set.

Constructor & Destructor Documentation

AggregateAcrossGenesSet() [1/2]

template<typename Gene_ , typename Weight_ >

scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >::AggregateAcrossGenesSet ( )

default

Default constructor.

AggregateAcrossGenesSet() [2/2]

template<typename Gene_ , typename Weight_ >

scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >::AggregateAcrossGenesSet ( std::size_t number, const Gene_ * gene, const Weight_ * weight )

inline

Parameters

number	Number of genes in the set.
gene	Pointer to an array of length number, containing the row indices of the genes in the set. Each entry should be a non-negative integer that is less than input.nrow() in aggregate_across_genes(). Values should be unique.
weight	Pointer to an array of length number, containing the weight for each gene in the set. Each entry corresponds to an entry of gene and specifies the weight for that gene. For unweighted sets, this should be set to NULL.

Member Data Documentation

number

template<typename Gene_ , typename Weight_ >

std::size_t scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >::number = 0

Number of genes in the set.

gene

template<typename Gene_ , typename Weight_ >

const Gene_* scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >::gene = NULL

Pointer to an array of length number, containing the unique row indices of all genes in the set.

weight

template<typename Gene_ , typename Weight_ >

const Weight_* scran_aggregate::AggregateAcrossGenesSet< Gene_, Weight_ >::weight = NULL

Pointer to an array of length number, containing the weights for all genes in the set. This may also be set to NULL if no weights are available.

---

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

• scran_aggregate/aggregate_across_genes.hpp