QFFTW3 Class Reference

Base class for FFTW3 classes. More...

Inheritance diagram for QFFTW3:

Public Member Functions
	QFFTW3 ()
	ctor loads the wisdom singleton. More...
virtual	~QFFTW3 ()
	dtor does nothing. More...
bool	ExportWisdomToFile (const char *outFile)
	Save the accumulated wisdom to file. More...
bool	ImportWisdomFromFile (const char *inFile)
	Load wisdom from file. More...
bool	ImportSystemWisdom ()
	Load wisdom from a system file. More...
bool	ForgetWisdom (void)
	Forget any accumulated wisdom. More...
	ClassDef (QFFTW3, 0)

Detailed Description

Base class for FFTW3 classes.

Author

J. Ouellet

Sole purpoes is to make sure that the singleton class is instantiated, but it is difficult to inherit from a singleton class.

See also

QFFTW3Wisdom.

Definition at line 130 of file QFFTW3.hh.

Constructor & Destructor Documentation

QFFTW3()

QFFTW3::QFFTW3 ( )

inline

ctor loads the wisdom singleton.

Definition at line 137 of file QFFTW3.hh.

References QFFTW3Wisdom::Get().

~QFFTW3()

virtual QFFTW3::~QFFTW3 ( )

inlinevirtual

dtor does nothing.

Definition at line 142 of file QFFTW3.hh.

Member Function Documentation

ClassDef()

QFFTW3::ClassDef	(	QFFTW3	,
		0
	)

ExportWisdomToFile()

bool QFFTW3::ExportWisdomToFile ( const char *  outFile )

inline

Save the accumulated wisdom to file.

Export ALL accumulated wisdom to a file.

Definition at line 148 of file QFFTW3.hh.

References Get().

ForgetWisdom()

bool QFFTW3::ForgetWisdom ( void  )

inline

Forget any accumulated wisdom.

Discard any wisdom accumulated by the program. Frees any allocated memory.

Definition at line 175 of file QFFTW3.hh.

References Get().

ImportSystemWisdom()

bool QFFTW3::ImportSystemWisdom ( )

inline

Load wisdom from a system file.

Import the wisdom saved in a system file (e.g. /etc/fftw/wisdom). This replaces ALL wisdom accumulated by the program.

Definition at line 167 of file QFFTW3.hh.

References Get().

ImportWisdomFromFile()

bool QFFTW3::ImportWisdomFromFile ( const char *  inFile )

inline

Load wisdom from file.

Import the wisdom saved in the file. This replaces ALL wisdom accumulated by the program.

Definition at line 157 of file QFFTW3.hh.

References Get().

---

The documentation for this class was generated from the following file:

• pkg/mathtools/QFFTW3.hh