OOP-Projekt 384

von Meiko Settmacher, Maximilian Barthel, Ferdinand Rau

Installation

See INSTALLATION for detailed instructions on how to install the library on Linux, macOS, and Windows.

Quick Start

After installation, you can include the library in your CMake project like this:

find_package(GraphLib REQUIRED)
 
target_link_libraries(your_target PRIVATE GraphLib)

Example Usage

In your CMakeLists.txt:

cmake_minimum_required(VERSION 3.20)
project(MyUserProject LANGUAGES CXX)
 
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_EXTENSIONS OFF)
 
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
find_package(GraphLib REQUIRED)
 
add_executable(main src/main.cpp)
target_link_libraries(main PRIVATE GraphLib)

and then in src/main.cpp:

#include <GraphLib/graphs.h> // For the Graph Classes
#include <GraphLib/algorithms/bfs.h> // For the Algorithms (change bfs to the Algorithm you need)
 
int main() {
    GraphLib::WeightedDirectedGraph my_graph {};
    // ...
}

Check out the examples folder for code samples demonstrating how to use the library features.

Development

For Development Information please see DEVELOPMENT

Documentation

Disclaimer: The Code Comments (and therefore the Descriptions in the Documenation), are for the most part by generative AI (GPT-4o-mini)

The API Documentation is generated by doxygen and available here.

You can optionally build the Documentation yourself using Doxygen

Latex/ Pdf Documentation

If you wish to create a PDF Documentaion you will need a Latex Compiler and some tool like pdflatex installed on your system.

Change GENERATE_LATEX = NO to GENERATE_LATEX = YES in the Doxyfile, rebuild with doxygen from the project root and go into doc/latex and run make pdf.

This should result in a file called refman.pdf.