Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages

Module which implements iterators over search parameter spaces. More...

Prototypes

WeaveSearchIterator * XLALWeaveMainLoopSearchIteratorCreate (const LatticeTiling *semi_tiling, const UINT4 freq_partitions, const UINT4 f1dot_partitions)
 Create iterator over the main loop search parameter space. More...
 
void XLALWeaveSearchIteratorDestroy (WeaveSearchIterator *itr)
 Destroy iterator. More...
 
int XLALWeaveSearchIteratorSave (const WeaveSearchIterator *itr, FITSFile *file)
 Save state of iterator to a FITS file. More...
 
int XLALWeaveSearchIteratorRestore (WeaveSearchIterator *itr, FITSFile *file)
 Restore state of iterator from a FITS file. More...
 
int XLALWeaveSearchIteratorNext (WeaveSearchIterator *itr, BOOLEAN *iteration_complete, BOOLEAN *expire_cache, UINT8 *semi_index, const gsl_vector **semi_rssky, INT4 *semi_left, INT4 *semi_right, UINT4 *repetition_index)
 Advance to next state of iterator. More...
 
REAL8 XLALWeaveSearchIteratorProgress (const WeaveSearchIterator *itr)
 Return progress of iterator as a percentage. More...
 
REAL8 XLALWeaveSearchIteratorRemainingTime (const WeaveSearchIterator *itr, const REAL8 elapsed_time)
 Return estimate of time remaining for iteration to complete, assuming a equal dstribution in computation cost over time. More...
 

Detailed Description

Module which implements iterators over search parameter spaces.

Definition in file SearchIteration.h.

Go to the source code of this file.

Function Documentation

◆ XLALWeaveMainLoopSearchIteratorCreate()

WeaveSearchIterator * XLALWeaveMainLoopSearchIteratorCreate ( const LatticeTiling *  semi_tiling,
const UINT4  freq_partitions,
const UINT4  f1dot_partitions 
)

Create iterator over the main loop search parameter space.

Definition at line 60 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorDestroy()

void XLALWeaveSearchIteratorDestroy ( WeaveSearchIterator *  itr)

Destroy iterator.

Definition at line 117 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorSave()

int XLALWeaveSearchIteratorSave ( const WeaveSearchIterator *  itr,
FITSFile file 
)

Save state of iterator to a FITS file.

Definition at line 131 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorRestore()

int XLALWeaveSearchIteratorRestore ( WeaveSearchIterator *  itr,
FITSFile file 
)

Restore state of iterator from a FITS file.

Definition at line 160 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorNext()

int XLALWeaveSearchIteratorNext ( WeaveSearchIterator *  itr,
BOOLEAN iteration_complete,
BOOLEAN expire_cache,
UINT8 semi_index,
const gsl_vector **  semi_rssky,
INT4 semi_left,
INT4 semi_right,
UINT4 repetition_index 
)

Advance to next state of iterator.

Definition at line 192 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorProgress()

REAL8 XLALWeaveSearchIteratorProgress ( const WeaveSearchIterator *  itr)

Return progress of iterator as a percentage.

Definition at line 281 of file SearchIteration.c.

◆ XLALWeaveSearchIteratorRemainingTime()

REAL8 XLALWeaveSearchIteratorRemainingTime ( const WeaveSearchIterator *  itr,
const REAL8  elapsed_time 
)

Return estimate of time remaining for iteration to complete, assuming a equal dstribution in computation cost over time.

Definition at line 298 of file SearchIteration.c.