From ad69850bb84a2270d9f66e9fa2523c600923eb34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= Date: Wed, 1 Oct 2025 22:19:34 +0200 Subject: [PATCH] Add "stored_size" option to the "Configurable deques" chapter --- doc/container.qbk | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/container.qbk b/doc/container.qbk index cd4a23e..435f7bd 100644 --- a/doc/container.qbk +++ b/doc/container.qbk @@ -834,6 +834,13 @@ Only one of these paratemers can be specified: If this option is specified, `deque::get_block_size()` will return the specified `block_size`. A value of zero means the default value. +* [classref boost::container::stored_size stored_size]: the type that will be used to store size-related + parameters inside the deque. Sometimes, when the maximum deque capacity to be used is much less than + `std::size_t` capacity, it may be beneficial to use a smaller unsigned integer type to represent + positions and offsets inside the deque, so that the size of an empty deque object is minimized and cache + performance is possibly improved. See [classref boost::container::stored_size stored_size] for more details. + + See the following example to see how [classref boost::container::deque_options deque_options] can be used to customize `deque`: