LALPulsar 7.1.1.1-eeff03c
Prototypes | Data Structures
HoughFstatToplist.h File Reference

Prototypes

int create_houghFstat_toplist (toplist_t **list, UINT8 length)
 creates a toplist with length elements, returns -1 on error (usually out of memory), else 0 More...
 
void free_houghFstat_toplist (toplist_t **list)
 frees the space occupied by the toplist More...
 
int insert_into_houghFstat_toplist (toplist_t *list, HoughFstatOutputEntry 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 write_houghFstat_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 read_houghFstat_toplist_from_fp (toplist_t *list, FILE *fp, UINT4 *checksum, UINT4 maxbytes)
 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_houghFstat_toplist (toplist_t *list)
 sorts the toplist with an internal sorting function, used before finally writing it More...
 
int write_houghFstat_toplist_item_to_fp (HoughFstatOutputEntry line, FILE *fp, UINT4 *checksum)
 File IO. More...
 
int atomic_write_houghFstat_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 final_write_houghFstat_toplist_to_file (toplist_t *list, const char *filename, UINT4 *checksum)
 meant for the final writing of the toplist More...
 
int write_hfs_checkpoint (const char *filename, toplist_t *tl, UINT4 counter, BOOLEAN do_sync)
 new, simpler checkpointing for HierarchicalSearch More...
 
int read_hfs_checkpoint (const char *filename, toplist_t *tl, UINT4 *counter)
 tries to read a checkpoint More...
 
int write_hfs_oputput (const char *filename, toplist_t *tl)
 write the final output file: More...
 

Go to the source code of this file.

Data Structures

struct  HoughFstatOutputEntry
 Type to hold the fields that will be kept in a "toplist"
More...
 

Function Documentation

◆ create_houghFstat_toplist()

int create_houghFstat_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 112 of file HoughFstatToplist.c.

◆ free_houghFstat_toplist()

void free_houghFstat_toplist ( toplist_t **  list)

frees the space occupied by the toplist

Definition at line 119 of file HoughFstatToplist.c.

◆ insert_into_houghFstat_toplist()

int insert_into_houghFstat_toplist ( toplist_t *  list,
HoughFstatOutputEntry  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 141 of file HoughFstatToplist.c.

◆ write_houghFstat_toplist_to_fp()

int write_houghFstat_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 390 of file HoughFstatToplist.c.

◆ read_houghFstat_toplist_from_fp()

int read_houghFstat_toplist_from_fp ( toplist_t *  list,
FILE *  fp,
UINT4 *  checksum,
UINT4  maxbytes 
)

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

Definition at line 163 of file HoughFstatToplist.c.

◆ sort_houghFstat_toplist()

void sort_houghFstat_toplist ( toplist_t *  list)

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

Definition at line 152 of file HoughFstatToplist.c.

◆ write_houghFstat_toplist_item_to_fp()

int write_houghFstat_toplist_item_to_fp ( HoughFstatOutputEntry  line,
FILE *  fp,
UINT4 *  checksum 
)

File IO.

writes an HoughFstatOutputEntry 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 341 of file HoughFstatToplist.c.

◆ atomic_write_houghFstat_toplist_to_file()

int atomic_write_houghFstat_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 416 of file HoughFstatToplist.c.

◆ final_write_houghFstat_toplist_to_file()

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

meant for the final writing of the toplist

Definition at line 494 of file HoughFstatToplist.c.

◆ write_hfs_checkpoint()

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

new, simpler checkpointing for HierarchicalSearch

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 530 of file HoughFstatToplist.c.

◆ read_hfs_checkpoint()

int read_hfs_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 642 of file HoughFstatToplist.c.

◆ write_hfs_oputput()

int write_hfs_oputput ( 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 1284 of file GCTtoplist.c.