Skip to content

Commit 2083d24

Browse files
committed
clarify chunk vs elem size
1 parent 4b1830c commit 2083d24

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

include/dice/template-library/pool_allocator.hpp

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ namespace dice::template_library {
1818
* An allocation will be placed into the first bucket where it can fit.
1919
* Allocations that do not fit into any bucket are fulfilled with calls to `new`.
2020
*
21-
* @tparam bucket_sizes allocation sizes (in bytes) for the underlying arenas
21+
* @tparam bucket_sizes allocation sizes for individual elements (in bytes) for the underlying arenas.
22+
* Each size provided here is used to configure the element size of a single arena.
23+
* Importantly, it is **not** the arena chunk size, rather it is the size of elements being placed into the arena.
24+
* The chunk size itself cannot be configured, it is automatically determined by boost::pool.
2225
*/
2326
template<size_t ...bucket_sizes>
2427
struct pool;

0 commit comments

Comments
 (0)