Skip to content

Commit

Permalink
#1913: add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stmcgovern authored and lifflander committed Sep 13, 2022
1 parent bc37282 commit 11a134f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/vt/pool/static_sized/memory_pool_equal.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <int64_t num_bytes_t, bool use_header = true>
struct MemoryPoolEqual {
using ContainerType = std::vector<void*>;
Expand All @@ -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();
Expand Down

0 comments on commit 11a134f

Please sign in to comment.