boost/container
2
0
Fork 0
mirror of https://github.com/boostorg/container.git synced 2026-01-19 04:02:17 +00:00
Code Issues Projects Releases Wiki Activity

Fix transparent "erase" documentation

Browse Source
This commit is contained in:
Ion Gaztañaga
2025-11-05 13:49:05 +01:00
parent 4f7c7d0381
commit 5610e49409
4 changed files with 28 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/boost/container/flat_map.hpp
View File

@@ -1346,9 +1346,9 @@ class flat_map
(m_flat_tree.erase(dtl::force_copy<impl_const_iterator>(p)));
}
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//! <b>Effects</b>: If present, erases the elements in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
//!
//! <b>Complexity</b>: Logarithmic search time plus erasure time
//! linear to the elements with bigger keys.
@@ -1358,9 +1358,9 @@ class flat_map
//! <b>Requires</b>: This overload is available only if
//! key_compare::is_transparent exists.
//!
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//! <b>Effects</b>: If present, erases the elements in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
template <class K>
inline BOOST_CONTAINER_DOC1ST
(size_type

2
include/boost/container/flat_set.hpp
View File

@@ -770,7 +770,7 @@ class flat_set
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
//!
//! <b>Complexity</b>: Logarithmic search time plus erasure time
//! linear to the elements with bigger keys.

12
include/boost/container/map.hpp
View File

@@ -1010,9 +1010,9 @@ class map
#endif // !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//! <b>Effects</b>: If present, erases the elements in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
//!
//! <b>Complexity</b>: log(size()) + count(k)
inline size_type erase(const key_type& x)
@@ -1021,9 +1021,9 @@ class map
//! <b>Requires</b>: This overload is available only if
//! key_compare::is_transparent exists.
//!
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//! <b>Effects</b>: If present, erases the elements in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
template <class K>
inline BOOST_CONTAINER_DOC1ST
(size_type
@@ -2030,6 +2030,10 @@ class multimap
//! @copydoc ::boost::container::set::erase(const_iterator,const_iterator)
iterator erase(const_iterator first, const_iterator last);
//! @copydoc ::boost::container::set::erase(K&&)
template<class K>
size_type erase(K && k);
#endif
//! @copydoc ::boost::container::map::extract(const key_type&)

17
include/boost/container/set.hpp
View File

@@ -681,9 +681,9 @@ class set
inline void merge(BOOST_RV_REF_BEG multiset<Key, C2, Allocator, Options> BOOST_RV_REF_END source)
{ return this->merge(static_cast<multiset<Key, C2, Allocator, Options>&>(source)); }
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//! <b>Effects</b>: If present, erases the elements in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements (0/1).
//! <b>Returns</b>: Returns the number of erased elements.
//!
//! <b>Complexity</b>: log(size()) + count(k)
inline size_type erase(const key_type& x)
@@ -707,6 +707,15 @@ class set
//! <b>Complexity</b>: log(size())+N where N is the distance from first to last.
iterator erase(const_iterator first, const_iterator last);
//! <b>Requires</b>: This overload is available only if
//! key_compare::is_transparent exists.
//!
//! <b>Effects</b>: If present, erases the element in the container with key equivalent to x.
//!
//! <b>Returns</b>: Returns the number of erased elements.
template<class K>
size_type erase(K && k);
//! @copydoc ::boost::container::map::extract(const_iterator)
node_type extract(const_iterator p);
@@ -1489,6 +1498,10 @@ class multiset
//! @copydoc ::boost::container::set::erase(const_iterator,const_iterator)
iterator erase(const_iterator first, const_iterator last);
//! @copydoc ::boost::container::set::erase(K&&)
template<class K>
size_type erase(K && k);
//! @copydoc ::boost::container::multimap::extract(const_iterator)
node_type extract(const_iterator p);