Module which collects search timings and builds a timing model. More...

Prototypes
WeaveSearchTiming *	XLALWeaveSearchTimingCreate (const BOOLEAN detailed_timing, const WeaveStatisticsParams *statistics_params)
	Create a search timing structure. More...

void	XLALWeaveSearchTimingDestroy (WeaveSearchTiming *tim)
	Destroy a search timing structure. More...

int	XLALWeaveSearchTimingStart (WeaveSearchTiming *tim)
	Start timing of search. More...

int	XLALWeaveSearchTimingElapsed (WeaveSearchTiming tim, double wall_elapsed, double *cpu_elapsed)
	Return elapsed wall and CPU times since start of search timing. More...

int	XLALWeaveSearchTimingStop (WeaveSearchTiming tim, double wall_total, double *cpu_total)
	Stop timing of search. More...

int	XLALWeaveSearchTimingSection (WeaveSearchTiming *tim, const WeaveSearchTimingSection prev_section, const WeaveSearchTimingSection next_section)
	Change the search section currently being timed. More...

int	XLALWeaveSearchTimingStatistic (WeaveSearchTiming *tim, const WeaveStatisticType prev_statistic, const WeaveStatisticType next_statistic)
	Change the search statistic currently being timed. More...

int	XLALWeaveSearchTimingWriteInfo (FITSFile file, const WeaveSearchTiming tim, const WeaveCacheQueries *queries)
	Write information from search timing to a FITS file. More...

Detailed Description

Module which collects search timings and builds a timing model.

Definition in file SearchTiming.h.

Go to the source code of this file.

Enumerations
enum	tagWeaveSearchTimingSection { WEAVE_SEARCH_TIMING_ITER , WEAVE_SEARCH_TIMING_QUERY , WEAVE_SEARCH_TIMING_COH , WEAVE_SEARCH_TIMING_SEMISEG , WEAVE_SEARCH_TIMING_SEMI , WEAVE_SEARCH_TIMING_OUTPUT , WEAVE_SEARCH_TIMING_CKPT , WEAVE_SEARCH_TIMING_CMPL , WEAVE_SEARCH_TIMING_OTHER , WEAVE_SEARCH_TIMING_MAX }
	Search sections which are timed individually. More...

Enumeration Type Documentation

◆ tagWeaveSearchTimingSection

enum tagWeaveSearchTimingSection

Search sections which are timed individually.

Enumerator
WEAVE_SEARCH_TIMING_ITER	Parameter space iteration section.
WEAVE_SEARCH_TIMING_QUERY	Cache queries section.
WEAVE_SEARCH_TIMING_COH	Computation of coherent results section.
WEAVE_SEARCH_TIMING_SEMISEG	Computation of per-segment semicoherent results section.
WEAVE_SEARCH_TIMING_SEMI	Computation of semicoherent results section.
WEAVE_SEARCH_TIMING_OUTPUT	Result output section.
WEAVE_SEARCH_TIMING_CKPT	Checkpointing section.
WEAVE_SEARCH_TIMING_CMPL	Completion-loop section.
WEAVE_SEARCH_TIMING_OTHER	Unaccounted section.
WEAVE_SEARCH_TIMING_MAX

Definition at line 40 of file SearchTiming.h.

Function Documentation

◆ XLALWeaveSearchTimingCreate()

WeaveSearchTiming* XLALWeaveSearchTimingCreate	(	const BOOLEAN	detailed_timing,
		const WeaveStatisticsParams *	statistics_params
	)

Create a search timing structure.

Definition at line 140 of file SearchTiming.c.

◆ XLALWeaveSearchTimingDestroy()

void XLALWeaveSearchTimingDestroy ( WeaveSearchTiming * tim )

Destroy a search timing structure.

Definition at line 163 of file SearchTiming.c.

◆ XLALWeaveSearchTimingStart()

int XLALWeaveSearchTimingStart ( WeaveSearchTiming * tim )

Start timing of search.

Definition at line 175 of file SearchTiming.c.

◆ XLALWeaveSearchTimingElapsed()

int XLALWeaveSearchTimingElapsed	(	WeaveSearchTiming *	tim,
		double *	wall_elapsed,
		double *	cpu_elapsed
	)

Return elapsed wall and CPU times since start of search timing.

Definition at line 212 of file SearchTiming.c.

◆ XLALWeaveSearchTimingStop()

int XLALWeaveSearchTimingStop	(	WeaveSearchTiming *	tim,
		double *	wall_total,
		double *	cpu_total
	)

Stop timing of search.

Definition at line 242 of file SearchTiming.c.

◆ XLALWeaveSearchTimingSection()

int XLALWeaveSearchTimingSection	(	WeaveSearchTiming *	tim,
		const WeaveSearchTimingSection	prev_section,
		const WeaveSearchTimingSection	next_section
	)

Change the search section currently being timed.

Definition at line 286 of file SearchTiming.c.

◆ XLALWeaveSearchTimingStatistic()

int XLALWeaveSearchTimingStatistic	(	WeaveSearchTiming *	tim,
		const WeaveStatisticType	prev_statistic,
		const WeaveStatisticType	next_statistic
	)

Change the search statistic currently being timed.

Definition at line 322 of file SearchTiming.c.

◆ XLALWeaveSearchTimingWriteInfo()

int XLALWeaveSearchTimingWriteInfo	(	FITSFile *	file,
		const WeaveSearchTiming *	tim,
		const WeaveCacheQueries *	queries
	)

Write information from search timing to a FITS file.

Definition at line 360 of file SearchTiming.c.

Prototypes