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

Update docs for equal_range() to include heterogeneous overloads

Browse Source
This commit is contained in:
Christian Mazakas
2022-01-06 15:28:37 -08:00
parent 49b630c2d4
commit a8443abe80
1 changed files with 31 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
doc/ref.php
View File

@ -1392,12 +1392,41 @@ EOL;
</parameter> </parameter>
<type>std::pair&lt;const_iterator, const_iterator&gt;</type> <type>std::pair&lt;const_iterator, const_iterator&gt;</type>
</signature> </signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="k">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>std::pair&lt;iterator, iterator&gt;</type>
</signature>
<signature cv="const">
<template>
<template-type-parameter name="K" />
</template>
<parameter name="k">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>std::pair&lt;const_iterator, const_iterator&gt;</type>
</signature>
<returns> <returns>
<para>A range containing all elements with key equivalent to <code>k</code>. <para>A range containing all elements with key equivalent to <code>k</code>.
If the container doesn't container any such elements, returns If the container doesn't contain any such elements, returns
<code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>. <code><functionname>std::make_pair</functionname>(<methodname>b.end</methodname>(),<methodname>b.end</methodname>())</code>.
</para> </para>
</returns> </returns>
<notes>
<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> </overloaded-method>
<?php if ($map && !$equivalent_keys): ?> <?php if ($map && !$equivalent_keys): ?>
<method name="operator[]"> <method name="operator[]">