Pipeline vector for running a group of aggregation operations on a family of vectors. More...

#include <bmaggregator.h>

Collaboration diagram for bm::aggregator< BV >::pipeline< Opt >:

Public Types
typedef Opt	options_type

Public Member Functions
	pipeline ()

run_options &	options () BMNOEXCEPT
	Set pipeline run options. More...

const run_options &	get_options () const BMNOEXCEPT
	Get pipeline run options. More...

Aggregator traits and control constants
	~pipeline () BMNOEXCEPT
	More...

pipeline argument groups fill-in methods
arg_groups *	add ()
	Add new arguments group. More...

void	set_or_target (bvector_type *bv_or) BMNOEXCEPT
	Attach OR (aggregator vector). More...

void	set_search_count_limit (size_type limit) BMNOEXCEPT
	Set search limit for results. More...

void	complete ()
	Prepare pipeline for the execution (resize and init internal structures) Once complete, you cannot add() to it. More...

bool	is_complete () const BMNOEXCEPT
	return true if pipeline is ready for execution (complete) More...

size_type	size () const BMNOEXCEPT
	Return size() of pileine. More...

const arg_vector_type &	get_args_vector () const BMNOEXCEPT
	Return argument vector used for pipeline execution. More...

bvect_vector_type &	get_bv_res_vector () BMNOEXCEPT
	Return results vector used for pipeline execution. More...

bv_count_vector_type &	get_bv_count_vector () BMNOEXCEPT
	Return results vector count used for pipeline execution. More...

access to internals
class	aggregator

run_options	options_
	execution parameters More...

bool	is_complete_ = false
	ready to run state flag More...

size_t	total_vect_ = 0
	total number of vector mentions in all groups More...

arg_vector_type	arg_vect_
	input arg. groups More...

bvect_vector_type	bv_res_vect_
	results (bit-vector ptrs) More...

bv_count_vector_type	count_res_vect_
	results (counts) More...

size_type	search_count_limit_ {bm::id_max}
	search limit by count More...

pipeline_bcache	bcache_
	blocks cache structure More...

unsigned	top_blocks_ = 1
	top-level structure size, max of all bvectors More...

bvector_type *	bv_or_target_ = 0
	OR target bit-bector ptr. More...

const bv_vector_type &	get_all_input_vect () const BMNOEXCEPT
	More...

const count_vector_type &	get_all_input_cnt_vect () const BMNOEXCEPT
	More...

size_t	unique_vectors () const BMNOEXCEPT
	Return number of unique vectors in the pipeline (after complete()) More...

size_t	compute_run_batch () const BMNOEXCEPT
	Function looks at the pipeline to apply euristics to suggest optimal run_batch parameter. More...

pipeline_bcache &	get_bcache () BMNOEXCEPT
	More...

unsigned	get_top_blocks () const BMNOEXCEPT
	Return number of top blocks after complete. More...

	pipeline (const pipeline &)=delete

pipeline &	operator= (const pipeline &)=delete

Detailed Description

template<typename BV>
template<class Opt = bm::agg_run_options<>>
class bm::aggregator< BV >::pipeline< Opt >

Pipeline vector for running a group of aggregation operations on a family of vectors.

Pipeline is used to run multiple aggregation combinations (searches) for essencially same set of vectors (different combinations of ANDs and SUBs for example). Pipeline execution improves CPU cache reuse and caches the compressed blocks to re-use it for more efficient execution. Essencially it is a tool to run thousads of runs at once faster.

Definition at line 223 of file bmaggregator.h.

Member Function Documentation

◆ add()

template<typename BV >

template<class Opt >

aggregator< BV >::arg_groups * bm::aggregator< BV >::pipeline< Opt >::add

Add new arguments group.

Definition at line 2797 of file bmaggregator.h.

References BM_ASSERT.

◆ complete()

template<typename BV >

template<class Opt >

void bm::aggregator< BV >::pipeline< Opt >::complete

Prepare pipeline for the execution (resize and init internal structures) Once complete, you cannot add() to it.

Definition at line 2692 of file bmaggregator.h.

References bm::aggregator< BV >::arg_groups::arg_bv0, bm::aggregator< BV >::arg_groups::arg_bv1, and BM_ASSERT.

◆ compute_run_batch()

template<typename BV >

template<class Opt >

size_t bm::aggregator< BV >::pipeline< Opt >::compute_run_batch

Function looks at the pipeline to apply euristics to suggest optimal run_batch parameter.

Definition at line 2808 of file bmaggregator.h.

References bm::set_block_size.

◆ get_all_input_cnt_vect()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

const count_vector_type& bm::aggregator< BV >::pipeline< Opt >::get_all_input_cnt_vect ( ) const

inline

Definition at line 297 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bcache_, and bm::aggregator< BV >::pipeline_bcache::cnt_vect_.

◆ get_all_input_vect()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

const bv_vector_type& bm::aggregator< BV >::pipeline< Opt >::get_all_input_vect ( ) const

inline

Definition at line 295 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bcache_, and bm::aggregator< BV >::pipeline_bcache::bv_inp_vect_.

◆ get_args_vector()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

const arg_vector_type& bm::aggregator< BV >::pipeline< Opt >::get_args_vector ( ) const

inline

Return argument vector used for pipeline execution.

Definition at line 279 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::arg_vect_.

◆ get_bcache()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

pipeline_bcache& bm::aggregator< BV >::pipeline< Opt >::get_bcache ( )

inlineprotected

Definition at line 310 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bcache_.

◆ get_bv_count_vector()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bv_count_vector_type& bm::aggregator< BV >::pipeline< Opt >::get_bv_count_vector ( )

inline

Return results vector count used for pipeline execution.

Definition at line 287 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::count_res_vect_.

◆ get_bv_res_vector()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bvect_vector_type& bm::aggregator< BV >::pipeline< Opt >::get_bv_res_vector ( )

inline

Return results vector used for pipeline execution.

Definition at line 283 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bv_res_vect_.

◆ get_options()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

const run_options& bm::aggregator< BV >::pipeline< Opt >::get_options ( ) const

inline

Get pipeline run options.

Definition at line 235 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::options_.

◆ get_top_blocks()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

unsigned bm::aggregator< BV >::pipeline< Opt >::get_top_blocks ( ) const

inlineprotected

Return number of top blocks after complete.

Definition at line 315 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::top_blocks_.

◆ is_complete()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bool bm::aggregator< BV >::pipeline< Opt >::is_complete ( ) const

inline

return true if pipeline is ready for execution (complete)

Definition at line 269 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::is_complete_.

◆ options()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

run_options& bm::aggregator< BV >::pipeline< Opt >::options ( )

inline

Set pipeline run options.

Definition at line 232 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::options_.

◆ set_or_target()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

void bm::aggregator< BV >::pipeline< Opt >::set_or_target ( bvector_type * bv_or )

inline

Attach OR (aggregator vector).

Pipeline results all will be OR-ed (UNION) into the OR target vector

Parameters

bv_or - OR target vector

Definition at line 251 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bv_or_target_.

◆ set_search_count_limit()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

void bm::aggregator< BV >::pipeline< Opt >::set_search_count_limit ( size_type limit )

inline

Set search limit for results.

Requires that bit-counting to be enabled in the template parameters. Warning: search limit is approximate (for performance reasons) so it can occasinally find more than requested. It cannot find less.

Parameters

limit - search limit (target population count to search for)

Definition at line 260 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::search_count_limit_.

◆ size()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

size_type bm::aggregator< BV >::pipeline< Opt >::size ( ) const

inline

Return size() of pileine.

Definition at line 272 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::arg_vect_.

◆ unique_vectors()

template<typename BV >

template<class Opt = bm::agg_run_options<>>

size_t bm::aggregator< BV >::pipeline< Opt >::unique_vectors ( ) const

inline

Return number of unique vectors in the pipeline (after complete())

Definition at line 301 of file bmaggregator.h.

References bm::aggregator< BV >::pipeline< Opt >::bcache_, and bm::aggregator< BV >::pipeline_bcache::bv_inp_vect_.

Field Documentation

◆ arg_vect_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

arg_vector_type bm::aggregator< BV >::pipeline< Opt >::arg_vect_

protected

input arg. groups

Definition at line 332 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_args_vector(), and bm::aggregator< BV >::pipeline< Opt >::size().

◆ bcache_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

pipeline_bcache bm::aggregator< BV >::pipeline< Opt >::bcache_

protected

blocks cache structure

Definition at line 338 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_all_input_cnt_vect(), bm::aggregator< BV >::pipeline< Opt >::get_all_input_vect(), bm::aggregator< BV >::pipeline< Opt >::get_bcache(), and bm::aggregator< BV >::pipeline< Opt >::unique_vectors().

◆ bv_or_target_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bvector_type* bm::aggregator< BV >::pipeline< Opt >::bv_or_target_ = 0

protected

OR target bit-bector ptr.

Definition at line 340 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::set_or_target().

◆ bv_res_vect_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bvect_vector_type bm::aggregator< BV >::pipeline< Opt >::bv_res_vect_

protected

results (bit-vector ptrs)

Definition at line 334 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_bv_res_vector().

◆ count_res_vect_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bv_count_vector_type bm::aggregator< BV >::pipeline< Opt >::count_res_vect_

protected

results (counts)

Definition at line 335 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_bv_count_vector().

◆ is_complete_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

bool bm::aggregator< BV >::pipeline< Opt >::is_complete_ = false

protected

ready to run state flag

Definition at line 330 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::is_complete().

◆ options_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

run_options bm::aggregator< BV >::pipeline< Opt >::options_

protected

execution parameters

Definition at line 329 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_options(), and bm::aggregator< BV >::pipeline< Opt >::options().

◆ search_count_limit_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

size_type bm::aggregator< BV >::pipeline< Opt >::search_count_limit_ {bm::id_max}

protected

search limit by count

Definition at line 336 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::set_search_count_limit().

◆ top_blocks_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

unsigned bm::aggregator< BV >::pipeline< Opt >::top_blocks_ = 1

protected

top-level structure size, max of all bvectors

Definition at line 339 of file bmaggregator.h.

Referenced by bm::aggregator< BV >::pipeline< Opt >::get_top_blocks().

◆ total_vect_

template<typename BV >

template<class Opt = bm::agg_run_options<>>

size_t bm::aggregator< BV >::pipeline< Opt >::total_vect_ = 0

protected

total number of vector mentions in all groups

Definition at line 331 of file bmaggregator.h.

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

bmaggregator.h

Public Types

Public Member Functions

access to internals

Detailed Description

Member Function Documentation

◆ add()

◆ complete()

◆ compute_run_batch()

◆ get_all_input_cnt_vect()

◆ get_all_input_vect()

◆ get_args_vector()

◆ get_bcache()

◆ get_bv_count_vector()

◆ get_bv_res_vector()

◆ get_options()

◆ get_top_blocks()

◆ is_complete()

◆ options()

◆ set_or_target()

◆ set_search_count_limit()

◆ size()

◆ unique_vectors()

Field Documentation

◆ arg_vect_

◆ bcache_

◆ bv_or_target_

◆ bv_res_vect_

◆ count_res_vect_

◆ is_complete_

◆ options_

◆ search_count_limit_

◆ top_blocks_

◆ total_vect_