feedc0de/boost_unordered
1
0
Fork 0
forked from boostorg/unordered
Code Pull Requests Activity

Update reference docs for erase() to include heterogeneous overloads

Browse Source
This commit is contained in:
Christian Mazakas
2022-01-06 15:29:40 -08:00
parent b6b334dd16
commit 19673e3b1c
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/ref.php
View File

@ -1116,6 +1116,32 @@ EOL;
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
</method>
<method name="erase">
<template>
<template-type-parameter name="K" />
</template>
<parameter name="k">
<paramtype>K&amp;&amp;</paramtype>
</parameter>
<type>size_type</type>
<returns>
<para>The number of elements erased.</para>
</returns>
<throws>
<para>Only throws an exception if it is thrown by <code>hasher</code> or <code>key_equal</code>.</para>
</throws>
<description>
<para>Erase all elements with key equivalent to <code>k</code>.</para>
<para>
This overload only participates in overload resolution if <code>Hash::is_transparent</code>
and <code>Pred::is_transparent</code> are valid member typedefs and neither <code>iterator</code>
nor <code>const_iterator</code> are implicitly convertible from <code>K</code>. The library
assumes that <code>Hash</code> is callable with both <code>K</code> and <code>Key</code> and
that <code>Pred</code> is transparent. This enables heterogeneous lookup which avoids the cost of
instantiating an instance of the <code>Key</code> type.
</para>
</description>
</method>
<method name="erase">
<parameter name="first">
<paramtype>const_iterator</paramtype>