KaMPIng Documentation Overview

This is KaMPIng [kampɪŋ], a (near) zero-overhead MPI wrapper for modern C++.

It covers the whole range of abstraction levels from low-level MPI calls to convenient STL-style bindings, where most parameters are inferred from a small subset of the full parameter set. This allows for both rapid prototyping and fine-tuning of distributed code with predictable runtime behavior and memory management.

Using template-metaprogramming, only code paths required for computing parameters not provided by the user are generated at compile time, which results in (near) zero-overhead bindings.

KaMPIng is developed at the Algorithm Engineering Group at Karlsruhe Institute of Technology.

First Example: (All)gathering an std::vector

#include "kamping/communicator.hpp"
#include "kamping/collectives/allgather.hpp"
 
kamping::Environment e;
kamping::Communicator comm;
 
std::vector<int> input(comm.rank(), comm.rank_signed());
auto const result = comm.allgatherv(send_buf(input));

See allgatherv_example.cpp and the other files in examples directory for more details.

Overview and Design

• Passing Parameters in KaMPIng

Functionality

• Environment
• Communicator
• Point-to-Point communcation
• Collectives
• Named Parameters
• Utility
• MPI Utility

Dependencies

• Building this documentation requires Doxygen 1.10.0.

Guidelines

• Coding Guidelines
• Documentation Guidelines
• Testing Guidelines
• Contributing to KaMPIng