diff --git a/CMakeLists.txt b/CMakeLists.txt index 60c6cd3..38614f5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -19,7 +19,7 @@ cmake_policy(VERSION ${CMAKE_VERSION}) # ############ # Define Project -project(mpi VERSION 1.3.0 LANGUAGES CXX) +project(mpi VERSION 2.0.0 LANGUAGES CXX) get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY) # Get the git hash & print status diff --git a/c++/mpi/chunk.hpp b/c++/mpi/chunk.hpp index 85466cd..dd5b5db 100644 --- a/c++/mpi/chunk.hpp +++ b/c++/mpi/chunk.hpp @@ -32,36 +32,41 @@ namespace mpi { /** - * @ingroup utilities + * @addtogroup utilities + * @{ + */ + + /** * @brief Get the length of the ith subrange after splitting the integer range `[0, end)` as evenly as * possible across `n` subranges. * - * @details The optional parameter `min_size` can be used to first divide the range into equal parts of size + * @details The optional parameter `min_size` can be used to first divide the range into equal parts of size * `min_size` before distributing them as evenly as possible across the number of specified subranges. * * It is expected that `min_size > 0` and that `min_size` is a divisor of `end`. * * @param end End of the integer range `[0, end)`. - * @param nranges Number of subranges. + * @param n Number of subranges. * @param i Index of the subrange of interest. * @param min_size Minimum size of the subranges. * @return Length of the ith subrange. */ - [[nodiscard]] inline long chunk_length(long end, int nranges, int i, long min_size = 1) { + [[nodiscard]] inline long chunk_length(long end, int n, int i, long min_size = 1) { EXPECTS_WITH_MESSAGE(min_size > 0 && end % min_size == 0, "Error in mpi::chunk_length: min_size must be a divisor of end"); - auto [node_begin, node_end] = itertools::chunk_range(0, end / min_size, nranges, i); + auto [node_begin, node_end] = itertools::chunk_range(0, end / min_size, n, i); return (node_end - node_begin) * min_size; } /** - * @ingroup utilities - * @brief Divide a given range as evenly as possible across the MPI processes in a communicator and get the subrange - * assigned to the calling process. + * @brief Divide a given range as evenly as possible across the MPI processes in a communicator. + * + * @details It calculates the subrange assigned to the calling process based on its rank in the given communicator and + * returns it as a slice of the original range. * * @tparam R Range type. * @param rg Range to divide. * @param c mpi::communicator. - * @return An itertools::sliced range assigned to the calling process. + * @return An `itertools::sliced` range assigned to the calling process. */ template [[nodiscard]] auto chunk(R &&rg, communicator c = {}) { auto total_size = itertools::distance(std::cbegin(rg), std::cend(rg)); @@ -69,4 +74,6 @@ namespace mpi { return itertools::slice(std::forward(rg), start_idx, end_idx); } + /** @} */ + } // namespace mpi diff --git a/c++/mpi/communicator.hpp b/c++/mpi/communicator.hpp index 6ce1a72..cbb071f 100644 --- a/c++/mpi/communicator.hpp +++ b/c++/mpi/communicator.hpp @@ -38,12 +38,15 @@ namespace mpi { * @ingroup mpi_essentials * @brief C++ wrapper around `MPI_Comm` providing various convenience functions. * - * @details It stores an `MPI_Comm` object as its only member which by default is set to `MPI_COMM_WORLD`. The - * underlying `MPI_Comm` object is not freed when a communicator goes out of scope. It is the user's responsibility to - * do so, in case it is needed. Note that copying the communicator simply copies the `MPI_Comm` object, without - * calling `MPI_Comm_dup`. - * - * All functions that make direct calls to the MPI C library throw an exception in case the call fails. + * @details It stores an `MPI_Comm` object as its only member which by default is set to `MPI_COMM_WORLD`. + * + * The underlying `MPI_Comm` object is not freed when a communicator goes out of scope. It is the user's + * responsibility to do so, in case it is needed. + * + * All functions that make direct calls to the MPI C API check their success with mpi::check_mpi_call. + * + * @note Copying the communicator simply copies the `MPI_Comm` object, without calling `MPI_Comm_dup`. Use duplicate() + * or split() if a new communicator is needed. */ class communicator { public: @@ -51,8 +54,7 @@ namespace mpi { communicator() = default; /** - * @brief Construct a communicator with a given `MPI_Comm` object. - * @details The `MPI_Comm` object is copied without calling `MPI_Comm_dup`. + * @brief Construct a communicator by wrapping a given `MPI_Comm` object. * @param c `MPI_Comm` object to wrap. */ communicator(MPI_Comm c) : comm_(c) {} diff --git a/c++/mpi/datatypes.hpp b/c++/mpi/datatypes.hpp index 49a6b96..fe2ecd3 100644 --- a/c++/mpi/datatypes.hpp +++ b/c++/mpi/datatypes.hpp @@ -45,7 +45,9 @@ namespace mpi { * @brief Map C++ datatypes to the corresponding MPI datatypes. * * @details C++ types which have a corresponding MPI datatype should specialize this struct. It is assumed that it - * has a static member function `get` which returns the `MPI_Datatype` object for a given C++ type. For example: + * has a static member function `get` which returns the `MPI_Datatype` object for a given C++ type. + * + * For example: * * @code{.cpp} * template <> struct mpi_type { @@ -58,7 +60,7 @@ namespace mpi { template struct mpi_type {}; #define D(T, MPI_TY) \ - /** @brief Specialization of mpi_type for T. */ \ + /** @brief Specialization of mpi_type for `T`. */ \ template <> struct mpi_type { \ [[nodiscard]] static MPI_Datatype get() noexcept { return MPI_TY; } \ } @@ -94,15 +96,10 @@ namespace mpi { /** * @brief Type trait to check if a type `T` has a corresponding MPI datatype, i.e. if mpi::mpi_type has been * specialized. - * @tparam `T` Type to be checked. - */ - template constexpr bool has_mpi_type = false; - - /** - * @brief Specialization of mpi::has_mpi_type for types which have a corresponding MPI datatype. + * * @tparam T Type to be checked. */ - template constexpr bool has_mpi_type::get())>> = true; + template constexpr bool has_mpi_type = requires { mpi_type::get(); }; namespace detail { @@ -132,7 +129,7 @@ namespace mpi { * @details The tuple element types must have corresponding MPI datatypes, i.e. they must have mpi::mpi_type * specializtions. It uses `MPI_Type_create_struct` to create a new datatype consisting of the tuple element types. * - * It throws an exception in case a call to the MPI C library fails. + * The success of MPI calls is checked with mpi::check_mpi_call. * * @tparam Ts Tuple element types. * @param tup Tuple object. @@ -164,7 +161,7 @@ namespace mpi { } /** - * @brief Specialization of mpi::mpi_type for std::tuple. + * @brief Specialization of mpi::mpi_type for `std::tuple`. * @tparam Ts Tuple element types. */ template struct mpi_type> { @@ -177,8 +174,8 @@ namespace mpi { /** * @brief Create an `MPI_Datatype` from some struct. * - * @details It is assumed that there is a free function `tie_data` which returns a tuple containing the data - * members of the given type. The intended use is as a base class for a specialization of mpi::mpi_type: + * @details It is assumed that there is a free function `tie_data` which returns a tuple containing the data members + * of the given type: * * @code{.cpp} * // type to use for MPI communication @@ -234,8 +231,8 @@ namespace mpi { /** * @brief Create an `MPI_Datatype` from a serializable type. * - * @details It is assumed that the type has a member function `serialize` - * which feeds all its class members into an archive using the `operator&`. + * @details It is assumed that the type has a member function `serialize` which feeds all its class members into an + * archive using the `operator&`. * * @code{.cpp} * // type to use for MPI communication @@ -243,6 +240,7 @@ namespace mpi { * double x; * int y; * void serialize(auto& ar) const { ar & x & y; } + * void deserialize(auto& ar) { ar & x & y; } * }; * @endcode * diff --git a/c++/mpi/environment.hpp b/c++/mpi/environment.hpp index a8aa42d..e330ceb 100644 --- a/c++/mpi/environment.hpp +++ b/c++/mpi/environment.hpp @@ -35,21 +35,32 @@ namespace mpi { */ /** - * @brief Check if MPI has been initialized. - * @details It throws an exception in case a call to the MPI C library fails. + * @brief Check if MPI has been initialized by calling `MPI_Initialized`. * @return True if `MPI_Init` has been called, false otherwise. */ [[nodiscard]] inline bool is_initialized() noexcept { int flag = 0; - check_mpi_call(MPI_Initialized(&flag), "MPI_Initialized"); + MPI_Initialized(&flag); return flag; } /** - * @brief Boolean variable that is true, if one of the environment variables `OMPI_COMM_WORLD_RANK`, `PMI_RANK`, - * `CRAY_MPICH_VERSION` or `FORCE_MPI_INIT` is set, false otherwise. + * @brief Check if MPI has been finalized by calling `MPI_Finalized`. + * @return True if `MPI_Finalize` has been called, false otherwise. + */ + [[nodiscard]] inline bool is_finalized() noexcept { + int flag = 0; + MPI_Finalized(&flag); + return flag; + } + + /** + * @brief Boolean variable that checkes if there is an active MPI runtime environment. * - * @details The environment variables are set, when a program is executed with `mpirun` or `mpiexec`. + * @details It is true if one of the environment variables `OMPI_COMM_WORLD_RANK`, `PMI_RANK`, `CRAY_MPICH_VERSION` or + * `FORCE_MPI_INIT` is set, false otherwise. + * + * @note The environment variables are set, when a program is executed with `mpirun` or `mpiexec`. */ static const bool has_env = []() { if (std::getenv("OMPI_COMM_WORLD_RANK") != nullptr or std::getenv("PMI_RANK") != nullptr or std::getenv("CRAY_MPICH_VERSION") != nullptr @@ -64,8 +75,6 @@ namespace mpi { * * @details Calls `MPI_Init` upon construction and `MPI_Finalize` upon destruction i.e. when the environment object * goes out of scope. If mpi::has_env is false, this struct does nothing. - * - * All functions that make direct calls to the MPI C library throw an exception in case the call fails. */ struct environment { /** @@ -73,6 +82,8 @@ namespace mpi { * * @details Checks first if the program is run with an MPI runtime environment and if it has not been initialized * before to avoid errors. + * + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call. * * @param argc Number of command line arguments. * @param argv Command line arguments. @@ -84,11 +95,11 @@ namespace mpi { /** * @brief Destroy the mpi environment object by calling `MPI_Finalize`. * - * @details Checks first if the program is run with an MPI runtime environment. Called automatically when the - * environment object goes out of scope. + * @details Checks first if the program is run with an MPI runtime environment and if it has not been finalized + * before to avoid errors. */ ~environment() { - if (has_env) check_mpi_call(MPI_Finalize(), "MPI_Finalize"); + if (has_env && !is_finalized()) MPI_Finalize(); } }; diff --git a/c++/mpi/generic_communication.hpp b/c++/mpi/generic_communication.hpp index e0d613c..e4f2362 100644 --- a/c++/mpi/generic_communication.hpp +++ b/c++/mpi/generic_communication.hpp @@ -65,7 +65,7 @@ namespace mpi { * @param c mpi::communicator. * @param root Rank of the root process. */ - template [[gnu::always_inline]] void broadcast(T &&x, communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) + template void broadcast(T &&x, communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) mpi_broadcast(x, c, root); } @@ -87,8 +87,8 @@ namespace mpi { * @return Result of the specialized `mpi_reduce` call. */ template - [[gnu::always_inline]] decltype(auto) reduce(T &&x, communicator c = {}, int root = 0, bool all = false, // NOLINT (forwarding is not needed) - MPI_Op op = MPI_SUM) { + decltype(auto) reduce(T &&x, communicator c = {}, int root = 0, bool all = false, // NOLINT (forwarding is not needed) + MPI_Op op = MPI_SUM) { if constexpr (requires { mpi_reduce(x, c, root, all, op); }) { return mpi_reduce(x, c, root, all, op); } else { @@ -114,8 +114,8 @@ namespace mpi { * @param op `MPI_Op` used in the reduction. */ template - [[gnu::always_inline]] void reduce_in_place(T &&x, communicator c = {}, int root = 0, bool all = false, // NOLINT (forwarding is not needed) - MPI_Op op = MPI_SUM) { + void reduce_in_place(T &&x, communicator c = {}, int root = 0, bool all = false, // NOLINT (forwarding is not needed) + MPI_Op op = MPI_SUM) { mpi_reduce_into(x, x, c, root, all, op); } @@ -137,8 +137,8 @@ namespace mpi { * @param op `MPI_Op` used in the reduction. */ template - [[gnu::always_inline]] void reduce_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0, // NOLINT (forwarding is not needed) - bool all = false, MPI_Op op = MPI_SUM) { + void reduce_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0, // NOLINT (forwarding is not needed) + bool all = false, MPI_Op op = MPI_SUM) { mpi_reduce_into(x_in, x_out, c, root, all, op); } @@ -157,8 +157,7 @@ namespace mpi { * @param root Rank of the root process. * @return Result of the specialized `mpi_scatter` call. */ - template - [[gnu::always_inline]] decltype(auto) scatter(T &&x, mpi::communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) + template decltype(auto) scatter(T &&x, mpi::communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) if constexpr (requires { mpi_scatter(x, c, root); }) { return mpi_scatter(x, c, root); } else { @@ -184,7 +183,7 @@ namespace mpi { * @param root Rank of the root process. */ template - [[gnu::always_inline]] void scatter_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) + void scatter_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0) { // NOLINT (forwarding is not needed) mpi_scatter_into(x_in, x_out, c, root); } @@ -204,8 +203,7 @@ namespace mpi { * @param all Should all processes receive the result of the gather. * @return Result of the specialized `mpi_gather` call. */ - template - [[gnu::always_inline]] decltype(auto) gather(T &&x, communicator c = {}, int root = 0, bool all = false) { // NOLINT (forwarding is not needed) + template decltype(auto) gather(T &&x, communicator c = {}, int root = 0, bool all = false) { // NOLINT (forwarding is not needed) if constexpr (requires { mpi_gather(x, c, root, all); }) { return mpi_gather(x, c, root, all); } else { @@ -232,8 +230,8 @@ namespace mpi { * @param all Should all processes receive the result of the gather. */ template - [[gnu::always_inline]] void gather_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0, // NOLINT (forwarding is not needed) - bool all = false) { + void gather_into(T1 &&x_in, T2 &&x_out, communicator c = {}, int root = 0, // NOLINT (forwarding is not needed) + bool all = false) { mpi_gather_into(x_in, x_out, c, root, all); } @@ -241,8 +239,7 @@ namespace mpi { * @brief Generic MPI all-reduce. * @details It simply calls mpi::reduce with `all = true`. */ - template - [[gnu::always_inline]] decltype(auto) all_reduce(T &&x, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) + template decltype(auto) all_reduce(T &&x, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) return reduce(x, c, 0, true, op); } @@ -250,8 +247,7 @@ namespace mpi { * @brief Generic MPI all-reduce in place. * @details It simply calls mpi::reduce_in_place with `all = true`. */ - template - [[gnu::always_inline]] void all_reduce_in_place(T &&x, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) + template void all_reduce_in_place(T &&x, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) reduce_in_place(x, c, 0, true, op); } @@ -260,7 +256,7 @@ namespace mpi { * @details It simply calls mpi::reduce_into with `all = true`. */ template - [[gnu::always_inline]] void all_reduce_into(T1 &&x_in, T2 &&x_out, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) + void all_reduce_into(T1 &&x_in, T2 &&x_out, communicator c = {}, MPI_Op op = MPI_SUM) { // NOLINT (forwarding is not needed) return reduce_into(x_in, x_out, c, 0, true, op); } @@ -268,7 +264,7 @@ namespace mpi { * @brief Generic MPI all-gather. * @details It simply calls mpi::gather with `all = true`. */ - template [[gnu::always_inline]] decltype(auto) all_gather(T &&x, communicator c = {}) { // NOLINT (forwarding is not needed) + template decltype(auto) all_gather(T &&x, communicator c = {}) { // NOLINT (forwarding is not needed) return gather(x, c, 0, true); } @@ -276,8 +272,7 @@ namespace mpi { * @brief Generic MPI all-gather that gathers directly into an existing output object. * @details It simply calls mpi::gather_into with `all = true`. */ - template - [[gnu::always_inline]] void all_gather_into(T1 &&x_in, T2 &&x_out, communicator c = {}) { // NOLINT (forwarding is not needed) + template void all_gather_into(T1 &&x_in, T2 &&x_out, communicator c = {}) { // NOLINT (forwarding is not needed) return gather_into(x_in, x_out, c, 0, true); } @@ -307,7 +302,7 @@ namespace mpi { * @details If mpi::has_env is false or if the communicator size is < 2, it does nothing. Otherwise, it calls * `MPI_Bcast`. * - * It throws an exception in case the call to the MPI C library fails. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call. * * @tparam T Type to be broadcasted. * @param x Object to be broadcasted (into). @@ -330,7 +325,7 @@ namespace mpi { * @details If mpi::has_env is false or if the communicator size is < 2, it returns a copy of the input object. * Otherwise, it calls `MPI_Allreduce` or `MPI_Reduce` with a default constructed output object. * - * It throws an exception in case the call to the MPI C library fails. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call. * * @tparam T Type to be reduced. * @param x Object to be reduced. @@ -365,8 +360,8 @@ namespace mpi { * If mpi::has_env is false or if the communicator size is < 2, it either does nothing (in place) or copies the input * into the output object. Otherwise, it calls `MPI_Allreduce` or `MPI_Reduce` (with `MPI_IN_PLACE`). * - * It throws an exception in case the call to the MPI C library fails and it is expected that either all or none of - * the receiving processes choose the in place option. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it is expected that either all or + * none of the receiving processes choose the in place option. * * @tparam T Type to be reduced. * @param x_in Object to be reduced. @@ -429,10 +424,10 @@ namespace mpi { * corresponding MPI datatype. * * @details If mpi::has_env is false or if the communicator size is < 2, it copies the input object into the range. - * Otherwise, it calls `MPI_Allgather` or `MPI_Gather. + * Otherwise, it calls `MPI_Allgather` or `MPI_Gather`. * - * It throws an exception in case a call to the MPI C library fails and it expects that the range size on receiving - * processes is equal the communicator size. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it expects that the range size on + * receiving processes is equal the communicator size. * * @tparam T Type to be gathered. * @tparam R MPICompatibleRange type to be gathered into. diff --git a/c++/mpi/group.hpp b/c++/mpi/group.hpp index 46832f4..23bc1f9 100644 --- a/c++/mpi/group.hpp +++ b/c++/mpi/group.hpp @@ -36,12 +36,12 @@ namespace mpi { * @ingroup mpi_essentials * @brief C++ wrapper around `MPI_Group` providing various convenience functions. * - * @details It stores an `MPI_Group` object as its only member which by default is set to `MPI_GROUP_NULL`. - * The underlying `MPI_Group` object is automatically freed when a group object goes out of scope. + * @details It stores an `MPI_Group` object as its only member which by default is set to `MPI_GROUP_NULL`. The + * underlying `MPI_Group` object is automatically freed when a group object goes out of scope. * * This class follows move-only semantics and takes ownership of the wrapped `MPI_Group` object. * - * All functions that make direct calls to the MPI C library throw an exception in case the call fails. + * All functions that make direct calls to the MPI C API, except free(), check their success with mpi::check_mpi_call. */ class group { public: diff --git a/c++/mpi/monitor.hpp b/c++/mpi/monitor.hpp index 47931cd..137cb4c 100644 --- a/c++/mpi/monitor.hpp +++ b/c++/mpi/monitor.hpp @@ -37,7 +37,7 @@ namespace mpi { * @brief Constructed on top of an MPI communicator, this class helps to monitor and communicate events across * multiple processes. * - * @details The root process (rank == 0) monitors all other processes. If a process encounters an event, it sends a + * @details The root process (`rank == 0`) monitors all other processes. If a process encounters an event, it sends a * message to the root process by calling monitor::report_local_event. The root process then broadcasts this * information to all other processes. * @@ -48,7 +48,7 @@ namespace mpi { * It uses a duplicate communicator to not interfere with other MPI communications. The communicator is freed in the * `finalize_communications` function (which is called in the destructor if not called before). * - * All functions that make direct calls to the MPI C library throw an exception in case the call fails. + * All functions that make direct calls to the MPI C API check their success with mpi::check_mpi_call. */ class monitor { // Future struct for non-blocking MPI communication. @@ -60,40 +60,13 @@ namespace mpi { int event = 0; }; - // MPI communicator. - mpi::communicator comm; - - // Future objects stored on the root process for local events on non-root processes. - std::vector root_futures; - - // MPI request for the broadcasting done on the root process in case an event has occurred on any rank. - MPI_Request req_ibcast_any{}; - - // MPI request for the broadcasting done on the root process in case an event has occurred on all ranks. - MPI_Request req_ibcast_all{}; - - // MPI request for the sending done on non-root processes. - MPI_Request req_isent{}; - - // Set to 1, if a local event has occurred on this process. - int local_event = 0; - - // Set to 1, if an event has occurred on any process. - int any_event = 0; - - // Set to 1, if an event has occurred on all processes. - int all_events = 0; - - // Set to true, if finialize_communications() has been called. - bool finalized = false; - public: /** * @brief Construct a monitor on top of a given mpi::communicator. * * @details The communicator is duplicated to not interfere with other MPI communications. * - * The root process (rank == 0) performs a non-blocking receive for every non-root process and waits for a + * The root process (`rank == 0`) performs a non-blocking receive for every non-root process and waits for a * non-root process to send a message that an event has occurred. * * Non-root processes make two non-blocking broadcast calls and wait for the root process to broadcast a message in @@ -101,16 +74,16 @@ namespace mpi { * * @param c mpi::communicator. */ - monitor(mpi::communicator c) : comm(c.duplicate()) { - if (comm.rank() == 0) { - root_futures.resize(c.size() - 1); + monitor(mpi::communicator c) : comm_(c.duplicate()) { + if (comm_.rank() == 0) { + root_futures_.resize(c.size() - 1); for (int rank = 1; rank < c.size(); ++rank) { - check_mpi_call(MPI_Irecv(&(root_futures[rank - 1].event), 1, MPI_INT, rank, rank, comm.get(), &(root_futures[rank - 1].request)), + check_mpi_call(MPI_Irecv(&(root_futures_[rank - 1].event), 1, MPI_INT, rank, rank, comm_.get(), &(root_futures_[rank - 1].request)), "MPI_Irecv"); } } else { - check_mpi_call(MPI_Ibcast(&any_event, 1, MPI_INT, 0, comm.get(), &req_ibcast_any), "MPI_Ibcast"); - check_mpi_call(MPI_Ibcast(&all_events, 1, MPI_INT, 0, comm.get(), &req_ibcast_all), "MPI_Ibcast"); + check_mpi_call(MPI_Ibcast(&any_event_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_any_), "MPI_Ibcast"); + check_mpi_call(MPI_Ibcast(&all_events_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_all_), "MPI_Ibcast"); } } @@ -124,7 +97,7 @@ namespace mpi { ~monitor() { finalize_communications(); } /** - * @brief Report a local event to the root process (rank == 0). + * @brief Report a local event to the root process (`rank == 0`). * * @details This function can be called on any process in case a local event has occurred. * @@ -136,16 +109,16 @@ namespace mpi { */ void report_local_event() { // prevent sending multiple signals - if (local_event or finalized) { return; } + if (local_event_ or finalized_) { return; } // a local event has occurred - local_event = 1; - if (comm.rank() == 0) { + local_event_ = 1; + if (comm_.rank() == 0) { // on root process, check all other nodes and perform necessary broadcasts root_check_nodes_and_bcast(); } else { // on non-root processes, let the root process know about the local event - check_mpi_call(MPI_Isend(&local_event, 1, MPI_INT, 0, comm.rank(), comm.get(), &req_isent), "MPI_Isend"); + check_mpi_call(MPI_Isend(&local_event_, 1, MPI_INT, 0, comm_.rank(), comm_.get(), &req_isent_), "MPI_Isend"); } } @@ -159,31 +132,31 @@ namespace mpi { * - if an event has occurred on some other process which has already been reported to the root process and * broadcasted to all other processes. * - * On the root process (rank == 0), it checks the status of all non-root processes and performs the necessary + * On the root process (`rank == 0`), it checks the status of all non-root processes and performs the necessary * broadcasts in case they have not been done yet. * * @return True, if an event has occurred on any process. */ [[nodiscard]] bool event_on_any_rank() { // if final_communications() has already been called, any_event == 0 if no event has occurred, otherwise it is 1 - if (finalized) return any_event; + if (finalized_) return any_event_; // if a local event has occurred, we return true - if (local_event) return true; + if (local_event_) return true; // on the root process, we first check the status of all non-root processes, perform the necessary broadcasts and // return true if an event has occurred - if (comm.rank() == 0) { + if (comm_.rank() == 0) { root_check_nodes_and_bcast(); - return any_event; + return any_event_; } // on non-root processes, we check the status of the corresponding broadcast and return true if an event has // occurred MPI_Status status; int has_received = 0; - check_mpi_call(MPI_Test(&req_ibcast_any, &has_received, &status), "MPI_Test"); - return has_received and any_event; + check_mpi_call(MPI_Test(&req_ibcast_any_, &has_received, &status), "MPI_Test"); + return has_received and any_event_; } /** @@ -194,7 +167,7 @@ namespace mpi { * It returns true, if an event has occurred on all processes which has already been reported to the root process * and broadcasted to all other processes. * - * On the root process (rank == 0), it checks the status of all non-root processes and performs the necessary + * On the root process (`rank == 0`), it checks the status of all non-root processes and performs the necessary * broadcasts in case it has not been done yet. * * @return True, if an event has occurred on all processes. @@ -202,21 +175,21 @@ namespace mpi { [[nodiscard]] bool event_on_all_ranks() { // if final_communications() has already been called, all_events == 0 if an event has not occurred on every // process, otherwise it is 1 - if (finalized) return all_events; + if (finalized_) return all_events_; // on the root process, we first check the status of all non-root processes, perform the necessary broadcasts and // return true if an event has occurred on all of them - if (comm.rank() == 0) { + if (comm_.rank() == 0) { root_check_nodes_and_bcast(); - return all_events; + return all_events_; } // on non-root processes, we check the status of the broadcast and return true if an event has occurred on all // processes MPI_Status status; int has_received = 0; - check_mpi_call(MPI_Test(&req_ibcast_all, &has_received, &status), "MPI_Test"); - return has_received and all_events; + check_mpi_call(MPI_Test(&req_ibcast_all_, &has_received, &status), "MPI_Test"); + return has_received and all_events_; } /** @@ -229,41 +202,41 @@ namespace mpi { */ void finalize_communications() { // prevent multiple calls - if (finalized) return; + if (finalized_) return; - if (comm.rank() == 0) { + if (comm_.rank() == 0) { // on root process, wait for all non-root processes to finish their MPI_Isend calls while (root_check_nodes_and_bcast()) { usleep(100); // 100 us (micro seconds) } // and perform broadcasts in case they have not been done yet - if (not any_event) { check_mpi_call(MPI_Ibcast(&any_event, 1, MPI_INT, 0, comm.get(), &req_ibcast_any), "MPI_Ibcast"); } - if (not all_events) { check_mpi_call(MPI_Ibcast(&all_events, 1, MPI_INT, 0, comm.get(), &req_ibcast_all), "MPI_Ibcast"); } + if (not any_event_) { check_mpi_call(MPI_Ibcast(&any_event_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_any_), "MPI_Ibcast"); } + if (not all_events_) { check_mpi_call(MPI_Ibcast(&all_events_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_all_), "MPI_Ibcast"); } } else { // on non-root processes, perform MPI_Isend call in case it has not been done yet - if (not local_event) { check_mpi_call(MPI_Isend(&local_event, 1, MPI_INT, 0, comm.rank(), comm.get(), &req_isent), "MPI_Isend"); } + if (not local_event_) { check_mpi_call(MPI_Isend(&local_event_, 1, MPI_INT, 0, comm_.rank(), comm_.get(), &req_isent_), "MPI_Isend"); } } // all nodes wait for the broadcasts to be completed MPI_Status status_any, status_all; - check_mpi_call(MPI_Wait(&req_ibcast_any, &status_any), "MPI_Wait"); - check_mpi_call(MPI_Wait(&req_ibcast_all, &status_all), "MPI_Wait"); + check_mpi_call(MPI_Wait(&req_ibcast_any_, &status_any), "MPI_Wait"); + check_mpi_call(MPI_Wait(&req_ibcast_all_, &status_all), "MPI_Wait"); // free the communicator - comm.free(); - finalized = true; + comm_.free(); + finalized_ = true; } private: // Root process checks the status of all non-root processes, performs necessary broadcasts and returns a boolean // that is true if at least one non-root process has not performed its MPI_Isend call yet. bool root_check_nodes_and_bcast() { - EXPECTS(!finalized); - EXPECTS(comm.rank() == 0); + EXPECTS(!finalized_); + EXPECTS(comm_.rank() == 0); bool any = false; bool all = true; bool finished = true; - for (auto &[request, rank_event] : root_futures) { + for (auto &[request, rank_event] : root_futures_) { MPI_Status status; int rank_received = 0; check_mpi_call(MPI_Test(&request, &rank_received, &status), "MPI_Test"); @@ -271,16 +244,44 @@ namespace mpi { all &= (rank_received and rank_event); finished &= rank_received; } - if (not any_event and (any or local_event)) { - any_event = 1; - check_mpi_call(MPI_Ibcast(&any_event, 1, MPI_INT, 0, comm.get(), &req_ibcast_any), "MPI_Ibcast"); + if (not any_event_ and (any or local_event_)) { + any_event_ = 1; + check_mpi_call(MPI_Ibcast(&any_event_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_any_), "MPI_Ibcast"); } - if (not all_events and all and local_event) { - all_events = 1; - check_mpi_call(MPI_Ibcast(&all_events, 1, MPI_INT, 0, comm.get(), &req_ibcast_all), "MPI_Ibcast"); + if (not all_events_ and all and local_event_) { + all_events_ = 1; + check_mpi_call(MPI_Ibcast(&all_events_, 1, MPI_INT, 0, comm_.get(), &req_ibcast_all_), "MPI_Ibcast"); } return not finished; } + + private: + // MPI communicator. + mpi::communicator comm_; + + // Future objects stored on the root process for local events on non-root processes. + std::vector root_futures_; + + // MPI request for the broadcasting done on the root process in case an event has occurred on any rank. + MPI_Request req_ibcast_any_{}; + + // MPI request for the broadcasting done on the root process in case an event has occurred on all ranks. + MPI_Request req_ibcast_all_{}; + + // MPI request for the sending done on non-root processes. + MPI_Request req_isent_{}; + + // Set to 1, if a local event has occurred on this process. + int local_event_ = 0; + + // Set to 1, if an event has occurred on any process. + int any_event_ = 0; + + // Set to 1, if an event has occurred on all processes. + int all_events_ = 0; + + // Set to true, if finialize_communications() has been called. + bool finalized_ = false; }; } // namespace mpi diff --git a/c++/mpi/mpi.hpp b/c++/mpi/mpi.hpp index 0c565ab..bfd66be 100644 --- a/c++/mpi/mpi.hpp +++ b/c++/mpi/mpi.hpp @@ -27,6 +27,7 @@ #include "./datatypes.hpp" #include "./environment.hpp" #include "./generic_communication.hpp" +#include "./group.hpp" #include "./monitor.hpp" #include "./operators.hpp" #include "./optional.hpp" diff --git a/c++/mpi/operators.hpp b/c++/mpi/operators.hpp index 3d20dfd..6acafd0 100644 --- a/c++/mpi/operators.hpp +++ b/c++/mpi/operators.hpp @@ -37,7 +37,7 @@ namespace mpi { * * @details The binary function must have the following signature `(T const&, T const&) -> T`. * - * It throws an exception in case a call to the MPI C library fails. + * The success of MPI calls is checked with mpi::check_mpi_call. * * @tparam T Type on which the binary function operates. * @tparam F Binary function pointer to be mapped. @@ -55,8 +55,10 @@ namespace mpi { } namespace detail { + // Generic addition. FIXME Convert to lambda, requires gcc 13.2+ template T generic_add(T const &lhs, T const &rhs) { return lhs + rhs; } + } // namespace detail /** diff --git a/c++/mpi/ranges.hpp b/c++/mpi/ranges.hpp index 63ff0d1..60db62d 100644 --- a/c++/mpi/ranges.hpp +++ b/c++/mpi/ranges.hpp @@ -58,8 +58,8 @@ namespace mpi { * from the input range on the root process to all other processes. * - Otherwise, it calls mpi::broadcast for each element separately. * - * It throws an exception in case a call to the MPI C library fails and it expects that the input range size is equal - * on all processes. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it expects that the input range + * size is equal on all processes. * * @tparam R `std::ranges::sized_range` type. * @param rg Range to be broadcasted (into). @@ -102,7 +102,7 @@ namespace mpi { * - If the input and output ranges point to the same data, the reduction is done in place. * - Otherwise, it calls mpi::reduce_into for each input-output element pair separately. * - * It throws an exception in case a call to the MPI C library fails and it expects + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it expects * - that the input range size on all processes and the output range size on receiving processes are equal and * - that either all or none of the receiving processes choose the in place option. * @@ -192,7 +192,7 @@ namespace mpi { * be scattered into chunks of the specified size. Then, instead of single elements, the chunks are distributed evenly * across the processes in the communicator. * - * It throws an exception if call to the MPI C library fails and it expects + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it expects * - that the number of elements to be scattered is equal on all processes, * - that the size of the input range on the root process is equal the number of elements to be scattered and * - that the output range size is equal the number of elements to be received on all processes. @@ -260,8 +260,8 @@ namespace mpi { * This is the inverse operation of mpi::scatter_range. The numbers of elements to be gathered do not have to be equal * on all processes. * - * It throws an exception in case a call to the MPI C library fails and it expects that the output range sizes on - * receiving processes is the number of elements to be gathered. + * Direct calls the MPI C API are checked for success with mpi::check_mpi_call and it expects that the output range + * sizes on receiving processes is the number of elements to be gathered. * * @note In place gathering is not supported. * diff --git a/c++/mpi/utils.hpp b/c++/mpi/utils.hpp index 597514e..d3ebbb0 100644 --- a/c++/mpi/utils.hpp +++ b/c++/mpi/utils.hpp @@ -35,15 +35,12 @@ namespace mpi { /** * @brief Check the success of an MPI call. + * * @details It checks if the given error code returned by an MPI routine is equal to `MPI_SUCCESS`. If it isn't, it * throws an exception. * - * It is intended to simply wrap any calls to the MPI C library: - * @code{.cpp} - * int value = 5; - * int result = 0; - * check_mpi_call(MPI_Allreduce(&value, &result, 1, mpi::mpi_type::get(), MPI_MAX, comm.get()), "MPI_Allreduce"); - * @endcode + * @note MPI routines only return an error code if the error handler is set to `MPI_ERRORS_RETURN`. By default, it + * uses `MPI_ERRORS_ARE_FATAL`, which aborts the program in case of an error. * * @param errcode Error code returned by an MPI routine. * @param mpi_routine Name of the MPI routine used in the error message. diff --git a/c++/mpi/vector.hpp b/c++/mpi/vector.hpp index 91de1a2..53b0cd2 100644 --- a/c++/mpi/vector.hpp +++ b/c++/mpi/vector.hpp @@ -60,7 +60,7 @@ namespace mpi { /** * @brief Implementation of an MPI reduce for a `std::vector`. * - * @details It first constructs the output vector with its value type equal to the return type of + * @details It first constructs the output vector with its value type equal to the return type of * `reduce(std::declval())`. On receiving ranks, the output vector is then resized to the size of the input vector. * On non-receiving ranks, the output vector is always empty. * diff --git a/c++/mpi/window.hpp b/c++/mpi/window.hpp index 9d6325d..8aa727c 100644 --- a/c++/mpi/window.hpp +++ b/c++/mpi/window.hpp @@ -51,6 +51,8 @@ namespace mpi { * If a base pointer is not specified, the constructor will allocate memory internally. * * This class follows move-only semantics and takes ownership of the wrapped `MPI_Win` object. + * + * All functions that make direct calls to the MPI C API, except free(), check their success with mpi::check_mpi_call. * * @tparam BaseType The type of elements stored in the memory window. */ @@ -124,7 +126,7 @@ namespace mpi { if (has_env) { check_mpi_call(MPI_Win_allocate(size_ * sizeof(BaseType), sizeof(BaseType), info, c.get(), &data_, &win_), "MPI_Win_allocate"); } else { - data_ = new BaseType[size_]; // NOLINT (new is fine here) + data_ = new BaseType[size_]; // NOLINT (new is fine here) } owned_ = true; } @@ -360,6 +362,8 @@ namespace mpi { * @brief A C++ wrapper around `MPI_Win` representing a shared memory window. * * @details This class provides an interface for creating and managing an MPI shared memory window. + * + * All functions that make direct calls to the MPI C API check their success with mpi::check_mpi_call. * * @tparam BaseType The type of elements stored in the shared memory window. */ @@ -385,7 +389,7 @@ namespace mpi { if (has_env) { check_mpi_call(MPI_Win_allocate_shared(size_ * sizeof(BaseType), sizeof(BaseType), info, c.get(), &data_, &win_), "MPI_Win_allocate_shared"); } else { - data_ = new BaseType[size_]; // NOLINT (new is fine here) + data_ = new BaseType[size_]; // NOLINT (new is fine here) } owned_ = true; } @@ -393,11 +397,11 @@ namespace mpi { /** * @brief Query attributes of a shared memory window. * - * @details Retrieves the byte-size, displacement unit, and a pointer to the beginning of the shared memory region for a - * specific rank. + * @details Retrieves the byte-size, displacement unit, and a pointer to the beginning of the shared memory region + * for a specific rank. * - * When `MPI_PROC_NULL` is passed for the rank, MPI returns information about the memory segment with the lowest rank that has a - * non-zero size. + * When `MPI_PROC_NULL` is passed for the rank, MPI returns information about the memory segment with the lowest + * rank that has a non-zero size. * * @param rank Rank within the shared communicator. * @return A tuple containing the byte-size, the displacement unit in bytes and the base pointer. diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 790f6fb..fd32a5c 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -25,6 +25,9 @@ add_custom_target(doxygen ALL VERBATIM ) +# Compile example codes +add_subdirectory(examples) + # ############ # Install install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ COMPONENT documentation DESTINATION share/doc/${PROJECT_NAME} diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 01ee10d..a15da34 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,7 +1,7 @@ -# Doxyfile 1.11.0 +# Doxyfile 1.14.0 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. +# Doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. @@ -15,10 +15,10 @@ # # Note: # -# Use doxygen to compare the used configuration file with the template +# Use Doxygen to compare the used configuration file with the template # configuration file: # doxygen -x [configFile] -# Use doxygen to compare the used configuration file with the template +# Use Doxygen to compare the used configuration file with the template # configuration file without replacing the environment variables or CMake type # replacement variables: # doxygen -x_noenv [configFile] @@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "TRIQS/@PROJECT_NAME@" +PROJECT_NAME = TRIQS/@PROJECT_NAME@ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -51,7 +51,7 @@ PROJECT_NAME = "TRIQS/@PROJECT_NAME@" PROJECT_NUMBER = @PROJECT_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a +# for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "C++ interface to MPI" @@ -71,16 +71,16 @@ PROJECT_ICON = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If +# entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@ -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format # and will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise cause # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to # control the number of sub-directories. # The default value is: NO. @@ -98,7 +98,7 @@ CREATE_SUBDIRS = NO CREATE_SUBDIRS_LEVEL = 8 -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. @@ -107,7 +107,7 @@ CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this +# documentation generated by Doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English @@ -121,14 +121,14 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the @@ -149,13 +149,13 @@ REPEAT_BRIEF = YES ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief +# Doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. @@ -163,7 +163,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. @@ -173,11 +173,11 @@ FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to +# If left blank the directory from which Doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. +# will be relative from the directory where Doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/c++ @@ -191,41 +191,42 @@ STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/c++ STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/c++ -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. +# interpreted by Doxygen. # The default value is: NO. JAVADOC_BANNER = NO -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this @@ -237,10 +238,10 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# By default Python docstrings are displayed as preformatted text and doxygen's +# By default Python docstrings are displayed as preformatted text and Doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = YES @@ -251,7 +252,7 @@ PYTHON_DOCSTRING = YES INHERIT_DOCS = NO -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. @@ -321,30 +322,30 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files +# default for Fortran type files). For instance to make Doxygen treat .inc files # as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add +# the files are not read by Doxygen. When specifying no_extension you should add # * to the FILE_PATTERNS. # # Note see also the list of default file extension mappings. EXTENSION_MAPPING = -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. @@ -354,7 +355,7 @@ MARKDOWN_SUPPORT = YES # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. +# Minimum value: 0, maximum value: 99, default value: 6. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 @@ -370,17 +371,26 @@ TOC_INCLUDE_HEADINGS = 5 MARKDOWN_ID_STYLE = DOXYGEN -# When enabled doxygen tries to link words that correspond to documented +# When enabled Doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. # The default value is: YES. AUTOLINK_SUPPORT = YES +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \# +# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and +# tag to YES in order to let Doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also makes the inheritance and # collaboration diagrams that involve STL classes more complete and accurate. @@ -404,7 +414,7 @@ SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. +# Doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. @@ -413,7 +423,7 @@ SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first +# tag is set to YES then Doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. @@ -471,18 +481,18 @@ TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest +# symbols. At the end of a run Doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple @@ -506,7 +516,7 @@ TIMESTAMP = NO # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. @@ -572,7 +582,7 @@ EXTRACT_ANON_NSPACES = NO RESOLVE_UNNAMED_PARAMS = YES -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. @@ -580,7 +590,7 @@ RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = YES -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # will also hide undocumented C++ concepts if enabled. This option has no effect @@ -589,14 +599,22 @@ HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. @@ -610,7 +628,7 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be # able to match the capabilities of the underlying filesystem. In case the # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly @@ -619,7 +637,7 @@ INTERNAL_DOCS = NO # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option +# Windows (including Cygwin) and macOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. # Possible values are: SYSTEM, NO and YES. @@ -627,19 +645,19 @@ INTERNAL_DOCS = NO CASE_SENSE_NAMES = SYSTEM -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. -HIDE_COMPOUND_REFERENCE = YES +HIDE_COMPOUND_REFERENCE= YES # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class # will show which file needs to be included to use the class. @@ -647,7 +665,7 @@ HIDE_COMPOUND_REFERENCE = YES SHOW_HEADERFILE = YES -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -660,7 +678,7 @@ SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. @@ -672,14 +690,14 @@ FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. @@ -687,7 +705,7 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = YES -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. @@ -699,7 +717,7 @@ SORT_BRIEF_DOCS = YES SORT_MEMBERS_CTORS_1ST = YES -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. @@ -716,11 +734,11 @@ SORT_GROUP_NAMES = YES SORT_BY_SCOPE_NAME = YES -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. @@ -749,7 +767,7 @@ GENERATE_BUGLIST = YES # the documentation. # The default value is: YES. -GENERATE_DEPRECATEDLIST = YES +GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond @@ -790,25 +808,25 @@ SHOW_FILES = YES SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from +# Doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file +# by Doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated +# by Doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can +# that represents Doxygen's defaults, run Doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. See also section "Changing the # layout of pages" for information. # -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml @@ -823,19 +841,35 @@ LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml CITE_BIB_FILES = +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the +# standard output by Doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. @@ -843,14 +877,14 @@ QUIET = NO WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for # potential errors in the documentation, such as documenting some parameters in # a documented function twice, or documenting parameters that don't exist or # using markup commands wrongly. @@ -858,8 +892,8 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete -# function parameter documentation. If set to NO, doxygen will accept that some +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some # parameters have no documentation without warning. # The default value is: YES. @@ -867,7 +901,7 @@ WARN_IF_INCOMPLETE_DOC = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong parameter +# value. If set to NO, Doxygen will only warn about wrong parameter # documentation, but not about the absence of documentation. If EXTRACT_ALL is # set to YES then this flag will automatically be disabled. See also # WARN_IF_INCOMPLETE_DOC @@ -875,20 +909,28 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO -# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about -# undocumented enumeration values. If set to NO, doxygen will accept +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: NO. WARN_IF_UNDOC_ENUM_VAL = NO -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves -# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not # write the warning messages in between other messages but write them at the end # of a run, in case a WARN_LOGFILE is defined the warning messages will be # besides being in the defined file also be shown at the end of a run, unless @@ -899,7 +941,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO WARN_AS_ERROR = NO -# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will @@ -912,7 +954,7 @@ WARN_FORMAT = "$file:$line: $text" # In the $text part of the WARN_FORMAT command it is possible that a reference # to a more specific place is given. To make it easier to jump to this place -# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. # Example: # WARN_LINE_FORMAT = "'vi $file +$line'" # See also: WARN_FORMAT @@ -944,7 +986,7 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@ \ @CMAKE_CURRENT_SOURCE_DIR@/../c++ # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. @@ -954,10 +996,10 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@ \ INPUT_ENCODING = UTF-8 # This tag can be used to specify the character encoding of the source files -# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify # character encoding on a per file pattern basis. Doxygen will compare the file # name with each pattern and apply the encoding instead of the default -# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# INPUT_ENCODING if there is a match. The character encodings are a list of the # form: pattern=encoding (like *.php=ISO-8859-1). # See also: INPUT_ENCODING for further information on supported encodings. @@ -969,16 +1011,16 @@ INPUT_FILE_ENCODING = # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. +# read by Doxygen. # # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, # *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, -# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, -# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to -# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ @@ -1043,10 +1085,11 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # -# Note that relative paths are relative to the directory from which doxygen is +# Note that relative paths are relative to the directory from which Doxygen is # run. -EXCLUDE = +EXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/examples \ + @CMAKE_CURRENT_BINARY_DIR@/examples # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -1076,7 +1119,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -1098,7 +1141,7 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should +# The INPUT_FILTER tag can be used to specify a program that Doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # @@ -1113,14 +1156,14 @@ IMAGE_PATH = # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # -# Note that doxygen will use the data processed and written to standard output +# Note that Doxygen will use the data processed and written to standard output # for further processing, therefore nothing else, like debug statements or used # commands (so in case of a Windows batch file always use @echo OFF), should be # written to standard output. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. +# properly processed by Doxygen. INPUT_FILTER = @@ -1133,7 +1176,7 @@ INPUT_FILTER = # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. +# properly processed by Doxygen. FILTER_PATTERNS = @@ -1155,10 +1198,19 @@ FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. +# and want to reuse the introduction page also for the Doxygen output. USE_MDFILE_AS_MAINPAGE = +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common # extension is to allow longer lines before the automatic comment starts. The @@ -1188,7 +1240,7 @@ SOURCE_BROWSER = YES INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. @@ -1226,7 +1278,7 @@ REFERENCES_LINK_SOURCE = YES SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. @@ -1240,14 +1292,14 @@ SOURCE_TOOLTIPS = YES # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # -# The result: instead of the source browser generated by doxygen, the links to +# The result: instead of the source browser generated by Doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. @@ -1255,46 +1307,6 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS -# tag is set to YES then doxygen will add the directory of each input to the -# include path. -# The default value is: YES. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_ADD_INC_PATHS = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the directory containing a file called compile_commands.json. This -# file is the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the -# options used when the source files were built. This is equivalent to -# specifying the -p option to a clang tool, such as clang-check. These options -# will then be passed to the parser. Any options specified with CLANG_OPTIONS -# will be added as well. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = @CMAKE_CURRENT_BINARY_DIR@/.. - #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -1319,7 +1331,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1340,40 +1352,40 @@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a +# each generated HTML page. If the tag is left blank Doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. +# that Doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally +# for information on how to generate the default header that Doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description +# default header when upgrading to a newer version of Doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard +# generated HTML page. If the tag is left blank Doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. +# that Doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. +# the HTML output. If left blank Doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. +# sheet that Doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. @@ -1383,7 +1395,7 @@ HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. +# created by Doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. @@ -1479,7 +1491,7 @@ HTML_DYNAMIC_SECTIONS = NO HTML_CODE_FOLDING = YES -# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in # the top right corner of code and text fragments that allows the user to copy # its content to the clipboard. Note this only works if supported by the browser # and the web page is served via a secure context (see: @@ -1492,7 +1504,7 @@ HTML_COPY_CLIPBOARD = YES # Doxygen stores a couple of settings persistently in the browser (via e.g. # cookies). By default these settings apply to all HTML pages generated by -# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store # the settings under a project specific key, such that the user preferences will # be stored separately. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1516,7 +1528,7 @@ HTML_INDEX_NUM_ENTRIES = 100 # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML +# create a documentation set, Doxygen will generate a Makefile in the HTML # output directory. Running make will produce the docset in that directory and # running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at @@ -1564,18 +1576,18 @@ DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for @@ -1595,7 +1607,7 @@ CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. +# Doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1697,7 +1709,7 @@ QHP_CUST_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to # run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1742,29 +1754,38 @@ DISABLE_INDEX = NO # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that +# example, the default style sheet generated by Doxygen has an example that # shows how to put an image at the root of the tree instead of the PROJECT_NAME. -# Since the tree basically has the same information as the tab index, you could -# consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. +# Since the tree basically has more details information than the tab index, you +# could consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview -# area (value NO) or if it should extend to the full height of the window (value -# YES). Setting this to YES gives a layout similar to -# https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATE_TREEVIEW or -# DISABLE_INDEX is set to NO, this option has no effect. +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines +# if an additional navigation panel is shown at the right hand side of the +# screen, displaying an outline of the contents of the main page, similar to +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to +# NO, this option has no effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +PAGE_OUTLINE_PANEL = YES + +# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if +# the side bar is limited to only the treeview area (value NO) or if it should +# extend to the full height of the window (value YES). Setting this to YES gives +# a layout similar to e.g. https://docs.readthedocs.io with more room for +# contents, but less room for the project logo, title, and description. If +# GENERATE_TREEVIEW is set to NO, this option has no effect. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. +# Doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. @@ -1773,6 +1794,12 @@ FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 4 +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. @@ -1780,21 +1807,21 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email # addresses. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. OBFUSCATE_EMAILS = YES -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. @@ -1807,7 +1834,7 @@ HTML_FORMULA_FORMAT = png # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML +# Doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1885,7 +1912,7 @@ MATHJAX_RELPATH = MATHJAX_EXTENSIONS = -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an @@ -1894,12 +1921,12 @@ MATHJAX_EXTENSIONS = MATHJAX_CODEFILE = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then +# For large projects the JavaScript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically @@ -1918,7 +1945,7 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and +# setting. When disabled, Doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing # and searching needs to be provided by external tools. See the section # "External Indexing and Searching" for details. @@ -1927,7 +1954,7 @@ SEARCHENGINE = YES SERVER_BASED_SEARCH = NO -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain the @@ -1972,7 +1999,7 @@ SEARCHDATA_FILE = searchdata.xml EXTERNAL_SEARCH_ID = -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of @@ -1986,7 +2013,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -2031,7 +2058,7 @@ MAKEINDEX_CMD_NAME = makeindex LATEX_MAKEINDEX_CMD = makeindex -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -2062,15 +2089,15 @@ EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for # the generated LaTeX document. The header should contain everything until the -# first chapter. If it is left blank doxygen will generate a standard header. It +# first chapter. If it is left blank Doxygen will generate a standard header. It # is highly recommended to start with a default header using # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty # and then modify the file new_header.tex. See also section "Doxygen usage" for -# information on how to generate the default header that doxygen normally uses. +# information on how to generate the default header that Doxygen normally uses. # # Note: Only use a user-defined header if you know what you are doing! # Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. The following +# default header when upgrading to a newer version of Doxygen. The following # commands have a special meaning inside the header (and footer): For a # description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2079,10 +2106,10 @@ LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for # the generated LaTeX document. The footer should contain everything after the -# last chapter. If it is left blank doxygen will generate a standard footer. See +# last chapter. If it is left blank Doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what # special commands can be used inside the footer. See also section "Doxygen -# usage" for information on how to generate the default footer that doxygen +# usage" for information on how to generate the default footer that Doxygen # normally uses. Note: Only use a user-defined footer if you know what you are # doing! # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2091,7 +2118,7 @@ LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created -# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# by Doxygen. Using this option one can overrule certain style aspects. Doxygen # will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the @@ -2117,7 +2144,7 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX # files. Set this option to YES, to get a higher quality PDF documentation. # @@ -2142,7 +2169,7 @@ USE_PDFLATEX = YES LATEX_BATCHMODE = NO -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the # index chapters (such as File Index, Compound Index, etc.) in the output. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2152,7 +2179,7 @@ LATEX_HIDE_INDICES = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. +# The default value is: plainnat. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain @@ -2169,7 +2196,7 @@ LATEX_EMOJI_DIRECTORY = # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -2184,7 +2211,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -2204,28 +2231,36 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's +# Load stylesheet definitions from file. Syntax is similar to Doxygen's # configuration file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. +# default style sheet that Doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's configuration file. A template extensions file can be +# similar to Doxygen's configuration file. A template extensions file can be # generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = +# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the RTF_OUTPUT output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTRA_FILES = + #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -2256,7 +2291,7 @@ MAN_EXTENSION = .3 MAN_SUBDIR = -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without # them the man command would be unable to find the correct page. @@ -2269,7 +2304,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -2283,7 +2318,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -2292,7 +2327,7 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include # namespace members in file scope as well, matching the HTML output. # The default value is: NO. # This tag requires that the tag GENERATE_XML is set to YES. @@ -2303,7 +2338,7 @@ XML_NS_MEMB_FILE_SCOPE = NO # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -2321,7 +2356,7 @@ DOCBOOK_OUTPUT = docbook # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an # AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. @@ -2333,8 +2368,8 @@ GENERATE_AUTOGEN_DEF = NO # Configuration options related to Sqlite3 output #--------------------------------------------------------------------------- -# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 -# database with symbols found by doxygen stored in tables. +# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3 +# database with symbols found by Doxygen stored in tables. # The default value is: NO. GENERATE_SQLITE3 = NO @@ -2348,7 +2383,7 @@ GENERATE_SQLITE3 = NO SQLITE3_OUTPUT = sqlite3 # The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db -# database file will be recreated with each doxygen run. If set to NO, doxygen +# database file will be recreated with each Doxygen run. If set to NO, Doxygen # will warn if a database file is already found and not modify it. # The default value is: YES. # This tag requires that the tag GENERATE_SQLITE3 is set to YES. @@ -2359,7 +2394,7 @@ SQLITE3_RECREATE_DB = YES # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -2367,7 +2402,7 @@ SQLITE3_RECREATE_DB = YES GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -2397,13 +2432,13 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names # in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. @@ -2462,7 +2497,7 @@ PREDEFINED = EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have # an all uppercase name, and do not end with a semicolon. Such function macros # are typically used for boiler-plate code, and will confuse the parser if not @@ -2486,12 +2521,12 @@ SKIP_FUNCTION_MACROS = YES # section "Linking to external documentation" for more information about the use # of tag files. # Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is +# the path). If a tag file is not located in the directory in which Doxygen is # run, you must also specify the path to the tagfile here. TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. @@ -2528,7 +2563,7 @@ EXTERNAL_PAGES = YES HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is @@ -2537,8 +2572,8 @@ HIDE_UNDOC_RELATIONS = YES HAVE_DOT = NO -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of +# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed +# to run in parallel. When set to 0 Doxygen will base this on the number of # processors available in the system. You can set it explicitly to a value # larger than 0 to get control over the balance between CPU load and processing # speed. @@ -2549,7 +2584,7 @@ DOT_NUM_THREADS = 0 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of # subgraphs. When you want a differently looking font in the dot files that -# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# Doxygen generates you can specify fontname, fontcolor and fontsize attributes. # For details please see Node, # Edge and Graph Attributes specification You need to make sure dot is able # to find the font, which can be done by putting it in a standard location or by @@ -2583,7 +2618,7 @@ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will # generate a graph for each documented class showing the direct and indirect # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case @@ -2600,7 +2635,7 @@ DOT_FONTPATH = CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a # graph for each documented class showing the direct and indirect implementation # dependencies (inheritance, containment, and class references variables) of the # class with other documented classes. Explicit enabling a collaboration graph, @@ -2612,7 +2647,7 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for # groups, showing the direct groups dependencies. Explicit enabling a group # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means # of the command \groupgraph. Disabling a directory graph can be accomplished by @@ -2623,7 +2658,7 @@ COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2644,10 +2679,19 @@ UML_LOOK = NO UML_LIMIT_NUM_FIELDS = 10 -# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# If the UML_LOOK tag is enabled, field labels are shown along the edge between +# two class nodes. If there are many fields and many nodes the graph may become +# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to +# make the size more manageable. Set this to 0 for no limit. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag UML_LOOK is set to YES. + +UML_MAX_EDGE_LABELS = 10 + +# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS -# tag is set to YES, doxygen will add type and arguments for attributes and -# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# tag is set to YES, Doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen # will not generate fields with class member information in the UML graphs. The # class diagrams will look similar to the default class diagrams but using UML # notation for the relationships. @@ -2675,7 +2719,7 @@ DOT_WRAP_THRESHOLD = 17 TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the +# YES then Doxygen will generate a graph for each documented file showing the # direct and indirect include dependencies of the file with other documented # files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, # can be accomplished by means of the command \includegraph. Disabling an @@ -2686,7 +2730,7 @@ TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing +# set to YES then Doxygen will generate a graph for each documented file showing # the direct and indirect include dependencies of the file with other documented # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set # to NO, can be accomplished by means of the command \includedbygraph. Disabling @@ -2697,7 +2741,7 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2709,7 +2753,7 @@ INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2721,14 +2765,14 @@ CALL_GRAPH = NO CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical # hierarchy of all classes instead of a textual one. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the # dependencies a directory has on other directories in a graphical way. The # dependency relations are determined by the #include relations between the # files in the directories. Explicit enabling a directory graph, when @@ -2751,24 +2795,29 @@ DIR_GRAPH_MAX_DEPTH = 1 # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: # https://www.graphviz.org/)). -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). +# +# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination +# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO). # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and -# png:gdiplus:gdiplus. +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, +# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, +# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, +# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, +# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = png -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. +# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option +# can be set to YES to enable generation of interactive SVG images that allow +# zooming and panning. # # Note that this requires a modern browser other than Internet Explorer. Tested # and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. +# +# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set +# to svg:cairo or svg:cairo:cairo. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2787,7 +2836,7 @@ DOT_PATH = DOTFILE_DIRS = -# You can include diagrams made with dia in doxygen documentation. Doxygen will +# You can include diagrams made with dia in Doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. # If left empty dia is assumed to be found in the default search path. @@ -2800,7 +2849,7 @@ DIA_PATH = DIAFILE_DIRS = -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the # path where java can find the plantuml.jar file or to the filename of jar file # to be used. If left blank, it is assumed PlantUML is not used or called during # a preprocessing step. Doxygen will generate a warning when it encounters a @@ -2808,19 +2857,25 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a -# configuration file for plantuml. +# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for PlantUML. PLANTUML_CFG_FILE = -# When using plantuml, the specified paths are searched for files specified by -# the !include statement in a plantuml block. +# When using PlantUML, the specified paths are searched for files specified by +# the !include statement in a PlantUML block. PLANTUML_INCLUDE_PATH = +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that +# contain PlantUml files that are included in the documentation (see the +# \plantumlfile command). + +PLANTUMLFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized +# larger than this value, Doxygen will truncate the graph, which is visualized # by representing a node as a red box. Note that if the number of direct # children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that @@ -2851,17 +2906,17 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. -# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal # graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate +# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate # files that are used to generate the various graphs. # # Note: This setting is not only used for dot files but also for msc temporary @@ -2870,11 +2925,11 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# You can define message sequence charts within Doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will # use a built-in version of mscgen tool to produce the charts. Alternatively, # the MSCGEN_TOOL tag can also specify the name an external tool. For instance, -# specifying prog as the value, doxygen will call the tool as prog -T +# specifying prog as the value, Doxygen will call the tool as prog -T # -o . The external tool should support # output file formats "png", "eps", "svg", and "ismap". diff --git a/doc/documentation.md b/doc/documentation.md index 9f464e8..e0a5774 100644 --- a/doc/documentation.md +++ b/doc/documentation.md @@ -28,12 +28,14 @@ If you are looking for a specific function, class, etc., try using the search ba Besides storing the `MPI_Group` object, it also provides some convient functions for getting the size of the group, the rank of the current process or for splitting the group based on include rules. -It further contains the convenient function mpi::is_initialized and the static boolean mpi::has_env. +It further contains the convenient functions mpi::is_initialized and mpi::is_finalized and the static boolean +mpi::has_env. ## MPI datatypes and operations @ref mpi_types_ops map various C++ datatypes to MPI datatypes and help the user with registering their own datatypes to be used in MPI communications. + Furthermore, it offers tools to simplify the creation of custom MPI operations usually required in `MPI_Reduce` or `MPI_Accumulate` functions. @@ -71,13 +73,6 @@ Another use-case of @ref mpi_osc_shm is the shared memory aspect by which MPI applications can reduce their memory requirements through the deduplication of replicated data between MPI ranks that are executed on the same SMP node. -## Lazy MPI communication - -@ref mpi_lazy can be used to provied collective MPI communication for lazy expression types. -Most users probably won't need to use this functionality directly. - -We refer the interested reader to [TRIQS/nda](https://triqs.github.io/nda/latest/group__av__mpi.html) for more details. - ## Event handling @ref event_handling provides the mpi::monitor class which can be used to communicate and handle events across multiple diff --git a/doc/ex1.md b/doc/ex1.md index 0785f61..8378bbf 100644 --- a/doc/ex1.md +++ b/doc/ex1.md @@ -4,20 +4,7 @@ In this example, we show how to implement the standard `Hello world` program using **mpi**. -```cpp -#include -#include - -int main(int argc, char *argv[]) { - // initialize MPI environment and communicator - mpi::environment env(argc, argv); - mpi::communicator world; - - // get rank and greet world - int rank = world.rank(); - std::cout << "Hello from processor " << rank << "\n"; -} -``` +@include ex1.cpp Output (depends on the number of processes and the order is arbitrary): diff --git a/doc/ex2.md b/doc/ex2.md index 7d2d728..d437e1f 100644 --- a/doc/ex2.md +++ b/doc/ex2.md @@ -4,52 +4,7 @@ In this example, we show how to use the mpi::monitor class to communicate and process errors across a communicator. -```cpp -#include -#include -#include - -int main(int argc, char *argv[]) { - // initialize MPI environment - mpi::environment env(argc, argv); - mpi::communicator world; - - // initialize monitor - mpi::monitor monitor(world); - - // in case an event has occurred, print some info and return true - auto stop = [&monitor, world](int i) { - bool res = false; - if (monitor.event_on_any_rank()) { - std::cerr << "Processor " << world.rank() << ": After " << i << " steps an event has been communicated.\n"; - res = true; - } - return res; - }; - - // loop as long as no event has occurred - int event_rank = 3; - for (int i = 0; i < 1000000; ++i) { - // report a local event on the event_rank - if (world.rank() == event_rank) { - std::cerr << "Processor " << event_rank << ": Local event reported.\n"; - monitor.report_local_event(); - } - - // should we stop the loop? - if (stop(i)) break; - } - - // check if all processes finished the loop - if (world.rank() == 0) { - if (monitor.event_on_any_rank()) { - std::cout << "Oh no! An event occurred somewhere and the loop has not been finished on all processes.\n"; - } else { - std::cout << "No worries, all processes have finished the loop.\n"; - } - } -} -``` +@include ex2.cpp Output (running with `-n 12`): diff --git a/doc/ex3.md b/doc/ex3.md index 4e4810e..4ca0388 100644 --- a/doc/ex3.md +++ b/doc/ex3.md @@ -2,55 +2,11 @@ [TOC] -In this example, we show how to register a new MPI datatype and how to use mpi::map_C_function and mpi::map_add to -define MPI operations for it. +In this example, we show +- how to register a new MPI datatype by providing a `tie_data` function for our C++ type and +- how to use mpi::map_C_function and mpi::map_add to define MPI operations for it. -```cpp -#include -#include - -// define a custom complex type -struct my_complex { - double real; - double imag; -}; - -// define an addition for my_complex -inline my_complex operator+(const my_complex& z1, const my_complex& z2) { - return { z1.real + z2.real, z1.imag + z2.imag }; -} - -// define a tie_data function for my_complex to make it MPI compatible -inline auto tie_data(const my_complex& z) { - return std::tie(z.real, z.imag); -} - -int main(int argc, char *argv[]) { - // initialize MPI environment - mpi::environment env(argc, argv); - mpi::communicator world; - - // create complex number z - my_complex z = { world.rank() + 1.0, static_cast(world.rank()) }; - - // sum z over all processes - auto sum = mpi::reduce(z, world, 0, false, mpi::map_add()); - - // define a product for my_complex - auto my_product = [](const my_complex& z1, const my_complex& z2) { - return my_complex { z1.real * z2.real - z1.imag * z2.imag, z1.real * z2.imag + z1.imag * z2.real }; - }; - - // multiply z over all processes - auto product = mpi::reduce(z, world, 0, false, mpi::map_C_function()); - - // print result - if (world.rank() == 0) { - std::cout << "sum = (" << sum.real << ", " << sum.imag << ")\n"; - std::cout << "product = (" << product.real << ", " << product.imag << ")\n"; - } -} -``` +@include ex3.cpp Output (running with `-n 5`): diff --git a/doc/ex4.md b/doc/ex4.md index 7d619d5..ef8c275 100644 --- a/doc/ex4.md +++ b/doc/ex4.md @@ -4,48 +4,7 @@ In this example, we show how to write a specialized `mpi_reduce_into` for a custom type. -```cpp -#include -#include -#include - -// Custom type. -class foo { - public: - // Constructor. - foo(int x = 5) : x_(x) {} - - // Get the value stored in the class. - int x() const { return x_; } - - // Specialization of mpi_reduce_into for the custom type. - friend void mpi_reduce_into(foo const &f_in, foo &f_out, mpi::communicator c = {}, int root = 0, bool all = false, MPI_Op op = MPI_SUM) { - mpi::reduce_into(f_in.x_, f_out.x_, c, root, all, op); - } - - private: - int x_; -}; - -int main(int argc, char *argv[]) { - // initialize MPI environment - mpi::environment env(argc, argv); - mpi::communicator world; - - // create a vector of foo objects - std::vector vec {foo{1}, foo{2}, foo{3}, foo{4}, foo{5}}; - - // reduce the vector of foo objects - auto result = mpi::reduce(vec, world); - - // print the result on rank 0 - if (world.rank() == 0) { - std::cout << "Reduced vector: "; - for (auto const &f : result) std::cout << f.x() << " "; - std::cout << "\n"; - } -} -``` +@include ex4.cpp Output (running with `-n 4`): diff --git a/doc/examples.md b/doc/examples.md index 2b85e2a..945247c 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -11,7 +11,7 @@ All examples have been compiled on a MacBook Pro with an Apple M2 Max chip and [open-mpi](https://www.open-mpi.org/) 5.0.1. -We further used clang 19.1.7 together with cmake 3.31.5. +We further used clang 21.1.2 together with cmake 4.1.2. Assuming that the actual example code is in a file `main.cpp`, the following generic `CMakeLists.txt` should work for all examples: @@ -31,7 +31,7 @@ include (FetchContent) FetchContent_Declare( mpi GIT_REPOSITORY https://github.com/TRIQS/mpi.git - GIT_TAG 1.3.x + GIT_TAG 2.0.x ) FetchContent_MakeAvailable(mpi) diff --git a/doc/examples/CMakeLists.txt b/doc/examples/CMakeLists.txt new file mode 100644 index 0000000..ad719f7 --- /dev/null +++ b/doc/examples/CMakeLists.txt @@ -0,0 +1,8 @@ +# List of all examples +file(GLOB_RECURSE all_examples RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp) + +foreach(ex_src ${all_examples}) + get_filename_component(ex_name ${ex_src} NAME_WE) + add_executable(${ex_name} ${ex_src}) + target_link_libraries(${ex_name} mpi::mpi_c) +endforeach() \ No newline at end of file diff --git a/doc/examples/ex1.cpp b/doc/examples/ex1.cpp new file mode 100644 index 0000000..827d4a8 --- /dev/null +++ b/doc/examples/ex1.cpp @@ -0,0 +1,12 @@ +#include +#include + +int main(int argc, char *argv[]) { + // initialize MPI environment and communicator + mpi::environment env(argc, argv); + mpi::communicator world; + + // get rank and greet world + int rank = world.rank(); + std::cout << "Hello from processor " << rank << "\n"; +} \ No newline at end of file diff --git a/doc/examples/ex2.cpp b/doc/examples/ex2.cpp new file mode 100644 index 0000000..2438cb2 --- /dev/null +++ b/doc/examples/ex2.cpp @@ -0,0 +1,44 @@ +#include +#include +#include + +int main(int argc, char *argv[]) { + // initialize MPI environment + mpi::environment env(argc, argv); + mpi::communicator world; + + // initialize monitor + mpi::monitor monitor(world); + + // in case an event has occurred, print some info and return true + auto stop = [&monitor, world](int i) { + bool res = false; + if (monitor.event_on_any_rank()) { + std::cerr << "Processor " << world.rank() << ": After " << i << " steps an event has been communicated.\n"; + res = true; + } + return res; + }; + + // loop as long as no event has occurred + int event_rank = 3; + for (int i = 0; i < 1000000; ++i) { + // report a local event on the event_rank + if (world.rank() == event_rank) { + std::cerr << "Processor " << event_rank << ": Local event reported.\n"; + monitor.report_local_event(); + } + + // should we stop the loop? + if (stop(i)) break; + } + + // check if all processes finished the loop + if (world.rank() == 0) { + if (monitor.event_on_any_rank()) { + std::cout << "Oh no! An event occurred somewhere and the loop has not been finished on all processes.\n"; + } else { + std::cout << "No worries, all processes have finished the loop.\n"; + } + } +} \ No newline at end of file diff --git a/doc/examples/ex3.cpp b/doc/examples/ex3.cpp new file mode 100644 index 0000000..a73286e --- /dev/null +++ b/doc/examples/ex3.cpp @@ -0,0 +1,40 @@ +#include +#include + +// define a custom complex type +struct my_complex { + double real; + double imag; +}; + +// define an addition for my_complex +inline auto operator+(const my_complex &z1, const my_complex &z2) { return my_complex{.real = z1.real + z2.real, .imag = z1.imag + z2.imag}; } + +// define a tie_data function for my_complex to make it MPI compatible +inline auto tie_data(const my_complex &z) { return std::tie(z.real, z.imag); } + +int main(int argc, char *argv[]) { + // initialize MPI environment + mpi::environment env(argc, argv); + mpi::communicator world; + + // create complex number z + my_complex z = {.real = world.rank() + 1.0, .imag = static_cast(world.rank())}; + + // sum z over all processes + auto sum = mpi::reduce(z, world, 0, false, mpi::map_add()); + + // define a product for my_complex + auto my_product = [](const my_complex &z1, const my_complex &z2) { + return my_complex{.real = z1.real * z2.real - z1.imag * z2.imag, .imag = z1.real * z2.imag + z1.imag * z2.real}; + }; + + // multiply z over all processes + auto product = mpi::reduce(z, world, 0, false, mpi::map_C_function()); + + // print result + if (world.rank() == 0) { + std::cout << "sum = (" << sum.real << ", " << sum.imag << ")\n"; + std::cout << "product = (" << product.real << ", " << product.imag << ")\n"; + } +} \ No newline at end of file diff --git a/doc/examples/ex4.cpp b/doc/examples/ex4.cpp new file mode 100644 index 0000000..534d4f3 --- /dev/null +++ b/doc/examples/ex4.cpp @@ -0,0 +1,40 @@ +#include +#include +#include + +// Custom type. +class foo { + public: + // Constructor. + foo(int x = 5) : x_(x) {} + + // Get the value stored in the class. + [[nodiscard]] int x() const { return x_; } + + // Specialization of mpi_reduce_into for the custom type. + friend void mpi_reduce_into(foo const &f_in, foo &f_out, mpi::communicator c = {}, int root = 0, bool all = false, MPI_Op op = MPI_SUM) { + mpi::reduce_into(f_in.x_, f_out.x_, c, root, all, op); + } + + private: + int x_; +}; + +int main(int argc, char *argv[]) { + // initialize MPI environment + mpi::environment env(argc, argv); + mpi::communicator world; + + // create a vector of foo objects + std::vector vec{foo{1}, foo{2}, foo{3}, foo{4}, foo{5}}; + + // reduce the vector of foo objects + auto result = mpi::reduce(vec, world); + + // print the result on rank 0 + if (world.rank() == 0) { + std::cout << "Reduced vector: "; + for (auto const &f : result) std::cout << f.x() << " "; + std::cout << "\n"; + } +} \ No newline at end of file diff --git a/doc/groups.dox b/doc/groups.dox index c2ae3d8..8024293 100644 --- a/doc/groups.dox +++ b/doc/groups.dox @@ -3,31 +3,7 @@ * @brief Simplify the initialization/finalization of an MPI environment and the usage of an `MPI_Comm` object * by wrapping it in a C++ class. * - * @details A typical `Hello world!` program using mpi::environment and mpi::communicator is as easy as: - * - * @code{.cpp} - * #include - * #include - * - * int main(int argc, char** argv) { - * // initialize MPI environment - * mpi::environment env(argc, argv); - * mpi::communicator world; - * - * // get rank and greet world - * int rank = world.rank(); - * std::cout << "Hello from processor " << rank << "\n"; - * } - * @endcode - * - * Output (depends on the number of processes and the order is arbitrary): - * - * ``` - * Hello from processor 2 - * Hello from processor 3 - * Hello from processor 0 - * Hello from processor 1 - * ``` + * @details A typical `Hello world!` program using mpi::environment and mpi::communicator can be found in @ref ex1. */ /** @@ -37,10 +13,10 @@ * * @details The following functionality is provided: * - * - mpi::mpi_type and its specializations let **mpi** know that a certain type `T` can be used in MPI communications. - * The user is allowed to implement their own MPI compatible types and provide a specializtion of mpi::mpi_type. - * - mpi::get_mpi_type maps a given C++ type to its corresponding MPI datatype and mpi::has_mpi_type checks if a given - * type has a corresponding MPI datatype. + * - mpi::mpi_type and its specializations let **mpi** know that a certain type C++ `T` can be used in MPI + * communications. The user is allowed to implement their own MPI compatible types and provide a specializtion of + * mpi::mpi_type. Its static member function `get` maps the C++ type `T` to its corresponding MPI datatype. + * - mpi::has_mpi_type checks if a given type has a corresponding MPI datatype. * - mpi::map_add and mpi::map_C_function can help the user to implement custom MPI operations. * * See @ref ex3 for a detailed example. @@ -100,46 +76,12 @@ * @details The primary usage is the shared memory to deduplicate data that is shared by all MPI ranks. */ -/** - * @defgroup mpi_lazy Lazy MPI communication - * @brief Allow specific types to use lazy MPI communication. - * - * @details Please look at the MPI interface in the [nda library](https://triqs.github.io/nda/latest/group__av__mpi.html) - * for more details. - */ - /** * @defgroup event_handling Event handling * @brief Communicate and handle events across multiple processes. * - * @details A typical use case for the mpi::monitor class could be to monitor and communicate exceptions: - * - * @code{.cpp} - * // initialize monitor - * mpi::monitor monitor(world); - * ... - * - * // loop as long as everything is fine - * while (!monitor.event_on_any_rank()) { - * try { - * // do some work - * ... - * } catch (my_exception const &e) { - * // report an exception - * monitor.report_local_event(); - * } - * } - * - * // finalize communications and check if the computation finished due to an exception - * monitor.finalize_communications(); - * if (!monitor.event_on_any_rank()) { - * // do some clean up and maybe stop the program - * ... - * } - * - * // everything went smoothly - * ... - * @endcode + * @details A typical use case for the mpi::monitor class could be to monitor and communicate exceptions. A simple + * example can be found in @ref ex2. */ /** diff --git a/doc/installation.md b/doc/installation.md index 2ac3c37..bb4c2a6 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -13,11 +13,15 @@ into your own C++ project. @section dependencies Dependencies -The dependencies of **mpi** are as follows: +The dependencies of the C++ **mpi** library are as follows: -* gcc version 12 or later OR clang version 15 or later OR IntelLLVM (icx) 2023.1.0 or later -* CMake version 3.20 or later (for installation or integration into an existing project via CMake) -* a working MPI implementation (openmpi and Intel MPI are tested) +* C++20 compatible compiler +* CMake version 3.20 +* MPI library + +We do not provide explicit version requirements. +Instead, we refer the user to the **mpi** CI builds on [GitHub Actions](https://github.com/TRIQS/mpi/actions), where +recent OS, MPI and compiler versions are tested. @section install_steps Installation steps diff --git a/doc/integration.md b/doc/integration.md index 3e844bb..c01f997 100644 --- a/doc/integration.md +++ b/doc/integration.md @@ -33,7 +33,7 @@ include(FetchContent) FetchContent_Declare( mpi GIT_REPOSITORY https://github.com/TRIQS/mpi.git - GIT_TAG 1.3.x + GIT_TAG 2.0.x ) FetchContent_MakeAvailable(mpi)