From 780372bc7958934c431de0233b19b85067f20b3d Mon Sep 17 00:00:00 2001 From: William Throwe Date: Wed, 25 May 2022 14:20:41 -0400 Subject: [PATCH] Document small_vector allocation strategy --- include/boost/container/small_vector.hpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/boost/container/small_vector.hpp b/include/boost/container/small_vector.hpp index f80e6e9..a3fb4a6 100644 --- a/include/boost/container/small_vector.hpp +++ b/include/boost/container/small_vector.hpp @@ -541,6 +541,9 @@ struct small_vector_storage_definer //! //! All `boost::container::vector` member functions are inherited. See `vector` documentation for details. //! +//! Any change to the capacity of the vector, including decreasing its size such as with the shrink_to_fit method, will +//! cause the vector to permanently switch to dynamically allocated storage. +//! //! \tparam T The type of object that is stored in the small_vector //! \tparam N The number of preallocated elements stored inside small_vector. It shall be less than Allocator::max_size(); //! \tparam Allocator The allocator used for memory management when the number of elements exceeds N. Use void