tatami_stats
Matrix statistics for tatami
Loading...
Searching...
No Matches
tatami_stats::skip_nan::RssOptions< Output_ > Struct Template Reference

Options for skip_nan::rss(). More...

#include <rss.hpp>

Public Attributes

int num_threads = 1
 
Output_ mean_placeholder = quickstats::nan_if_available_else_zero<Output_>()
 

Detailed Description

template<typename Output_ = double>
struct tatami_stats::skip_nan::RssOptions< Output_ >

Options for skip_nan::rss().

Template Parameters
Output_Floating-point type of the output data.

Member Data Documentation

◆ num_threads

template<typename Output_ = double>
int tatami_stats::skip_nan::RssOptions< Output_ >::num_threads = 1

Number of threads to use for iterating over a tatami::Matrix. See tatami::parallelize() for more details on the parallelization mechanism.

◆ mean_placeholder

template<typename Output_ = double>
Output_ tatami_stats::skip_nan::RssOptions< Output_ >::mean_placeholder = quickstats::nan_if_available_else_zero<Output_>()

Placeholder value to use for the mean when the extent of the relevant dimension is zero. This is NaN if supported by Output_, otherwise it is zero.


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