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

Update reference docs for find() to include heterogeneous overloads

Browse Source
This commit is contained in:
Christian Mazakas
2022-01-06 15:27:18 -08:00
parent 6c74aa0289
commit cd56cae032
1 changed files with 39 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/ref.php
View File

@ -1272,6 +1272,24 @@ EOL;
</parameter> </parameter>
<type>const_iterator</type> <type>const_iterator</type>
</signature> </signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="k">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>iterator</type>
</signature>
<signature cv="const">
<template>
<template-type-parameter name="K" />
</template>
<parameter name="k">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>const_iterator</type>
</signature>
<signature> <signature>
<template> <template>
<template-type-parameter name="CompatibleKey"/> <template-type-parameter name="CompatibleKey"/>
@ -1309,13 +1327,27 @@ EOL;
<returns> <returns>
<para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para> <para>An iterator pointing to an element with key equivalent to <code>k</code>, or <code>b.end()</code> if no such element exists.</para>
</returns> </returns>
<notes><para> <notes>
The templated overloads are a non-standard extensions which <para>
allows you to use a compatible hash function and equality The templated overloads containing <code>CompatibleKey</code>,
predicate for a key of a different type in order to avoid <code>CompatibleHash</code> and <code>CompatiblePredicate</code>
an expensive type cast. In general, its use is not encouraged. are non-standard extensions which allow you to use a compatible
</para></notes> hash function and equality predicate for a key of a different type
</overloaded-method> in order to avoid an expensive type cast. In general, its use is
not encouraged and instead the <code>K</code> member function
templates should be used.
</para>
<para>
The <code>template &lt;typename K&gt;</code> overloads only participate
in overload resolution if <code>Hash::is_transparent</code> and
<code>Pred::is_transparent</code> are valid member typedefs. 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>
</notes>
</overloaded-method>
<method name="count" cv="const"> <method name="count" cv="const">
<parameter name="k"> <parameter name="k">
<paramtype>key_type const&amp;</paramtype> <paramtype>key_type const&amp;</paramtype>