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
Prototypes | Data Structures
CrossCorrToplist.h File Reference

Prototypes

int create_crossCorr_toplist (toplist_t **list, UINT8 length)
 creates a toplist with length elements, returns -1 on error (usually out of memory), else 0 More...
 
int create_crossCorrBinary_toplist (toplist_t **list, UINT8 length)
 
void free_crossCorr_toplist (toplist_t **list)
 frees the space occupied by the toplist More...
 
int insert_into_crossCorr_toplist (toplist_t *list, CrossCorrOutputEntry line)
 Inserts an element in to the toplist either if there is space left or the element is larger than the smallest element in the toplist. More...
 
int insert_into_crossCorrBinary_toplist (toplist_t *list, CrossCorrBinaryOutputEntry line)
 
int write_crossCorr_toplist_to_fp (toplist_t *list, FILE *fp, UINT4 *checksum)
 Writes the toplist to an (already open) filepointer Returns the number of written charactes sets the checksum if non-NULL Returns something <0 on error. More...
 
int write_crossCorrBinary_toplist_to_fp (toplist_t *list, FILE *fp, UINT4 *checksum)
 
void sort_crossCorr_toplist (toplist_t *list)
 reads a (created!) toplist from an open filepointer sets the checksum if non-NULL reads maximum maxbytes, all that is there if maxbytes is 0 returns the number of bytes read, 0 if we found a DONE marker at the end, -1 if the file contained a syntax error, -2 if given an improper toplist More...
 
void sort_crossCorrBinary_toplist (toplist_t *list)
 
int write_crossCorr_toplist_item_to_fp (CrossCorrOutputEntry line, FILE *fp, UINT4 *checksum)
 File IO. More...
 
int write_crossCorrBinary_toplist_item_to_fp (CrossCorrBinaryOutputEntry line, FILE *fp, UINT4 *checksum)
 
int atomic_write_crossCorr_toplist_to_file (toplist_t *list, const char *filename, UINT4 *checksum)
 writes the given toplitst to a temporary file, then renames the temporary file to filename. More...
 
int atomic_write_crossCorrBinary_toplist_to_file (toplist_t *list, const char *filename, UINT4 *checksum)
 
int final_write_crossCorr_toplist_to_file (toplist_t *list, const char *filename, UINT4 *checksum)
 meant for the final writing of the toplist More...
 
int final_write_crossCorrBinary_toplist_to_file (toplist_t *list, const char *filename, UINT4 *checksum)
 
int write_cc_checkpoint (const char *filename, toplist_t *tl, UINT4 counter, BOOLEAN do_sync)
 writes a checkpoint: More...
 
int read_cc_checkpoint (const char *filename, toplist_t *tl, UINT4 *counter)
 tries to read a checkpoint More...
 
int write_cc_output (const char *filename, toplist_t *tl)
 write the final output file: More...
 

Go to the source code of this file.

Data Structures

struct  CrossCorrOutputEntry
 Type to hold the fields that will be kept in a "toplist"
More...
 
struct  CrossCorrBinaryOutputEntry
 Type to hold the fields that will be kept in a "toplist" – for a directed binary search. More...
 

Function Documentation

◆ create_crossCorr_toplist()

int create_crossCorr_toplist ( toplist_t **  list,
UINT8  length 
)

creates a toplist with length elements, returns -1 on error (usually out of memory), else 0

Definition at line 179 of file CrossCorrToplist.c.

◆ create_crossCorrBinary_toplist()

int create_crossCorrBinary_toplist ( toplist_t **  list,
UINT8  length 
)

Definition at line 184 of file CrossCorrToplist.c.

◆ free_crossCorr_toplist()

void free_crossCorr_toplist ( toplist_t **  list)

frees the space occupied by the toplist

Definition at line 191 of file CrossCorrToplist.c.

◆ insert_into_crossCorr_toplist()

int insert_into_crossCorr_toplist ( toplist_t *  list,
CrossCorrOutputEntry  line 
)

Inserts an element in to the toplist either if there is space left or the element is larger than the smallest element in the toplist.

In the latter case, remove the smallest element from the toplist Returns 1 if the element was actually inserted, 0 if not.

Definition at line 202 of file CrossCorrToplist.c.

◆ insert_into_crossCorrBinary_toplist()

int insert_into_crossCorrBinary_toplist ( toplist_t *  list,
CrossCorrBinaryOutputEntry  line 
)

Definition at line 212 of file CrossCorrToplist.c.

◆ write_crossCorr_toplist_to_fp()

int write_crossCorr_toplist_to_fp ( toplist_t *  list,
FILE *  fp,
UINT4 *  checksum 
)

Writes the toplist to an (already open) filepointer Returns the number of written charactes sets the checksum if non-NULL Returns something <0 on error.

Definition at line 640 of file CrossCorrToplist.c.

◆ write_crossCorrBinary_toplist_to_fp()

int write_crossCorrBinary_toplist_to_fp ( toplist_t *  list,
FILE *  fp,
UINT4 *  checksum 
)

Definition at line 662 of file CrossCorrToplist.c.

◆ sort_crossCorr_toplist()

void sort_crossCorr_toplist ( toplist_t *  list)

reads a (created!) toplist from an open filepointer sets the checksum if non-NULL reads maximum maxbytes, all that is there if maxbytes is 0 returns the number of bytes read, 0 if we found a DONE marker at the end, -1 if the file contained a syntax error, -2 if given an improper toplist

sorts the toplist with an internal sorting function, used before finally writing it

Definition at line 225 of file CrossCorrToplist.c.

◆ sort_crossCorrBinary_toplist()

void sort_crossCorrBinary_toplist ( toplist_t *  list)

Definition at line 231 of file CrossCorrToplist.c.

◆ write_crossCorr_toplist_item_to_fp()

int write_crossCorr_toplist_item_to_fp ( CrossCorrOutputEntry  line,
FILE *  fp,
UINT4 *  checksum 
)

File IO.

writes a CrossCorrOutputEntry line to an open filepointer. Returns the number of chars written, -1 if in error Updates checksum if given (i.e. not NULL)

Definition at line 539 of file CrossCorrToplist.c.

◆ write_crossCorrBinary_toplist_item_to_fp()

int write_crossCorrBinary_toplist_item_to_fp ( CrossCorrBinaryOutputEntry  line,
FILE *  fp,
UINT4 *  checksum 
)

Definition at line 561 of file CrossCorrToplist.c.

◆ atomic_write_crossCorr_toplist_to_file()

int atomic_write_crossCorr_toplist_to_file ( toplist_t *  list,
const char *  filename,
UINT4 *  checksum 
)

writes the given toplitst to a temporary file, then renames the temporary file to filename.

The name of the temporary file is derived from the filename by appending ".tmp". Returns the number of chars written or -1 if the temp file could not be opened.

Definition at line 688 of file CrossCorrToplist.c.

◆ atomic_write_crossCorrBinary_toplist_to_file()

int atomic_write_crossCorrBinary_toplist_to_file ( toplist_t *  list,
const char *  filename,
UINT4 *  checksum 
)

Definition at line 693 of file CrossCorrToplist.c.

◆ final_write_crossCorr_toplist_to_file()

int final_write_crossCorr_toplist_to_file ( toplist_t *  list,
const char *  filename,
UINT4 *  checksum 
)

meant for the final writing of the toplist

Definition at line 838 of file CrossCorrToplist.c.

◆ final_write_crossCorrBinary_toplist_to_file()

int final_write_crossCorrBinary_toplist_to_file ( toplist_t *  list,
const char *  filename,
UINT4 *  checksum 
)

Definition at line 846 of file CrossCorrToplist.c.

◆ write_cc_checkpoint()

int write_cc_checkpoint ( const char *  filename,
toplist_t *  tl,
UINT4  counter,
BOOLEAN  do_sync 
)

writes a checkpoint:

  • constructs temporary filename (by appending .TMP)
  • writes number of elements ("elems") in toplist to tempfile
  • dumps data to tempfile
  • appends counter
  • appends checksum (of elems, data and counter)
  • renames tempfile to final name returns -1 in case of an I/O error, -2 if out of memory, 0 otherwise (successful)

Definition at line 880 of file CrossCorrToplist.c.

◆ read_cc_checkpoint()

int read_cc_checkpoint ( const char *  filename,
toplist_t *  tl,
UINT4 *  counter 
)

tries to read a checkpoint

  • tries to open the file, returns 1 if no file found
  • reads elems, data, counter and checksum
  • verifies checksum
  • restores the heap by sorting returns 0 if successfully read a checkpoint 1 if no checkpoint was found -1 in case of an I/O error -2 if the checksum was wrong or elems was unreasonable

Definition at line 992 of file CrossCorrToplist.c.

◆ write_cc_output()

int write_cc_output ( const char *  filename,
toplist_t *  tl 
)

write the final output file:

  • re-sort the toplist into freq/alpha/delta/fdot order
  • write out the toplist in ASCII format with end marker to a temporary file
  • rename the file to the final name

Definition at line 1108 of file CrossCorrToplist.c.