Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
creating-modules.md 2.37 KiB

Creating modules {#creating-modules}

\author Zakaria Kasmi

Well-defined units of code in the RcdMathLib that provide a set of features are encapsulated in a module. RcdMathLib is module-based and composed of the following main modules:

  • Linear algebra module
  • Non-Linear algebra module
  • Localization module

Each main module includes sub-modules, for more details see @ref structure "The structure of the RcdMathLib".

@note The following chapters concerning only resource-limited devices.

The general structure {#the-general-structure}

Modules are directories containing source and header files as well as a Makefile. Furthermore, their API can be defined in one or more header files, residing in the include path of their super-module.

For example, the matrix sub-module is implemented in the @ref basic_operations sub-module, in the linear_algebra/basic_operations directory. Its API is defined in linear_algebra/basic_operations/matrix.h.