|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r78810 - trunk/libs/unordered/doc
From: dnljms_at_[hidden]
Date: 2012-06-04 18:53:44
Author: danieljames
Date: 2012-06-04 18:53:43 EDT (Mon, 04 Jun 2012)
New Revision: 78810
URL: http://svn.boost.org/trac/boost/changeset/78810
Log:
Unordered: Document move insert.
Just a quick copy and paste for tonight's documentation build. May edit a bit
before release.
Text files modified:
trunk/libs/unordered/doc/ref.php | 59 +++++++++++++
trunk/libs/unordered/doc/ref.xml | 174 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 233 insertions(+), 0 deletions(-)
Modified: trunk/libs/unordered/doc/ref.php
==============================================================================
--- trunk/libs/unordered/doc/ref.php (original)
+++ trunk/libs/unordered/doc/ref.php 2012-06-04 18:53:43 EDT (Mon, 04 Jun 2012)
@@ -507,6 +507,33 @@
</notes>
</method>
<method name="insert">
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type><?php echo $equivalent_keys ? 'iterator' : 'std::pair<iterator, bool>' ?></type>
+ <description>
+ <para>Inserts <code>obj</code> in the container<?php
+ echo $equivalent_keys ? '.' :
+ ' if and only if there is no element in the container with an equivalent '.$key_name. '.';
+ ?></para>
+ </description>
+ <returns>
+<?php if ($equivalent_keys): ?>
+ <para>An iterator pointing to the inserted element.</para>
+<?php else: ?>
+ <para>The bool component of the return type is true if an insert took place.</para>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent <?php echo $key_name; ?>.</para>
+<?php endif; ?>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<parameter name="hint">
<paramtype>const_iterator</paramtype>
</parameter>
@@ -539,6 +566,38 @@
</notes>
</method>
<method name="insert">
+ <parameter name="hint">
+ <paramtype>const_iterator</paramtype>
+ </parameter>
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+<?php if ($equivalent_keys): ?>
+ <para>Inserts <code>obj</code> in the container.</para>
+<?php else: ?>
+ <para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent <?php echo $key_name; ?>.</para>
+<?php endif; ?>
+ <para>hint is a suggestion to where the element should be inserted.</para>
+ </description>
+ <returns>
+<?php if ($equivalent_keys): ?>
+ <para>An iterator pointing to the inserted element.</para>
+<?php else: ?>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent <?php echo $key_name; ?>.</para>
+<?php endif; ?>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same <?php echo $key_name; ?>. </para>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<template>
<template-type-parameter name="InputIterator">
</template-type-parameter>
Modified: trunk/libs/unordered/doc/ref.xml
==============================================================================
--- trunk/libs/unordered/doc/ref.xml (original)
+++ trunk/libs/unordered/doc/ref.xml 2012-06-04 18:53:43 EDT (Mon, 04 Jun 2012)
@@ -431,6 +431,26 @@
</notes>
</method>
<method name="insert">
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>std::pair<iterator, bool></type>
+ <description>
+ <para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
+ </description>
+ <returns>
+ <para>The bool component of the return type is true if an insert took place.</para>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<parameter name="hint">
<paramtype>const_iterator</paramtype>
</parameter>
@@ -455,6 +475,30 @@
</notes>
</method>
<method name="insert">
+ <parameter name="hint">
+ <paramtype>const_iterator</paramtype>
+ </parameter>
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent value.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
+ </description>
+ <returns>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<template>
<template-type-parameter name="InputIterator">
</template-type-parameter>
@@ -1394,6 +1438,25 @@
</notes>
</method>
<method name="insert">
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container.</para>
+ </description>
+ <returns>
+ <para>An iterator pointing to the inserted element.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<parameter name="hint">
<paramtype>const_iterator</paramtype>
</parameter>
@@ -1418,6 +1481,30 @@
</notes>
</method>
<method name="insert">
+ <parameter name="hint">
+ <paramtype>const_iterator</paramtype>
+ </parameter>
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
+ </description>
+ <returns>
+ <para>An iterator pointing to the inserted element.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same value. </para>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<template>
<template-type-parameter name="InputIterator">
</template-type-parameter>
@@ -2371,6 +2458,26 @@
</notes>
</method>
<method name="insert">
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>std::pair<iterator, bool></type>
+ <description>
+ <para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
+ </description>
+ <returns>
+ <para>The bool component of the return type is true if an insert took place.</para>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<parameter name="hint">
<paramtype>const_iterator</paramtype>
</parameter>
@@ -2395,6 +2502,30 @@
</notes>
</method>
<method name="insert">
+ <parameter name="hint">
+ <paramtype>const_iterator</paramtype>
+ </parameter>
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container if and only if there is no element in the container with an equivalent key.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
+ </description>
+ <returns>
+ <para>If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. </para>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<template>
<template-type-parameter name="InputIterator">
</template-type-parameter>
@@ -3379,6 +3510,25 @@
</notes>
</method>
<method name="insert">
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container.</para>
+ </description>
+ <returns>
+ <para>An iterator pointing to the inserted element.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<parameter name="hint">
<paramtype>const_iterator</paramtype>
</parameter>
@@ -3403,6 +3553,30 @@
</notes>
</method>
<method name="insert">
+ <parameter name="hint">
+ <paramtype>const_iterator</paramtype>
+ </parameter>
+ <parameter name="obj">
+ <paramtype>value_type&&</paramtype>
+ </parameter>
+ <type>iterator</type>
+ <description>
+ <para>Inserts <code>obj</code> in the container.</para>
+ <para>hint is a suggestion to where the element should be inserted.</para>
+ </description>
+ <returns>
+ <para>An iterator pointing to the inserted element.</para>
+ </returns>
+ <throws>
+ <para>If an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
+ </throws>
+ <notes>
+ <para>The standard is fairly vague on the meaning of the hint. But the only practical way to use it, and the only way that Boost.Unordered supports is to point to an existing element with the same key. </para>
+ <para>Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor.</para>
+ <para>Pointers and references to elements are never invalidated.</para>
+ </notes>
+ </method>
+ <method name="insert">
<template>
<template-type-parameter name="InputIterator">
</template-type-parameter>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk