Structure

The PROLEAD project is organized into multiple main directories, each serving a distinct purpose. The codebase is divided into hardware and software directories for both PROLEAD and PROLEAD_SW. However, because there is a shared codebase between PROLEAD and PROLEAD_SW, the files that are used by both tools are consolidated in a separate util directory. The overall structure is as follows:

Headers

All header files (.hpp) encompassing the function declarations are located in the inc directory.

Sources

All source files (.cpp) encompassing the function definitions are located in the src directory.

Test Cases

All test cases are organized within the tests directory. We distinguish between unit tests and end-to-end tests, with the latter being stored in the full subdirectory.

Benchmarks

We provide benchmarks of selected time-critial functions in the benchmarks directory.

Examples

We provide example evaluations conducted during our research in the examples directory.

Documentation

To gain a thorough understanding of the codebase, please refer to the complete documentation available in the docs directory. You can also access it online here.