topicks::TopQueueOptions< Stat_ > Struct Template Reference

Options for TopQueue. More...

#include <TopQueue.hpp>

Public Attributes
std::optional< Stat_ >	bound
bool	open_bound = true
bool	keep_ties = true
bool	check_nan = false
std::optional< std::size_t >	reserve

Detailed Description

template<typename Stat_>
struct topicks::TopQueueOptions< Stat_ >

Options for TopQueue.

Template Parameters

Stat_

Numeric type of the statistic for ranking top genes.

Member Data Documentation

bound

template<typename Stat_ >

std::optional<Stat_> topicks::TopQueueOptions< Stat_ >::bound

A absolute bound for the statistic. A gene will not be inserted in the queue if its statistic is:

• equal to or lower than the bound, when larger = true and TopQueueOptions::open_bound = true.
• lower than the bound, when larger = true and TopQueueOptions::open_bound = false.
• equal to or greater than the bound, when larger = false and TopQueueOptions::open_bound = true.
• greater than the bound, when larger = false and TopQueueOptions::open_bound = false.

If unset, no absolute bound is applied to the statistic.

open_bound

template<typename Stat_ >

bool topicks::TopQueueOptions< Stat_ >::open_bound = true

Whether TopQueue::bound is an open interval, i.e., genes with statistics equal to the bound will not be inserted in the queue. Only relevant if TopQueue::bound is set.

keep_ties

template<typename Stat_ >

bool topicks::TopQueueOptions< Stat_ >::keep_ties = true

Whether to keep all genes with statistics that are tied with the top-th gene. If false, the number of genes in the queue will not be greater than top; ties are broken by retaining genes with a lower index.

check_nan

template<typename Stat_ >

bool topicks::TopQueueOptions< Stat_ >::check_nan = false

Whether to check for NaN values and ignore them. If false, it is assumed that no NaNs will be added to the queue.

reserve

template<typename Stat_ >

std::optional<std::size_t> topicks::TopQueueOptions< Stat_ >::reserve

Memory to reserve for the underlying storage during TopQueue construction. If not provided, memory is automatically reserved for top elements to prevent any reallocation upon TopQueue::push(). Setting this value to zero will disable preallocation.

---

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

• topicks/TopQueue.hpp