Options for compute_distance_blocked(). More...

#include <blocked.hpp>

Collaboration diagram for mumosa::BlockedOptions:

Public Attributes
int	num_neighbors = 20

scran_blocks::WeightPolicy	block_weight_policy = scran_blocks::WeightPolicy::VARIABLE

scran_blocks::VariableWeightParameters	variable_block_weight_parameters

int	num_threads = 1

Detailed Description

Options for compute_distance_blocked().

Member Data Documentation

◆ num_neighbors

int mumosa::BlockedOptions::num_neighbors = 20

Number of neighbors for the nearest neighbor search. Larger values improve stability at the risk of including biological heterogeneity into the distance. num_neighbors + 1 can also be interpreted as the expected minimum size of each subpopulation.

◆ block_weight_policy

scran_blocks::WeightPolicy mumosa::BlockedOptions::block_weight_policy = scran_blocks::WeightPolicy::VARIABLE

Policy to use for weighting the contribution from each block when computing the average distance.

◆ variable_block_weight_parameters

scran_blocks::VariableWeightParameters mumosa::BlockedOptions::variable_block_weight_parameters

Parameters for the variable block weights, including the threshold at which blocks are considered to be large enough to have equal weight. Only relevant when BlockedOptions::block_weight_policy = scran_blocks::WeightPolicy::VARIABLE.

◆ num_threads

int mumosa::BlockedOptions::num_threads = 1

Number of threads to use. The parallelization mechanism is determined by knncolle::parallelize(). t

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