FFTW 3.3.8: Wisdom Export

cannam@167:

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

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

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

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

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

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

4.7.1 Wisdom Export