diff --git a/src/vt/pool/static_sized/memory_pool_equal.h b/src/vt/pool/static_sized/memory_pool_equal.h index a83b6f44c7..8fa59862f9 100644 --- a/src/vt/pool/static_sized/memory_pool_equal.h +++ b/src/vt/pool/static_sized/memory_pool_equal.h @@ -64,6 +64,16 @@ static constexpr size_t const medium_msg_size_buf = static constexpr size_t const memory_size_medium = sizeof(EpochTagEnvelope) + medium_msg_size_buf; + + + +/** + * \struct MemoryPoolEqual + * + * \brief Memory pool based on size and whether to use the header. + * The header contains additional information about messages + * that may not always be needed. + */ template struct MemoryPoolEqual { using ContainerType = std::vector; @@ -73,7 +83,11 @@ struct MemoryPoolEqual { static constexpr SlotType const fst_pool_slot = 0; static constexpr SlotType const default_pool_size = 1024; - + /** + * \brief Construct a memory pool + * + * \param[in] in_pool_size the size of the pool in bytes + */ MemoryPoolEqual(SlotType const in_pool_size = default_pool_size); virtual ~MemoryPoolEqual();