NCBI C++ ToolKit
Static Public Member Functions | List of all members
bm::agg_run_options< OBvects, OCounts, OSearchMasks > Struct Template Reference

Search Toolkit Book for bm::agg_run_options

Aggregation options to control execution Default settings are to support only result bit-vector filters. More...

#include <util/bitset/bmaggregator.h>

Static Public Member Functions

static constexpr bool is_make_results () noexcept
 make result(target) vectors (aggregation search results) (Default: true) when false is used - means we want to only collect statistics (counts) for the targets More...
 
static constexpr bool is_compute_counts () noexcept
 Compute counts for the target vectors, when set to true, population count is computed for each result, results itself can be omitted (make_results flag set to false) More...
 
static constexpr bool is_masks () noexcept
 Support for masking operations (Default: false) More...
 

Detailed Description

template<bool OBvects = bm::agg_produce_result_bvectors, bool OCounts = bm::agg_disable_counts, bool OSearchMasks = bm::agg_disable_search_masks>
struct bm::agg_run_options< OBvects, OCounts, OSearchMasks >

Aggregation options to control execution Default settings are to support only result bit-vector filters.

Definition at line 65 of file bmaggregator.h.

Member Function Documentation

◆ is_compute_counts()

template<bool OBvects = bm::agg_produce_result_bvectors, bool OCounts = bm::agg_disable_counts, bool OSearchMasks = bm::agg_disable_search_masks>
static constexpr bool bm::agg_run_options< OBvects, OCounts, OSearchMasks >::is_compute_counts ( )
inlinestaticconstexprnoexcept

Compute counts for the target vectors, when set to true, population count is computed for each result, results itself can be omitted (make_results flag set to false)

Definition at line 73 of file bmaggregator.h.

◆ is_make_results()

template<bool OBvects = bm::agg_produce_result_bvectors, bool OCounts = bm::agg_disable_counts, bool OSearchMasks = bm::agg_disable_search_masks>
static constexpr bool bm::agg_run_options< OBvects, OCounts, OSearchMasks >::is_make_results ( )
inlinestaticconstexprnoexcept

make result(target) vectors (aggregation search results) (Default: true) when false is used - means we want to only collect statistics (counts) for the targets

Definition at line 69 of file bmaggregator.h.

◆ is_masks()

template<bool OBvects = bm::agg_produce_result_bvectors, bool OCounts = bm::agg_disable_counts, bool OSearchMasks = bm::agg_disable_search_masks>
static constexpr bool bm::agg_run_options< OBvects, OCounts, OSearchMasks >::is_masks ( )
inlinestaticconstexprnoexcept

Support for masking operations (Default: false)

Definition at line 77 of file bmaggregator.h.


The documentation for this struct was generated from the following file:
Modified on Sun Apr 14 05:28:37 2024 by modify_doxy.py rev. 669887