Detailed Description

Toplist of output results.

Definition at line 37 of file ResultsToplist.c.

Data Fields
WeaveStatisticsParams *	statistics_params
	Struct holding all parameters for which statistics to output and compute, when, and how NOTE: this is only a reference-pointer to WeaveStatisticsParams, while WeaveSemiResults is the owner More...

size_t	nspins
	Number of spindown parameters to output. More...

const char *	stat_name
	Name of ranking statistic. More...

const char *	stat_desc
	Description of ranking statistic. More...

WeaveResultsToplistRankingStats	rank_stats_fcn
	Function which returns pointer to array of statistics by which toplist items are ranked. More...

WeaveResultsToplistItemGetRankStat	item_get_rank_stat_fcn
	Function which returns the value of the statistic by which toplist items are ranked. More...

WeaveResultsToplistItemSetRankStat	item_set_rank_stat_fcn
	Function which sets the value of the statistic by which toplist items are ranked. More...

UINT4Vector *	maybe_add_freq_idxs
	Vector of indexes of toplist results which should be considered for addition. More...

UINT8	serial
	Serial number which is incremented for each item. More...

LALHeap *	heap
	Heap which ranks toplist items. More...

WeaveResultsToplistItem *	saved_item
	Save a no-longer-used toplist item for re-use. More...

Field Documentation

◆ statistics_params

WeaveStatisticsParams* WeaveResultsToplist::statistics_params

Struct holding all parameters for which statistics to output and compute, when, and how NOTE: this is only a reference-pointer to WeaveStatisticsParams, while WeaveSemiResults is the owner

Definition at line 40 of file ResultsToplist.c.

◆ nspins

size_t WeaveResultsToplist::nspins

Number of spindown parameters to output.

Definition at line 42 of file ResultsToplist.c.

◆ stat_name

const char* WeaveResultsToplist::stat_name

Name of ranking statistic.

Definition at line 44 of file ResultsToplist.c.

◆ stat_desc

const char* WeaveResultsToplist::stat_desc

Description of ranking statistic.

Definition at line 46 of file ResultsToplist.c.

◆ rank_stats_fcn

WeaveResultsToplistRankingStats WeaveResultsToplist::rank_stats_fcn

Function which returns pointer to array of statistics by which toplist items are ranked.

Definition at line 48 of file ResultsToplist.c.

◆ item_get_rank_stat_fcn

WeaveResultsToplistItemGetRankStat WeaveResultsToplist::item_get_rank_stat_fcn

Function which returns the value of the statistic by which toplist items are ranked.

Definition at line 50 of file ResultsToplist.c.

◆ item_set_rank_stat_fcn

WeaveResultsToplistItemSetRankStat WeaveResultsToplist::item_set_rank_stat_fcn

Function which sets the value of the statistic by which toplist items are ranked.

Definition at line 52 of file ResultsToplist.c.

◆ maybe_add_freq_idxs

UINT4Vector* WeaveResultsToplist::maybe_add_freq_idxs

Vector of indexes of toplist results which should be considered for addition.

Definition at line 54 of file ResultsToplist.c.

◆ serial

UINT8 WeaveResultsToplist::serial

Serial number which is incremented for each item.

Definition at line 56 of file ResultsToplist.c.

◆ heap

LALHeap* WeaveResultsToplist::heap

Heap which ranks toplist items.

Definition at line 58 of file ResultsToplist.c.

◆ saved_item

WeaveResultsToplistItem* WeaveResultsToplist::saved_item

Save a no-longer-used toplist item for re-use.

Definition at line 60 of file ResultsToplist.c.