Chris@19: Code conventions used internally by fftw3 (not in API): Chris@19: Chris@19: LEARN FROM THE MASTERS: read Ken Thompson's C compiler in Plan 9. Chris@19: Avoid learning from C++/Java programs. Chris@19: Chris@19: INDENTATION: K&R, 5 spaces/tab. In case of doubt, indent -kr -i5. Chris@19: Chris@19: NAMES: keep them short. Shorter than you think. The Bible was written Chris@19: without vowels. Don't outsmart the Bible. Chris@19: Chris@19: Common names: Chris@19: Chris@19: R : real type, aka fftw_real Chris@19: E : real type for local variables (possibly extra precision) Chris@19: C : complex type Chris@19: sz : size Chris@19: vecsz : vector size Chris@19: is, os : input/output stride Chris@19: ri, ii : real/imag input (complex data) Chris@19: ro, io : real/imag output (complex data) Chris@19: I, O : real input/output (real data) Chris@19: A : assert Chris@19: CK : check Chris@19: S : solver, defined internally to each solver file Chris@19: P : plan, defined internally to each solver file Chris@19: k : codelet Chris@19: X(...) : used for mangling of external names (see below) Chris@19: K(...) : floating-point constant, in E precision Chris@19: Chris@19: If a name is used often and must have the form fftw_foo to avoid Chris@19: namespace pollution, #define FOO fftw_foo and use the short name. Chris@19: Chris@19: Leave that hungarian crap to MS. foo_t counts as hungarian: use Chris@19: foo instead. foo is lowercase so that it does not look like a DOS Chris@19: program. Exception: typedef struct foo_s {...} foo; instead of Chris@19: typedef struct foo {...} foo; for C++ compatibility. Chris@19: Chris@19: NAME MANGLING: use X(foo) for external names instead of fftw_foo. Chris@19: X(foo) expands to fftwf_foo or fftw_foo, depending on the Chris@19: precision. (Unfortunately, this is a ugly form of hungarian Chris@19: notation. Grrr...) Names that are not exported do not need to be Chris@19: mangled. Chris@19: Chris@19: REPEATED CODE: favor a table. E.g., do not write Chris@19: Chris@19: foo("xxx", 1); Chris@19: foo("yyy", 2); Chris@19: foo("zzz", -1); Chris@19: Chris@19: Instead write Chris@19: Chris@19: struct { const char *nam, int arg } footab[] = { Chris@19: { "xxx", 1 }, Chris@19: { "yyy", 2 }, Chris@19: { "zzz", -1 } Chris@19: }; Chris@19: Chris@19: and loop over footab. Rationale: it saves code space. Chris@19: Similarly, replace a switch statement with a table whenever Chris@19: possible. Chris@19: Chris@19: C++: The code should compile as a C++ program. Run the code through Chris@19: gcc -xc++ . The extra C++ restrictions are unnecessary, of Chris@19: course, but this will save us from a flood of complaints when Chris@19: we release the code.