feedc0de/boost_intrusive
1
0
Fork 0
forked from boostorg/intrusive
Code Pull Requests Activity

Documentation fixes.

Browse Source
This commit is contained in:
Ion Gaztañaga
2015-01-02 18:36:04 +01:00
parent 12ee566796
commit 9d70abed82
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/intrusive.qbk
View File

@@ -1527,7 +1527,7 @@ guarantees, this caching effect is not updated when const versions of
search functions like `find()`, `lower_bound()`, `upper_bound()`, `equal_range()`, search functions like `find()`, `lower_bound()`, `upper_bound()`, `equal_range()`,
`count()`... are called. This means that using splay-tree based associative containers as drop-in `count()`... are called. This means that using splay-tree based associative containers as drop-in
replacements of [classref boost::intrusive::set set]/ replacements of [classref boost::intrusive::set set]/
[classref boost::intrusive::multiset multiset], specially for const search functions, [classref boost::intrusive::multiset multiset], specially for const search functions,
might not result in desired performance improvements. might not result in desired performance improvements.
If element searches are randomized, the tree will be continuously srebalanced If element searches are randomized, the tree will be continuously srebalanced
@@ -1577,7 +1577,7 @@ And they also can receive an additional option:
[section:splay_set_multiset_example Example] [section:splay_set_multiset_example Example]
Now let's see a small example using Now let's see a small example using
[classref boost::intrusive::splay_set splay_set]/ [classref boost::intrusive::splay_set splay_set]/
[classref boost::intrusive::splay_multiset splay_multiset] [classref boost::intrusive::splay_multiset splay_multiset]
containers: containers:
@@ -3261,8 +3261,8 @@ Thus [*Boost.Intrusive] offers its own `SCARY iterator` implementation, where it
change when the container is configured with an option that does not alter the value <-> node transformation. change when the container is configured with an option that does not alter the value <-> node transformation.
More concretely, the following options and conditions guarantee that iterator types are unchanged: More concretely, the following options and conditions guarantee that iterator types are unchanged:
* [*All containers]: `size_type<>`, `constant_time_size<>`, * [*All containers]: `size_type<>`, `constant_time_size<>`,
* [*`slist`]: `cache_last<>`, `linear<>`, * [*`slist`]: `cache_last<>`, `linear<>`,
* [*`unordered_[multi]set`]: `hash<>`, `equal<>`, `power_2_buckets<>`, `cache_begin<>`. * [*`unordered_[multi]set`]: `hash<>`, `equal<>`, `power_2_buckets<>`, `cache_begin<>`.
* [*All tree-like containers] (`[multi]set`, `avl_[multi]set`, `sg_[multi]set`, `bs_[multi]set`, * [*All tree-like containers] (`[multi]set`, `avl_[multi]set`, `sg_[multi]set`, `bs_[multi]set`,
`splay_[multi]set`, `treap_[multi]set`): `compare<>`. `splay_[multi]set`, `treap_[multi]set`): `compare<>`.
@@ -3752,7 +3752,7 @@ The disperse list is again the slowest.
Intrusive containers can offer performance benefits that cannot be achieved with Intrusive containers can offer performance benefits that cannot be achieved with
equivalent non-intrusive containers. Memory locality improvements are noticeable equivalent non-intrusive containers. Memory locality improvements are noticeable
when the objects to be inserted are small. Minimizing memory allocation/deallocation calls is also when the objects to be inserted are small. Minimizing memory allocation/deallocation calls is also
an important factor and intrusive containers make this simple if all objects an important factor and intrusive containers make this simple if all objects
to be inserted in intrusive containers are allocated using `std::vector` or `std::deque`. to be inserted in intrusive containers are allocated using `std::vector` or `std::deque`.
[endsect] [endsect]