Fixes #42 ("Documentation does not describe treap priority_of_value changes")

This commit is contained in:
Ion Gaztañaga
2019-06-09 01:01:49 +02:00
parent 338bfb9072
commit 3b5001f22f
3 changed files with 10 additions and 4 deletions

View File

@@ -1852,9 +1852,14 @@ And they also can receive additional options:
in containers. The comparison functor must induce a strict weak ordering.
Default: `compare< std::less<key_type> >`
* [*`priority_of_value<class PriorityOfValue>`]: A function object
that specifies the type of the priority (`priority_type`) of a treap
container and an operator to obtain it from a value type.
Default: `priority_type` is equal to `value_type` (set-like interface).
* [*`priority<class PriorityCompare>`]: Priority Comparison function for the objects to be inserted
in containers. The comparison functor must induce a strict weak ordering.
Default: `priority< priority_compare<key_type> >`
Default: `priority< priority_compare<priority_type> >`
* [*`key_of_value<class KeyOfValueFunctionObject>`]: A function object that will
define the `key_type` of the value type to be stored. This type will allow a map-like interface. See
@@ -3884,6 +3889,7 @@ to be inserted in intrusive containers are allocated using `std::vector` or `std
[section:release_notes_boost_1_71_00 Boost 1.71 Release]
* Fixed bugs:
* [@https://github.com/boostorg/intrusive/pull/42 GitHub #42: ['Documentation does not describe treap priority_of_value changes]]
* [@https://github.com/boostorg/intrusive/pull/43 GitHub #43: ['Fix tests with BOOST_INTRUSIVE_VARIADIC_TEMPLATES enabled]]
* [@https://github.com/boostorg/intrusive/pull/45 GitHub #45: ['Disable variadic templates for MSVC-12 to avoid ICEs]]

View File

@@ -82,7 +82,7 @@ struct treap_tag;
//! The container supports the following options:
//! \c base_hook<>/member_hook<>/value_traits<>,
//! \c constant_time_size<>, \c size_type<>,
//! \c compare<> and \c priority_compare<>
//! \c compare<>, \c priority<> and \c priority_of_value<>
#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
template<class T, class ...Options>
#else

View File

@@ -41,7 +41,7 @@ class treap_multiset_impl;
//! The container supports the following options:
//! \c base_hook<>/member_hook<>/value_traits<>,
//! \c constant_time_size<>, \c size_type<>,
//! \c compare<> and \c priority_compare<>
//! \c compare<>, \c priority<> and \c priority_of_value<>
#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
template<class T, class ...Options>
#else
@@ -600,7 +600,7 @@ class treap_set
//! The container supports the following options:
//! \c base_hook<>/member_hook<>/value_traits<>,
//! \c constant_time_size<>, \c size_type<>,
//! \c compare<> and \c priority_compare<>
//! \c compare<>, \c priority<> and \c priority_of_value<>
#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
template<class T, class ...Options>
#else