Skip to content

Commit

Permalink
clarify chunk vs elem size
Browse files Browse the repository at this point in the history
  • Loading branch information
liss-h committed Jan 17, 2025
1 parent 4b1830c commit 2083d24
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion include/dice/template-library/pool_allocator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ namespace dice::template_library {
* An allocation will be placed into the first bucket where it can fit.
* Allocations that do not fit into any bucket are fulfilled with calls to `new`.
*
* @tparam bucket_sizes allocation sizes (in bytes) for the underlying arenas
* @tparam bucket_sizes allocation sizes for individual elements (in bytes) for the underlying arenas.
* Each size provided here is used to configure the element size of a single arena.
* Importantly, it is **not** the arena chunk size, rather it is the size of elements being placed into the arena.
* The chunk size itself cannot be configured, it is automatically determined by boost::pool.
*/
template<size_t ...bucket_sizes>
struct pool;
Expand Down

0 comments on commit 2083d24

Please sign in to comment.