forked from boostorg/unordered
Use Mapped instead of T in the documentation.
[SVN r42100]
This commit is contained in:
Daniel James
@@ -63,14 +63,14 @@ details). If accepted the containers should also be added to __boost-tr1__.
|
||||
|
||||
namespace boost {
|
||||
template <
|
||||
class Key, class T,
|
||||
class Key, class Mapped,
|
||||
class Hash = ``[classref boost::hash]``<Key>,
|
||||
class Pred = std::equal_to<Key>,
|
||||
class Alloc = std::allocator<Key> >
|
||||
class ``[classref boost::unordered_map unordered_map]``;
|
||||
|
||||
template<
|
||||
class Key, class T,
|
||||
class Key, class Mapped,
|
||||
class Hash = ``[classref boost::hash]``<Key>,
|
||||
class Pred = std::equal_to<Key>,
|
||||
class Alloc = std::allocator<Key> >
|
||||
|
||||
36
doc/ref.xml
36
doc/ref.xml
@@ -1187,7 +1187,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<template>
|
||||
<template-type-parameter name="Key">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="T">
|
||||
<template-type-parameter name="Mapped">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Hash">
|
||||
<default><type>boost::hash<Value></type></default>
|
||||
@@ -1196,7 +1196,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<default><type>std::equal_to<Value></type></default>
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Alloc">
|
||||
<default><type>std::allocator<std::pair<const Key, T> ></type></default>
|
||||
<default><type>std::allocator<std::pair<const Key, Mapped> ></type></default>
|
||||
</template-type-parameter>
|
||||
</template>
|
||||
<purpose>An unordered associative container that associates unique keys with another value.
|
||||
@@ -1212,8 +1212,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<entry><emphasis>Key</emphasis></entry>
|
||||
<entry>Key must be Assignable and CopyConstructible.</entry></row>
|
||||
<row>
|
||||
<entry><emphasis>T</emphasis></entry>
|
||||
<entry>T must be CopyConstructible</entry></row>
|
||||
<entry><emphasis>Mapped</emphasis></entry>
|
||||
<entry>Mapped must be CopyConstructible</entry></row>
|
||||
<row>
|
||||
<entry><emphasis>Hash</emphasis></entry>
|
||||
<entry>A unary function object type that acts a hash function for a <code>Key</code>. It takes a single argument of type <code>Key</code> and returns a value of type std::size_t.</entry></row>
|
||||
@@ -1235,7 +1235,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<type>std::pair<Key const, Value></type>
|
||||
</typedef>
|
||||
<typedef name="mapped_type">
|
||||
<type>T</type>
|
||||
<type>Mapped</type>
|
||||
</typedef>
|
||||
<typedef name="hasher">
|
||||
<type>Hash</type>
|
||||
@@ -1642,9 +1642,9 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
</notes>
|
||||
</method>
|
||||
<overloaded-method name="at">
|
||||
<signature><type>T&</type>
|
||||
<signature><type>Mapped&</type>
|
||||
<parameter name="k"><paramtype>key_type const&</paramtype></parameter></signature>
|
||||
<signature cv="const"><type>T const&</type>
|
||||
<signature cv="const"><type>Mapped const&</type>
|
||||
<parameter name="k"><paramtype>key_type const&</paramtype></parameter></signature>
|
||||
<returns>
|
||||
<para>A reference to <code>x.second</code> where <code>x</code> is the (unique) element whose key is equivalent to <code>k</code>.</para>
|
||||
@@ -1777,7 +1777,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<template>
|
||||
<template-type-parameter name="Key">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="T">
|
||||
<template-type-parameter name="Mapped">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Hash">
|
||||
</template-type-parameter>
|
||||
@@ -1787,10 +1787,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
</template-type-parameter>
|
||||
</template>
|
||||
<parameter name="x">
|
||||
<paramtype>unordered_map<Key, T, Hash, Pred, Alloc>&</paramtype>
|
||||
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
||||
</parameter>
|
||||
<parameter name="y">
|
||||
<paramtype>unordered_map<Key, T, Hash, Pred, Alloc>&</paramtype>
|
||||
<paramtype>unordered_map<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
||||
</parameter>
|
||||
<type>void</type>
|
||||
<effects>
|
||||
@@ -1811,7 +1811,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<template>
|
||||
<template-type-parameter name="Key">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="T">
|
||||
<template-type-parameter name="Mapped">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Hash">
|
||||
<default><type>boost::hash<Value></type></default>
|
||||
@@ -1820,7 +1820,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<default><type>std::equal_to<Value></type></default>
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Alloc">
|
||||
<default><type>std::allocator<std::pair<const Key, T> ></type></default>
|
||||
<default><type>std::allocator<std::pair<const Key, Mapped> ></type></default>
|
||||
</template-type-parameter>
|
||||
</template>
|
||||
<purpose>An unordered associative container that associates keys with another value. The same key can be stored multiple times.
|
||||
@@ -1836,8 +1836,8 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<entry><emphasis>Key</emphasis></entry>
|
||||
<entry>Key must be Assignable and CopyConstructible.</entry></row>
|
||||
<row>
|
||||
<entry><emphasis>T</emphasis></entry>
|
||||
<entry>T must be CopyConstructible</entry></row>
|
||||
<entry><emphasis>Mapped</emphasis></entry>
|
||||
<entry>Mapped must be CopyConstructible</entry></row>
|
||||
<row>
|
||||
<entry><emphasis>Hash</emphasis></entry>
|
||||
<entry>A unary function object type that acts a hash function for a <code>Key</code>. It takes a single argument of type <code>Key</code> and returns a value of type std::size_t.</entry></row>
|
||||
@@ -1859,7 +1859,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<type>std::pair<Key const, Value></type>
|
||||
</typedef>
|
||||
<typedef name="mapped_type">
|
||||
<type>T</type>
|
||||
<type>Mapped</type>
|
||||
</typedef>
|
||||
<typedef name="hasher">
|
||||
<type>Hash</type>
|
||||
@@ -2366,7 +2366,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
<template>
|
||||
<template-type-parameter name="Key">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="T">
|
||||
<template-type-parameter name="Mapped">
|
||||
</template-type-parameter>
|
||||
<template-type-parameter name="Hash">
|
||||
</template-type-parameter>
|
||||
@@ -2376,10 +2376,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
</template-type-parameter>
|
||||
</template>
|
||||
<parameter name="x">
|
||||
<paramtype>unordered_multimap<Key, T, Hash, Pred, Alloc>&</paramtype>
|
||||
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
||||
</parameter>
|
||||
<parameter name="y">
|
||||
<paramtype>unordered_multimap<Key, T, Hash, Pred, Alloc>&</paramtype>
|
||||
<paramtype>unordered_multimap<Key, Mapped, Hash, Pred, Alloc>&</paramtype>
|
||||
</parameter>
|
||||
<type>void</type>
|
||||
<effects>
|
||||
|
||||
Reference in New Issue
Block a user