From 0acb4ee3e6ca3f2bb86a4418f39fadc95ea65e99 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Mon, 4 Jun 2012 22:53:43 +0000 Subject: [PATCH] Unordered: Document move insert. Just a quick copy and paste for tonight's documentation build. May edit a bit before release. [SVN r78810] --- doc/ref.php | 59 ++++++++++++++++++ doc/ref.xml | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 233 insertions(+) diff --git a/doc/ref.php b/doc/ref.php index e014555c..e336a55c 100644 --- a/doc/ref.php +++ b/doc/ref.php @@ -496,6 +496,33 @@ EOL; The bool component of the return type is true if an insert took place. If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent . + + + + If an exception is thrown by an operation other than a call to hasher the function has no effect. + + + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + Pointers and references to elements are never invalidated. + + + + + value_type&& + + + + Inserts obj in the container + + + + An iterator pointing to the inserted element. + + The bool component of the return type is true if an insert took place. + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent . @@ -527,6 +554,38 @@ EOL; An iterator pointing to the inserted element. If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent . + + + + If an exception is thrown by an operation other than a call to hasher the function has no effect. + + + 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 . + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + Pointers and references to elements are never invalidated. + + + + + const_iterator + + + value_type&& + + iterator + + + Inserts obj in the container. + + Inserts obj in the container if and only if there is no element in the container with an equivalent . + + hint is a suggestion to where the element should be inserted. + + + + An iterator pointing to the inserted element. + + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent . diff --git a/doc/ref.xml b/doc/ref.xml index 9e4e399e..cfd15584 100644 --- a/doc/ref.xml +++ b/doc/ref.xml @@ -430,6 +430,26 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) Pointers and references to elements are never invalidated. + + + value_type&& + + std::pair<iterator, bool> + + Inserts obj in the container if and only if there is no element in the container with an equivalent value. + + + The bool component of the return type is true if an insert took place. + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value. + + + If an exception is thrown by an operation other than a call to hasher the function has no effect. + + + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + Pointers and references to elements are never invalidated. + + const_iterator @@ -454,6 +474,30 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) Pointers and references to elements are never invalidated. + + + const_iterator + + + value_type&& + + iterator + + Inserts obj in the container if and only if there is no element in the container with an equivalent value. + hint is a suggestion to where the element should be inserted. + + + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent value. + + + If an exception is thrown by an operation other than a call to hasher the function has no effect. + + + 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. + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + Pointers and references to elements are never invalidated. + +