CAPD DynSys Library 5.2.0
Useful information

Naming convention

We use CamelCase convention for names (compound words or phases are joined (without underscope) with each element's initial letter capitalized within the compound and the first letter either upper or lower case) e.g. PoincareMap, SetWithCoordinates, generateFunction.

  • Class names start with capital letter.
  • Function names start with lower case letter.
  • Class AAA from module XXX is contained in the namespace capd::XXX and is declared in header file include/capd/XXX/AAA.h of a given package. Definitions can be found in src/capd/XXX/AAA.cpp in case of ordinary classes or in include/capd/XXX/AAA.hpp in the case of template classes.

Headers

In your programs always give path relative to some 'include' directory e.g. to include file capd/capdAlg/include/capd/intervals/Interval.h use

#include "capd/intervals/Interval.h"

In case of template classes if concretization is already compiled into the CAPD library then it is enough to include header file with .h extension. This speeds up compilation. But if you want to use non standard template parameters or you are not sure if given type is in CAPD library then you should include corresponding header file with .hpp extension and given class will be recompiled every time you compile your program.