Skip to content

Commit 608bcb4

Browse files
authored
Merge pull request #291 from Lastique/patch-1
Improve description of stored_size
2 parents af58c7d + fc81064 commit 608bcb4

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

doc/container.qbk

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[/
2-
/ Copyright (c) 2009-2020 Ion Gazta�aga
2+
/ Copyright (c) 2009-2020 Ion Gaztañaga
33
/
44
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
55
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -743,10 +743,10 @@ the last template parameter and defined using the utility class
743743
[classref boost::container::growth_factor_100 growth_factor_100].
744744

745745
* [classref boost::container::stored_size stored_size]: the type that will be used to store size-related
746-
parameters inside of the vector. Sometimes, when the maximum capacity to be used is much less than the
747-
theoretical maximum that a vector can hold, it's interesting to use smaller unsigned integer types to represent
748-
`size()` and `capacity()` inside vector, so that the size of an empty vector is minimized and cache
749-
performance might be improved. See [classref boost::container::stored_size stored_size] for more details.
746+
parameters inside the vector. Sometimes, when the maximum vector capacity to be used is much less than
747+
`std::size_t` capacity, it may be beneficial to use a smaller unsigned integer type to represent
748+
`size()` and `capacity()` values inside the vector, so that the size of an empty vector object is minimized and cache
749+
performance is possibly improved. See [classref boost::container::stored_size stored_size] for more details.
750750

751751
See the following example to see how [classref boost::container::vector_options vector_options] can be
752752
used to customize `vector`:
@@ -767,14 +767,14 @@ the last template parameter and defined using the utility class
767767

768768
* [classref boost::container::throw_on_overflow throw_on_overflow]: A boolean that specifies if the
769769
container should throw an exception when the compile-time capacity is not enough to hold the requesteed number
770-
of objects. When "false", if the capacit is overflowed, the implementation calls to BOOST_ASSERT and if that assertion
770+
of objects. When "false", if the capacit is overflowed, the implementation calls to `BOOST_ASSERT` and if that assertion
771771
does not throw or abort, undefined behavior is triggered.
772772

773773
* [classref boost::container::stored_size stored_size]: the type that will be used to store size-related
774-
parameters inside of the vector. Sometimes, when the static to be used is much less than `std::size_t`
775-
it's interesting to use a smaller unsigned integer types to represent `size()` inside `static_vector``,
776-
so that the size of an empty vector is minimized and cache
777-
performance might be improved. See [classref boost::container::stored_size stored_size] for more details.
774+
parameters inside the vector. Sometimes, when the static size to be used is much less than `std::size_t` capacity,
775+
it may be beneficial to use a smaller unsigned integer type to represent the `size()` value inside `static_vector`,
776+
so that the object size of an empty vector is minimized and cache
777+
performance is possibly improved. See [classref boost::container::stored_size stored_size] for more details.
778778

779779
See the following example to see how [classref boost::container::static_vector_options static_vector_options] can be
780780
used to customize `static_vector`:
@@ -804,10 +804,10 @@ the last template parameter and defined using the utility class
804804
[classref boost::container::growth_factor_50 growth_factor_100].
805805

806806
* [classref boost::container::stored_size stored_size]: the type that will be used to store size-related
807-
parameters inside of the vector. Sometimes, when the maximum capacity to be used is much less than the
808-
theoretical maximum that a vector can hold, it's interesting to use smaller unsigned integer types to represent
809-
`size()` and `capacity()` inside vector, so that the size of an empty vector is minimized and cache
810-
performance might be improved. See [classref boost::container::stored_size stored_size] for more details.
807+
parameters inside the vector. Sometimes, when the maximum vector capacity to be used is much less than
808+
`std::size_t` capacity, it may be beneficial to use a smaller unsigned integer type to represent
809+
`size()` and `capacity()` values inside the vector, so that the size of an empty vector object is minimized and cache
810+
performance is possibly improved. See [classref boost::container::stored_size stored_size] for more details.
811811

812812
See the following example to see how [classref boost::container::small_vector_options small_vector_options] can be
813813
used to customize `small_vector`:
@@ -858,10 +858,10 @@ the last template parameter and defined using the utility class
858858
[classref boost::container::growth_factor_100 growth_factor_100].
859859

860860
* [classref boost::container::stored_size stored_size]: the type that will be used to store size-related
861-
parameters inside of the devector. Sometimes, when the maximum capacity to be used is much less than the
862-
theoretical maximum that a devector can hold, it's interesting to use smaller unsigned integer types to represent
863-
`size()` and `capacity()` inside devector, so that the size of an empty devector is minimized and cache
864-
performance might be improved. See [classref boost::container::stored_size stored_size] for more details.
861+
parameters inside of the devector. Sometimes, when the maximum devector capacity to be used is much less than
862+
`std::size_t` capacity, it may be beneficial to use a smaller unsigned integer type to represent
863+
`size()` and `capacity()` values inside the devector, so that the size of an empty devector object is minimized and cache
864+
performance is possibly improved. See [classref boost::container::stored_size stored_size] for more details.
865865

866866
* [classref boost::container::relocate_on_66 relocate_on_XX]: load factor limit that will determine if
867867
new memory should be allocated or elements should relocated inside existing memory, when the free space

0 commit comments

Comments
 (0)