Open Source Documentation

v 1.0

Introduction

This is the main page of the Instigate Open Source project documentation, generated by Doxygen. The source code of these documents is located in the directory src/doc. Doxygen also generates documentation from C/C++ code comments.

C++ Library of Abstract Algebra concepts and arithmetic algorithms defined in terms of these concepts, using Instigate Generic Programming Methodology. Based on this library it's planned to develop Linear Algebra and Optimization concepts and algorithms.

Directory Structure

Source code is organized in following files/directories:

• makefile - the main makefile
• Doxyfile - the Doxygen project file
• mkf/ - auxiliary makefiles
• src/ - the source code directory.

make command should be invoked from project top directory. It will not work if invoked from subdirectories.

After invoking make command, the following directories will be created:

• ./obj/ - contains temporary files generated during build.
• ./bin/ - contains main executable and unit-test executables.
• ./inc/ - contains symbolic links to the origin header files in src sub-directories.

After invoking make docs, the following directories will be created:

• ./doc/
• ./doc/html - contains the generated HTML documentation. The entry page is ./doc/html/index.html