Prototypes
WeaveResultsToplist *	XLALWeaveResultsToplistCreate (const size_t nspins, WeaveStatisticsParams statistics_params, const char stat_name, const char *stat_desc, const UINT4 toplist_limit, WeaveResultsToplistRankingStats toplist_rank_stats_fcn, WeaveResultsToplistItemGetRankStat toplist_item_get_rank_stat_fcn, WeaveResultsToplistItemSetRankStat toplist_item_set_rank_stat_fcn)
	Create results toplist. More...

void	XLALWeaveResultsToplistDestroy (WeaveResultsToplist *toplist)
	Free results toplist. More...

int	XLALWeaveResultsToplistAdd (WeaveResultsToplist toplist, const WeaveSemiResults semi_res, const UINT4 semi_nfreqs)
	Add semicoherent results to toplist. More...

int	XLALWeaveResultsToplistCompletionLoop (WeaveResultsToplist *toplist)
	Compute all missing 'extra' (non-toplist-ranking) statistics for all toplist entries. More...

int	XLALWeaveResultsToplistWrite (FITSFile file, const WeaveResultsToplist toplist)
	Write results toplist to a FITS file. More...

int	XLALWeaveResultsToplistReadAppend (FITSFile file, WeaveResultsToplist toplist)
	Read results from a FITS file and append to existing results toplist. More...

int	XLALWeaveResultsToplistCompare (BOOLEAN equal, const WeaveSetupData setup, const BOOLEAN sort_by_semi_phys, const UINT4 round_param_to_dp, const UINT4 round_param_to_sf, const REAL8 unmatched_item_tol, const REAL8 param_tol_mism, const VectorComparison result_tol, const UINT4 toplist_compare_limit, const WeaveResultsToplist toplist_1, const WeaveResultsToplist *toplist_2)
	Compare two results toplists and return whether they are equal. More...

Internal functions
static WeaveResultsToplistItem *	toplist_item_create (const WeaveResultsToplist *toplist)
	Create a toplist item. More...

static int	compare_templates (BOOLEAN equal, const char loc_str, const char tmpl_str, const UINT4 round_param_to_dp, const UINT4 round_param_to_sf, const REAL8 param_tol_mism, const gsl_matrix metric, const SuperskyTransformData rssky_transf, const UINT8 serial_1, const UINT8 serial_2, const PulsarDopplerParams phys_1, const PulsarDopplerParams *phys_2)
	Compute two template parameters. More...

static int	compare_vectors (BOOLEAN equal, const VectorComparison result_tol, const REAL4Vector res_1, const REAL4Vector res_2, const UINT4 r1, const UINT4 r2)
	Compare two vectors of results. More...

static double	round_to_dp_sf (double x, const UINT4 dp, const UINT4 sf)
	Round a floating-point number 'x' to 'dp' decimal places (if > 0), then 'sf' significant figures (if > 0). More...

static int	toplist_fits_table_init (FITSFile file, const WeaveResultsToplist toplist)
	Initialise a FITS table for writing/reading a toplist. More...

static int	toplist_fits_table_write_visitor (void param, const void x)
	Visitor function for writing a toplist to a FITS table. More...

static int	toplist_item_sort_by_semi_phys (const void x, const void y)
	Sort toplist items by physical coordinates of semicoherent template. More...

static int	toplist_item_sort_by_serial (const void x, const void y)
	Sort toplist items by serial number of template. More...

static void	toplist_item_destroy (WeaveResultsToplistItem *item)
	Destroy a toplist item. More...

static int	toplist_item_compare (void param, const void x, const void *y)
	Compare toplist items. More...

static int	toplist_fill_completionloop_stats (void param, void x)
	Function to update given toplist item with missing 'completion loop' statistics. More...

Data Structures
struct	WeaveResultsToplist
	Toplist of output results. More...

Macros
#define	COMPARE_BY(x, y) do { if ( (x) < (y) ) return -1; if ( (x) > (y) ) return +1; } while(0)

Macro Definition Documentation

◆ COMPARE_BY

#define COMPARE_BY	(	x,
		y
	)	do { if ( (x) < (y) ) return -1; if ( (x) > (y) ) return +1; } while(0)

Definition at line 32 of file ResultsToplist.c.

Function Documentation

◆ toplist_item_create()

WeaveResultsToplistItem * toplist_item_create ( const WeaveResultsToplist * toplist )

static

Create a toplist item.

Definition at line 107 of file ResultsToplist.c.

◆ compare_templates()

int compare_templates	(	BOOLEAN *	equal,
		const char *	loc_str,
		const char *	tmpl_str,
		const UINT4	round_param_to_dp,
		const UINT4	round_param_to_sf,
		const REAL8	param_tol_mism,
		const gsl_matrix *	metric,
		const SuperskyTransformData *	rssky_transf,
		const UINT8	serial_1,
		const UINT8	serial_2,
		const PulsarDopplerParams *	phys_1,
		const PulsarDopplerParams *	phys_2
	)

static

Compute two template parameters.

Definition at line 527 of file ResultsToplist.c.

◆ compare_vectors()

int compare_vectors	(	BOOLEAN *	equal,
		const VectorComparison *	result_tol,
		const REAL4Vector *	res_1,
		const REAL4Vector *	res_2,
		const UINT4	r1,
		const UINT4	r2
	)

static

Compare two vectors of results.

Definition at line 632 of file ResultsToplist.c.

◆ round_to_dp_sf()

static double round_to_dp_sf	(	double	x,
		const UINT4	dp,
		const UINT4	sf
	)

static

Round a floating-point number 'x' to 'dp' decimal places (if > 0), then 'sf' significant figures (if > 0).

Definition at line 86 of file ResultsToplist.c.

◆ toplist_fits_table_init()

int toplist_fits_table_init	(	FITSFile *	file,
		const WeaveResultsToplist *	toplist
	)

static

Initialise a FITS table for writing/reading a toplist.

Definition at line 200 of file ResultsToplist.c.

◆ toplist_fits_table_write_visitor()

int toplist_fits_table_write_visitor	(	void *	param,
		const void *	x
	)

static

Visitor function for writing a toplist to a FITS table.

Definition at line 478 of file ResultsToplist.c.

◆ toplist_item_sort_by_semi_phys()

int toplist_item_sort_by_semi_phys	(	const void *	x,
		const void *	y
	)

static

Sort toplist items by physical coordinates of semicoherent template.

For stable comparisons, the order of parameter comparisons should be the same as the order in which parameters are generated by the search lattice tiling.

Definition at line 494 of file ResultsToplist.c.

◆ toplist_item_sort_by_serial()

int toplist_item_sort_by_serial	(	const void *	x,
		const void *	y
	)

static

Sort toplist items by serial number of template.

Definition at line 513 of file ResultsToplist.c.

◆ toplist_item_destroy()

void toplist_item_destroy ( WeaveResultsToplistItem * item )

static

Destroy a toplist item.

Definition at line 161 of file ResultsToplist.c.

◆ toplist_item_compare()

int toplist_item_compare	(	void *	param,
		const void *	x,
		const void *	y
	)

static

Compare toplist items.

Definition at line 184 of file ResultsToplist.c.

◆ toplist_fill_completionloop_stats()

int toplist_fill_completionloop_stats	(	void *	param,
		void *	x
	)

static

Function to update given toplist item with missing 'completion loop' statistics.

Definition at line 348 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistCreate()

WeaveResultsToplist * XLALWeaveResultsToplistCreate	(	const size_t	nspins,
		WeaveStatisticsParams *	statistics_params,
		const char *	stat_name,
		const char *	stat_desc,
		const UINT4	toplist_limit,
		WeaveResultsToplistRankingStats	toplist_rank_stats_fcn,
		WeaveResultsToplistItemGetRankStat	toplist_item_get_rank_stat_fcn,
		WeaveResultsToplistItemSetRankStat	toplist_item_set_rank_stat_fcn
	)

Create results toplist.

Definition at line 659 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistDestroy()

void XLALWeaveResultsToplistDestroy ( WeaveResultsToplist * toplist )

Free results toplist.

Definition at line 700 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistAdd()

int XLALWeaveResultsToplistAdd	(	WeaveResultsToplist *	toplist,
		const WeaveSemiResults *	semi_res,
		const UINT4	semi_nfreqs
	)

Add semicoherent results to toplist.

Definition at line 715 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistCompletionLoop()

int XLALWeaveResultsToplistCompletionLoop ( WeaveResultsToplist * toplist )

Compute all missing 'extra' (non-toplist-ranking) statistics for all toplist entries.

Definition at line 863 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistWrite()

int XLALWeaveResultsToplistWrite	(	FITSFile *	file,
		const WeaveResultsToplist *	toplist
	)

Write results toplist to a FITS file.

Definition at line 880 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistReadAppend()

int XLALWeaveResultsToplistReadAppend	(	FITSFile *	file,
		WeaveResultsToplist *	toplist
	)

Read results from a FITS file and append to existing results toplist.

Definition at line 913 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistCompare()

int XLALWeaveResultsToplistCompare	(	BOOLEAN *	equal,
		const WeaveSetupData *	setup,
		const BOOLEAN	sort_by_semi_phys,
		const UINT4	round_param_to_dp,
		const UINT4	round_param_to_sf,
		const REAL8	unmatched_item_tol,
		const REAL8	param_tol_mism,
		const VectorComparison *	result_tol,
		const UINT4	toplist_compare_limit,
		const WeaveResultsToplist *	toplist_1,
		const WeaveResultsToplist *	toplist_2
	)

Compare two results toplists and return whether they are equal.

Definition at line 964 of file ResultsToplist.c.

Prototypes

Data Structures

Macros

Macro Definition Documentation

◆ COMPARE_BY

Function Documentation

◆ toplist_item_create()

◆ compare_templates()

◆ compare_vectors()

◆ round_to_dp_sf()

◆ toplist_fits_table_init()

◆ toplist_fits_table_write_visitor()

◆ toplist_item_sort_by_semi_phys()

◆ toplist_item_sort_by_serial()

◆ toplist_item_destroy()

◆ toplist_item_compare()

◆ toplist_fill_completionloop_stats()

◆ XLALWeaveResultsToplistCreate()

◆ XLALWeaveResultsToplistDestroy()

◆ XLALWeaveResultsToplistAdd()

◆ XLALWeaveResultsToplistCompletionLoop()

◆ XLALWeaveResultsToplistWrite()

◆ XLALWeaveResultsToplistReadAppend()

◆ XLALWeaveResultsToplistCompare()