FFTW 3.3.8: Wisdom Export

Chris@82:

int fftw_export_wisdom_to_filename(const char *filename);
Chris@82: void fftw_export_wisdom_to_file(FILE *output_file);
Chris@82: char *fftw_export_wisdom_to_string(void);
Chris@82: void fftw_export_wisdom(void (*write_char)(char c, void *), void *data);
Chris@82:

These functions allow you to export all currently accumulated wisdom Chris@82: in a form from which it can be later imported and restored, even Chris@82: during a separate run of the program. (See Words of Wisdom-Saving Plans.) The current store of wisdom is not affected by calling any Chris@82: of these routines. Chris@82:

fftw_export_wisdom exports the wisdom to any output Chris@82: medium, as specified by the callback function Chris@82: write_char. write_char is a putc-like function that Chris@82: writes the character c to some output; its second parameter is Chris@82: the data pointer passed to fftw_export_wisdom. For Chris@82: convenience, the following three “wrapper” routines are provided: Chris@82:

fftw_export_wisdom_to_filename writes wisdom to a file named Chris@82: filename (which is created or overwritten), returning 1 Chris@82: on success and 0 on failure. A lower-level function, which Chris@82: requires you to open and close the file yourself (e.g. if you want to Chris@82: write wisdom to a portion of a larger file) is Chris@82: fftw_export_wisdom_to_file. This writes the wisdom to the Chris@82: current position in output_file, which should be open with Chris@82: write permission; upon exit, the file remains open and is positioned Chris@82: at the end of the wisdom data. Chris@82:

fftw_export_wisdom_to_string returns a pointer to a Chris@82: NULL-terminated string holding the wisdom data. This string is Chris@82: dynamically allocated, and it is the responsibility of the caller to Chris@82: deallocate it with free when it is no longer needed. Chris@82:

All of these routines export the wisdom in the same format, which we Chris@82: will not document here except to say that it is LISP-like ASCII text Chris@82: that is insensitive to white space. Chris@82:

4.7.1 Wisdom Export