boostorg/unordered
1
0
Fork 1
mirror of https://github.com/boostorg/unordered.git synced 2025-07-31 20:04:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #83 from cmazakas/contains-doc-updates

Browse Source 
`contains()` Doc Updates
This commit is contained in:
Peter Dimov
2022-01-14 23:56:22 +02:00
committed by GitHub
parent 5d94f0eea6 312d00cc33
commit fe913577f6
3 changed files with 166 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/changes.qbk
View File

@@ -15,6 +15,7 @@
* Improved C++20 support: * Improved C++20 support:
* All containers have been updated to support * All containers have been updated to support
heterogeneous `count`, `equal_range` and `find`. heterogeneous `count`, `equal_range` and `find`.
* All containers now implement the member function `contains`
* Improved C++23 support: * Improved C++23 support:
* All containers have been updated to support * All containers have been updated to support
heterogeneous `erase` and `extract`. heterogeneous `erase` and `extract`.

33
doc/ref.php
View File

@@ -1406,6 +1406,39 @@ EOL;
</para> </para>
</notes> </notes>
</overloaded-method> </overloaded-method>
<overloaded-method name="contains">
<signature cv="const">
<parameter name="key">
<paramtype>key_type const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="key">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<returns>
<para>
A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
</para>
</returns>
<notes>
<para>
The <code>template &lt;typename K&gt;</code> overload only participates
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 name="count"> <overloaded-method name="count">
<signature cv="const"> <signature cv="const">
<parameter name="k"> <parameter name="k">

132
doc/ref.xml
View File

@@ -1233,6 +1233,39 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</para> </para>
</notes> </notes>
</overloaded-method> </overloaded-method>
<overloaded-method name="contains">
<signature cv="const">
<parameter name="key">
<paramtype>key_type const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="key">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<returns>
<para>
A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
</para>
</returns>
<notes>
<para>
The <code>template &lt;typename K&gt;</code> overload only participates
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 name="count"> <overloaded-method name="count">
<signature cv="const"> <signature cv="const">
<parameter name="k"> <parameter name="k">
@@ -2772,6 +2805,39 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</para> </para>
</notes> </notes>
</overloaded-method> </overloaded-method>
<overloaded-method name="contains">
<signature cv="const">
<parameter name="key">
<paramtype>key_type const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="key">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<returns>
<para>
A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
</para>
</returns>
<notes>
<para>
The <code>template &lt;typename K&gt;</code> overload only participates
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 name="count"> <overloaded-method name="count">
<signature cv="const"> <signature cv="const">
<parameter name="k"> <parameter name="k">
@@ -4432,6 +4498,39 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</para> </para>
</notes> </notes>
</overloaded-method> </overloaded-method>
<overloaded-method name="contains">
<signature cv="const">
<parameter name="key">
<paramtype>key_type const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="key">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<returns>
<para>
A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
</para>
</returns>
<notes>
<para>
The <code>template &lt;typename K&gt;</code> overload only participates
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 name="count"> <overloaded-method name="count">
<signature cv="const"> <signature cv="const">
<parameter name="k"> <parameter name="k">
@@ -6018,6 +6117,39 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</para> </para>
</notes> </notes>
</overloaded-method> </overloaded-method>
<overloaded-method name="contains">
<signature cv="const">
<parameter name="key">
<paramtype>key_type const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<signature>
<template>
<template-type-parameter name="K" />
</template>
<parameter name="key">
<paramtype>K const&amp;</paramtype>
</parameter>
<type>bool</type>
</signature>
<returns>
<para>
A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
</para>
</returns>
<notes>
<para>
The <code>template &lt;typename K&gt;</code> overload only participates
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 name="count"> <overloaded-method name="count">
<signature cv="const"> <signature cv="const">
<parameter name="k"> <parameter name="k">