The Aven Graph Library

An "adjacency slice" graph library along with implementations of a few path coloring algorithms for plane graphs.

Code organization

The header-only graph library is contained in the include directory. The majority of the library depends only on a couple files from the simple libaven header-only library, which is a submodule in the deps directory.

The */geometry.h files define functions to construct vector geometry for graph visualization and depend on the headers from libavengl. The libavengl library draws 2D vector graphics using a common subset of the OpenGL 4 and GLES 3 APIs. Thelibavengl library is a submodule in the deps directory. The provided visualization uses GLFW for window creation. The libavengl submodule provides a vendored GLFW, and headers for GLES3, X11, xkbcommon, and Wayland.

Building the project

The project should build with no system dependencies other than a C compiler on most modern Windows or Linux systems. To run the visualization binary you will need graphics drivers that support either OpenGL 4.3 or OpenGL ES 3.2. On Linux/BSD you will also need an X11 or Wayland display server running. Mac/OSX is currently not supported as I don't have an Apple device to test with.

To clone the libaven and libavengl dependencies run:

git submodule init --recursive
git submodule update --recursive

To build the build system:

make

or

cc -o build build.c

where cc is your favorite C compiler that supports C99 or later ¹.

To build the algorithm visualization run:

./build

The resulting visualization executable will be in the build_out directory.

For a release build using clang or gcc run:

  ./build -ccflags "-O3 -ffast-math" -glfw-ccflags "-O3 -DNDEBUG"

Watch mode and hot reloading

To build and run the visualization in "watch mode" you may run:

./build watch

The build system will watch for changes to files in visualization/. If a file in visualization/game/ is modified, then the changes will be compiled into a dynamic library and hot loaded into the running application. If a file in the root of visualization/ is changed, then the application will close, compile, and run.

Tikz drawings

A couple rudimentary programs were written to find and draw algorithm examples as a series of Tikz drawings. To build these exectuables, run:

./build tikz

Benchmarks

To build and run the algorithm benchmarks you will need ~3GB of available system RAM. To benchmark the threaded algorithms your C compiler must support C11 atomics. An example full benchmark run command for gcc or clang on Linux would be:

./build bench -ccflags "-std=c11 -O3 -march=native -DBENCHMARK_THREADED"

The benchmarks may take up to a few hours to complete.

Tests

To build and run the tests:

./build test

Cleaning up

To remove all build artifacts:

./build clean

Online visualization

The visualization compiled with Emscripten is available online.

License

The copyright Aven Bross 2024 and the license provided in LICENSE.MIT apply to each text file that does not contain its own separate license and copyright.

Footnotes

1. Most common C compilers will be configured by default: gcc, clang, and tcc on Linux, and gcc.exe, clang.exe, and cl.exe on Windows should be supported out-of-the-box. Otherwise you will need to define the various flags yourself. Run ./build -h for a full rundown of what needs to be configured, and see cproc_make.sh, emcc_make.sh, zig_make.sh, and zig_make.bat for examples. ↩