diff --git a/doc/ref.xml b/doc/ref.xml index 55a8b2ba..44743955 100644 --- a/doc/ref.xml +++ b/doc/ref.xml @@ -34,50 +34,27 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) For the normative reference see chapter 23 of - the working draft of the C++ standard [n2009]. - - - - Template Parameters + the working draft of the C++ standard [n2009]. + Template Parameters - - Value - - Value must be Assignable and CopyConstructible - - + Value + Value must be Assignable and CopyConstructible - - Hash - - A unary function object type that acts a hash function for a Value. It takes a single argument of type Value and returns a value of type std::size_t. - - + Hash + A unary function object type that acts a hash function for a Value. It takes a single argument of type Value and returns a value of type std::size_t. - - Pred - - A binary function object that implements an equivalence relation on values of type Value. A binary function object that induces an equivalence relation on values of type Key. It takes two arguments of type Key and returns a value of type bool. - - + Pred + A binary function object that implements an equivalence relation on values of type Value. + A binary function object that induces an equivalence relation on values of type Key. + It takes two arguments of type Key and returns a value of type bool. - - Alloc - - An allocator whose value type is the same as the container's value type. - - - - - - - The elements are organized into buckets. Keys with the same hash code are stored in the same bucket. - - The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. - + Alloc + An allocator whose value type is the same as the container's value type. + The elements are organized into buckets. Keys with the same hash code are stored in the same bucket. + The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. Value @@ -111,66 +88,44 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) implementation-defined - An unsigned integral type. - - - size_type can represent any non-negative value of - difference_type. - + An unsigned integral type. + size_type can represent any non-negative value of difference_type. implementation-defined - A signed integral type. - - Is identical to the difference type of - iterator and - const_iterator. - + A signed integral type. + Is identical to the difference type of iterator and const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - - Convertible to - const_iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. + Convertible to const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. implementation-defined - An iterator with the same value type, difference type and pointer and reference type as - iterator. - - A local_iterator object can be used to iterate through a single bucket. - + An iterator with the same value type, difference type and pointer and reference type as iterator. + A local_iterator object can be used to iterate through a single bucket. implementation-defined - A constant iterator with the same value type, difference type and pointer and reference type as - const_iterator. - - A const_local_iterator object can be used to iterate through a single bucket. - + A constant iterator with the same value type, difference type and pointer and reference type as const_iterator. + A const_local_iterator object can be used to iterate through a single bucket. @@ -194,8 +149,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size() == 0 - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. @@ -226,8 +180,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) allocator_type() - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. @@ -235,8 +188,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_set const& - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - + The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. @@ -247,8 +199,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_set& - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - + The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. @@ -313,22 +264,17 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, bool> - Inserts obj in the container if and only if there is no element in the container with an equivalent value. - + 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 elment with 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 elment with equivalent value. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -351,26 +297,19 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_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. - + 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 elment with equivalent value. - + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment with equivalent value. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - - In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. - + 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. + In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. @@ -386,16 +325,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent value. - + Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent value. - When inserting a single element, if an exception is thrown by an operation other than a call to hasher the function has no effect. - + When inserting a single element, 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -412,22 +348,17 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erase the element pointed to by position. - + Erase the element pointed to by position. - The iterator following position before the erasure. - + The iterator following position before the erasure. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. - In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. - + In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. @@ -438,16 +369,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - Erase all elements with key equivalent to k. - + Erase all elements with key equivalent to k. - The number of elements erased. - + The number of elements erased. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. @@ -470,33 +398,26 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erases the elements in the range from first to last. - + Erases the elements in the range from first to last. - The iterator following the erased elements - i.e. last. - + The iterator following the erased elements - i.e. last. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. void - Erases all elements in the container. - + Erases all elements in the container. - size() == 0 - + size() == 0 - Never throws an exception. - + Never throws an exception. @@ -505,8 +426,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. @@ -537,8 +457,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - + An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. @@ -547,8 +466,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of elements with key equivalent to k. - + The number of elements with key equivalent to k. @@ -565,8 +483,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, iterator> - A range with containing all elements with key equivalent to k. If the container doesn't container any such elements, returns std::make_pair(b.end(),b.end()). - + A range with containing all elements with key equivalent to k. + If the container doesn't container any such elements, returns + std::make_pair(b.end(),b.end()). + @@ -574,15 +494,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of buckets. - + The number of buckets. size_type - An upper bound on the number of buckets. - + An upper bound on the number of buckets. @@ -591,14 +509,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - - n < bucket_count() - + n < bucket_count() - The number of elements in bucket - n. - + The number of elements in bucket n. @@ -607,12 +521,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The index of the bucket which would contain an element with key k. - + The index of the bucket which would contain an element with key k. - The return value is less than bucket_count() - + The return value is less than bucket_count() @@ -629,13 +541,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the first element in the bucket with index n. - + A local iterator pointing the first element in the bucket with index n. @@ -652,13 +561,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the 'one past the end' element in the bucket with index n. - + A local iterator pointing the 'one past the end' element in the bucket with index n. @@ -666,15 +572,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - The average number of elements per bucket. - + The average number of elements per bucket. float - Returns the current maximum load factor. - + Returns the current maximum load factor. @@ -683,8 +587,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - Changes the container's maximum load factor, using z as a hint. - + Changes the container's maximum load factor, using z as a hint. @@ -693,14 +596,11 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. - - Invalidates iterators, and changes the order of elements - + Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. + Invalidates iterators, and changes the order of elements - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - + The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. @@ -724,12 +624,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - x.swap(y) - + x.swap(y) - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. @@ -755,50 +653,27 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) For the normative reference see chapter 23 of - the working draft of the C++ standard [n2009]. - - - - Template Parameters + the working draft of the C++ standard [n2009]. + Template Parameters - - Value - - Value must be Assignable and CopyConstructible - - + Value + Value must be Assignable and CopyConstructible - - Hash - - A unary function object type that acts a hash function for a Value. It takes a single argument of type Value and returns a value of type std::size_t. - - + Hash + A unary function object type that acts a hash function for a Value. It takes a single argument of type Value and returns a value of type std::size_t. - - Pred - - A binary function object that implements an equivalence relation on values of type Value. A binary function object that induces an equivalence relation on values of type Key. It takes two arguments of type Key and returns a value of type bool. - - + Pred + A binary function object that implements an equivalence relation on values of type Value. + A binary function object that induces an equivalence relation on values of type Key. + It takes two arguments of type Key and returns a value of type bool. - - Alloc - - An allocator whose value type is the same as the container's value type. - - - - - - - The elements are organized into buckets. Keys with the same hash code are stored in the same bucket and elements with equivalent keys are stored next to each other. - - The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. - + Alloc + An allocator whose value type is the same as the container's value type. + The elements are organized into buckets. Keys with the same hash code are stored in the same bucket and elements with equivalent keys are stored next to each other. + The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. Value @@ -832,66 +707,44 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) implementation-defined - An unsigned integral type. - - - size_type can represent any non-negative value of - difference_type. - + An unsigned integral type. + size_type can represent any non-negative value of difference_type. implementation-defined - A signed integral type. - - Is identical to the difference type of - iterator and - const_iterator. - + A signed integral type. + Is identical to the difference type of iterator and const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - - Convertible to - const_iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. + Convertible to const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. implementation-defined - An iterator with the same value type, difference type and pointer and reference type as - iterator. - - A local_iterator object can be used to iterate through a single bucket. - + An iterator with the same value type, difference type and pointer and reference type as iterator. + A local_iterator object can be used to iterate through a single bucket. implementation-defined - A constant iterator with the same value type, difference type and pointer and reference type as - const_iterator. - - A const_local_iterator object can be used to iterate through a single bucket. - + A constant iterator with the same value type, difference type and pointer and reference type as const_iterator. + A const_local_iterator object can be used to iterate through a single bucket. @@ -915,8 +768,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size() == 0 - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. @@ -947,8 +799,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) allocator_type() - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. @@ -956,8 +807,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_multiset const& - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - + The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. @@ -968,8 +818,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_multiset& - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - + The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. @@ -1034,20 +883,16 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - Inserts obj in the container. - + Inserts obj in the container. - An iterator pointing to the inserted element. - + An iterator pointing to the inserted element. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -1070,24 +915,18 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Inserts obj in the container. - - hint is a suggestion to where the element should be inserted. - + Inserts obj in the container. + hint is a suggestion to where the element should be inserted. - An iterator pointing to the inserted element. - + An iterator pointing to the inserted element. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + 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. @@ -1103,16 +942,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Inserts a range of elements into the container. - + Inserts a range of elements into the container. - When inserting a single element, if an exception is thrown by an operation other than a call to hasher the function has no effect. - + When inserting a single element, 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -1129,18 +965,14 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erase the element pointed to by position. - + Erase the element pointed to by position. - The iterator following position before the erasure. - + The iterator following position before the erasure. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. @@ -1153,16 +985,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - Erase all elements with key equivalent to k. - + Erase all elements with key equivalent to k. - The number of elements erased. - + The number of elements erased. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. @@ -1185,33 +1014,26 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erases the elements in the range from first to last. - + Erases the elements in the range from first to last. - The iterator following the erased elements - i.e. last. - + The iterator following the erased elements - i.e. last. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. void - Erases all elements in the container. - + Erases all elements in the container. - size() == 0 - + size() == 0 - Never throws an exception. - + Never throws an exception. @@ -1220,8 +1042,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. @@ -1252,8 +1073,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - + An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. @@ -1262,8 +1082,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of elements with key equivalent to k. - + The number of elements with key equivalent to k. @@ -1280,8 +1099,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, iterator> - A range with containing all elements with key equivalent to k. If the container doesn't container any such elements, returns std::make_pair(b.end(),b.end()). - + A range with containing all elements with key equivalent to k. + If the container doesn't container any such elements, returns + std::make_pair(b.end(),b.end()). + @@ -1289,15 +1110,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of buckets. - + The number of buckets. size_type - An upper bound on the number of buckets. - + An upper bound on the number of buckets. @@ -1306,14 +1125,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - - n < bucket_count() - + n < bucket_count() - The number of elements in bucket - n. - + The number of elements in bucket n. @@ -1322,12 +1137,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The index of the bucket which would contain an element with key k. - + The index of the bucket which would contain an element with key k. - The return value is less than bucket_count() - + The return value is less than bucket_count() @@ -1344,13 +1157,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the first element in the bucket with index n. - + A local iterator pointing the first element in the bucket with index n. @@ -1367,13 +1177,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the 'one past the end' element in the bucket with index n. - + A local iterator pointing the 'one past the end' element in the bucket with index n. @@ -1381,15 +1188,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - The average number of elements per bucket. - + The average number of elements per bucket. float - Returns the current maximum load factor. - + Returns the current maximum load factor. @@ -1398,8 +1203,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - Changes the container's maximum load factor, using z as a hint. - + Changes the container's maximum load factor, using z as a hint. @@ -1408,14 +1212,11 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. - - Invalidates iterators, and changes the order of elements - + Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. + Invalidates iterators, and changes the order of elements - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - + The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. @@ -1439,12 +1240,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - x.swap(y) - + x.swap(y) - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. @@ -1480,57 +1279,30 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) For the normative reference see chapter 23 of - the working draft of the C++ standard [n2009]. - - - - Template Parameters + the working draft of the C++ standard [n2009]. + Template Parameters - - Key - - Key must be Assignable and CopyConstructible. - - + Key + Key must be Assignable and CopyConstructible. - - T - - T must be CopyConstructible - - + T + T must be CopyConstructible - - Hash - - A unary function object type that acts a hash function for a Key. It takes a single argument of type Key and returns a value of type std::size_t. - - + Hash + A unary function object type that acts a hash function for a Key. It takes a single argument of type Key and returns a value of type std::size_t. - - Pred - - A binary function object that implements an equivalence relation on values of type Key. A binary function object that induces an equivalence relation on values of type Key. It takes two arguments of type Key and returns a value of type bool. - - + Pred + A binary function object that implements an equivalence relation on values of type Key. + A binary function object that induces an equivalence relation on values of type Key. + It takes two arguments of type Key and returns a value of type bool. - - Alloc - - An allocator whose value type is the same as the container's value type. - - - - - - - The elements are organized into buckets. Keys with the same hash code are stored in the same bucket. - - The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. - + Alloc + An allocator whose value type is the same as the container's value type. + The elements are organized into buckets. Keys with the same hash code are stored in the same bucket. + The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. Key @@ -1567,66 +1339,44 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) implementation-defined - An unsigned integral type. - - - size_type can represent any non-negative value of - difference_type. - + An unsigned integral type. + size_type can represent any non-negative value of difference_type. implementation-defined - A signed integral type. - - Is identical to the difference type of - iterator and - const_iterator. - + A signed integral type. + Is identical to the difference type of iterator and const_iterator. implementation-defined - A iterator whose value type is - value_type. - - Any iterator category except output iterator. - - Convertible to - const_iterator. - + A iterator whose value type is value_type. + Any iterator category except output iterator. + Convertible to const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. implementation-defined - An iterator with the same value type, difference type and pointer and reference type as - iterator. - - A local_iterator object can be used to iterate through a single bucket. - + An iterator with the same value type, difference type and pointer and reference type as iterator. + A local_iterator object can be used to iterate through a single bucket. implementation-defined - A constant iterator with the same value type, difference type and pointer and reference type as - const_iterator. - - A const_local_iterator object can be used to iterate through a single bucket. - + A constant iterator with the same value type, difference type and pointer and reference type as const_iterator. + A const_local_iterator object can be used to iterate through a single bucket. @@ -1650,8 +1400,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size() == 0 - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. @@ -1682,8 +1431,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) allocator_type() - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. @@ -1691,8 +1439,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_map const& - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - + The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. @@ -1703,8 +1450,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_map& - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - + The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. @@ -1769,22 +1515,17 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, bool> - Inserts obj in the container if and only if there is no element in the container with an equivalent key. - + Inserts obj in the container if and only if there is no element in the container with an equivalent key. - 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 elment with equivalent key. - + 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 elment with equivalent key. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -1807,26 +1548,19 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Inserts obj in the container if and only if there is no element in the container with an equivalent key. - - hint is a suggestion to where the element should be inserted. - + Inserts obj in the container if and only if there is no element in the container with an equivalent key. + 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 elment with equivalent key. - + If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the elment with equivalent key. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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 key. - - Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. - - In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. - + 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. + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. @@ -1842,16 +1576,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent key. - + Inserts a range of elements into the container. Elements are inserted if and only if there is no element in the container with an equivalent key. - When inserting a single element, if an exception is thrown by an operation other than a call to hasher the function has no effect. - + When inserting a single element, 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -1868,22 +1599,17 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erase the element pointed to by position. - + Erase the element pointed to by position. - The iterator following position before the erasure. - + The iterator following position before the erasure. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. - In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. - + In this implementation, iterator and const_iterator are the same type, so a single overload is defined to implement both signatures. @@ -1894,16 +1620,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - Erase all elements with key equivalent to k. - + Erase all elements with key equivalent to k. - The number of elements erased. - + The number of elements erased. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. @@ -1926,33 +1649,26 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erases the elements in the range from first to last. - + Erases the elements in the range from first to last. - The iterator following the erased elements - i.e. last. - + The iterator following the erased elements - i.e. last. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. void - Erases all elements in the container. - + Erases all elements in the container. - size() == 0 - + size() == 0 - Never throws an exception. - + Never throws an exception. @@ -1961,8 +1677,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. @@ -1993,8 +1708,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - + An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. @@ -2003,8 +1717,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of elements with key equivalent to k. - + The number of elements with key equivalent to k. @@ -2021,8 +1734,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, iterator> - A range with containing all elements with key equivalent to k. If the container doesn't container any such elements, returns std::make_pair(b.end(),b.end()). - + A range with containing all elements with key equivalent to k. + If the container doesn't container any such elements, returns + std::make_pair(b.end(),b.end()). + @@ -2031,20 +1746,16 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) mapped_type& - If the container does not already contain an elements with a key equivalent to k, inserts the value std::pair<key_type const, mapped_type>(k, mapped_type()) - + If the container does not already contain an elements with a key equivalent to k, inserts the value std::pair<key_type const, mapped_type>(k, mapped_type()) - A reference to x.second where x is the element already in the container, or the newly inserted element with a key equivalent to k - + A reference to x.second where x is the element already in the container, or the newly inserted element with a key equivalent to k - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -2052,15 +1763,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of buckets. - + The number of buckets. size_type - An upper bound on the number of buckets. - + An upper bound on the number of buckets. @@ -2069,14 +1778,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - - n < bucket_count() - + n < bucket_count() - The number of elements in bucket - n. - + The number of elements in bucket n. @@ -2085,12 +1790,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The index of the bucket which would contain an element with key k. - + The index of the bucket which would contain an element with key k. - The return value is less than bucket_count() - + The return value is less than bucket_count() @@ -2107,13 +1810,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the first element in the bucket with index n. - + A local iterator pointing the first element in the bucket with index n. @@ -2130,13 +1830,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the 'one past the end' element in the bucket with index n. - + A local iterator pointing the 'one past the end' element in the bucket with index n. @@ -2144,15 +1841,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - The average number of elements per bucket. - + The average number of elements per bucket. float - Returns the current maximum load factor. - + Returns the current maximum load factor. @@ -2161,8 +1856,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - Changes the container's maximum load factor, using z as a hint. - + Changes the container's maximum load factor, using z as a hint. @@ -2171,14 +1865,11 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. - - Invalidates iterators, and changes the order of elements - + Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. + Invalidates iterators, and changes the order of elements - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - + The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. @@ -2204,12 +1895,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - x.swap(y) - + x.swap(y) - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. @@ -2237,57 +1926,30 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) For the normative reference see chapter 23 of - the working draft of the C++ standard [n2009]. - - - - Template Parameters + the working draft of the C++ standard [n2009]. + Template Parameters - - Key - - Key must be Assignable and CopyConstructible. - - + Key + Key must be Assignable and CopyConstructible. - - T - - T must be CopyConstructible - - + T + T must be CopyConstructible - - Hash - - A unary function object type that acts a hash function for a Key. It takes a single argument of type Key and returns a value of type std::size_t. - - + Hash + A unary function object type that acts a hash function for a Key. It takes a single argument of type Key and returns a value of type std::size_t. - - Pred - - A binary function object that implements an equivalence relation on values of type Key. A binary function object that induces an equivalence relation on values of type Key. It takes two arguments of type Key and returns a value of type bool. - - + Pred + A binary function object that implements an equivalence relation on values of type Key. + A binary function object that induces an equivalence relation on values of type Key. + It takes two arguments of type Key and returns a value of type bool. - - Alloc - - An allocator whose value type is the same as the container's value type. - - - - - - - The elements are organized into buckets. Keys with the same hash code are stored in the same bucket and elements with equivalent keys are stored next to each other. - - The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. - + Alloc + An allocator whose value type is the same as the container's value type. + The elements are organized into buckets. Keys with the same hash code are stored in the same bucket and elements with equivalent keys are stored next to each other. + The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. Key @@ -2324,66 +1986,44 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) implementation-defined - An unsigned integral type. - - - size_type can represent any non-negative value of - difference_type. - + An unsigned integral type. + size_type can represent any non-negative value of difference_type. implementation-defined - A signed integral type. - - Is identical to the difference type of - iterator and - const_iterator. - + A signed integral type. + Is identical to the difference type of iterator and const_iterator. implementation-defined - A iterator whose value type is - value_type. - - Any iterator category except output iterator. - - Convertible to - const_iterator. - + A iterator whose value type is value_type. + Any iterator category except output iterator. + Convertible to const_iterator. implementation-defined - A constant iterator whose value type is - value_type. - - Any iterator category except output iterator. - + A constant iterator whose value type is value_type. + Any iterator category except output iterator. implementation-defined - An iterator with the same value type, difference type and pointer and reference type as - iterator. - - A local_iterator object can be used to iterate through a single bucket. - + An iterator with the same value type, difference type and pointer and reference type as iterator. + A local_iterator object can be used to iterate through a single bucket. implementation-defined - A constant iterator with the same value type, difference type and pointer and reference type as - const_iterator. - - A const_local_iterator object can be used to iterate through a single bucket. - + A constant iterator with the same value type, difference type and pointer and reference type as const_iterator. + A const_local_iterator object can be used to iterate through a single bucket. @@ -2407,8 +2047,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size() == 0 - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocatorand a maximum load factor of 1.0. @@ -2439,8 +2078,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) allocator_type() - Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. - + Constructs an empty container with at least n buckets, using hf as the hash function, eq as the key equality predicate, a as the allocator and a maximum load factor of 1.0 and inserts the elements from [f, l) into it. @@ -2448,8 +2086,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_multimap const& - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - + The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. @@ -2460,8 +2097,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) unordered_multimap& - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - + The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. @@ -2526,20 +2162,16 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - Inserts obj in the container. - + Inserts obj in the container. - An iterator pointing to the inserted element. - + An iterator pointing to the inserted element. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -2562,24 +2194,18 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Inserts obj in the container. - - hint is a suggestion to where the element should be inserted. - + Inserts obj in the container. + hint is a suggestion to where the element should be inserted. - An iterator pointing to the inserted element. - + An iterator pointing to the inserted element. - If an exception is thrown by an operation other than a call to hasher the function has no effect. - + 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 key. - - Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. - + 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. + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -2595,16 +2221,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Inserts a range of elements into the container. - + Inserts a range of elements into the container. - When inserting a single element, if an exception is thrown by an operation other than a call to hasher the function has no effect. - + When inserting a single element, 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. - + Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. @@ -2621,18 +2244,14 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erase the element pointed to by position. - + Erase the element pointed to by position. - The iterator following position before the erasure. - + The iterator following position before the erasure. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. @@ -2645,16 +2264,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - Erase all elements with key equivalent to k. - + Erase all elements with key equivalent to k. - The number of elements erased. - + The number of elements erased. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. @@ -2677,33 +2293,26 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_iterator - Erases the elements in the range from first to last. - + Erases the elements in the range from first to last. - The iterator following the erased elements - i.e. last. - + The iterator following the erased elements - i.e. last. - Only throws an exception, if it is thrown by a call to hasher or key_equal. - - They don't get called by the current implementation Boost.Unordered but other implementations may call them. - + Only throws an exception, if it is thrown by a call to hasher or key_equal. + They don't get called by the current implementation Boost.Unordered but other implementations may call them. void - Erases all elements in the container. - + Erases all elements in the container. - size() == 0 - + size() == 0 - Never throws an exception. - + Never throws an exception. @@ -2712,8 +2321,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. @@ -2744,8 +2352,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) iterator - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - + An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. @@ -2754,8 +2361,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of elements with key equivalent to k. - + The number of elements with key equivalent to k. @@ -2772,8 +2378,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) std::pair<iterator, iterator> - A range with containing all elements with key equivalent to k. If the container doesn't container any such elements, returns std::make_pair(b.end(),b.end()). - + A range with containing all elements with key equivalent to k. + If the container doesn't container any such elements, returns + std::make_pair(b.end(),b.end()). + @@ -2781,15 +2389,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The number of buckets. - + The number of buckets. size_type - An upper bound on the number of buckets. - + An upper bound on the number of buckets. @@ -2798,14 +2404,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - - n < bucket_count() - + n < bucket_count() - The number of elements in bucket - n. - + The number of elements in bucket n. @@ -2814,12 +2416,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) size_type - The index of the bucket which would contain an element with key k. - + The index of the bucket which would contain an element with key k. - The return value is less than bucket_count() - + The return value is less than bucket_count() @@ -2836,13 +2436,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the first element in the bucket with index n. - + A local iterator pointing the first element in the bucket with index n. @@ -2859,13 +2456,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) const_local_iterator - n shall be in the range - [0, bucket_count()). - + n shall be in the range [0, bucket_count()). - A local iterator pointing the 'one past the end' element in the bucket with index n. - + A local iterator pointing the 'one past the end' element in the bucket with index n. @@ -2873,15 +2467,13 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - The average number of elements per bucket. - + The average number of elements per bucket. float - Returns the current maximum load factor. - + Returns the current maximum load factor. @@ -2890,8 +2482,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) float - Changes the container's maximum load factor, using z as a hint. - + Changes the container's maximum load factor, using z as a hint. @@ -2900,14 +2491,11 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. - - Invalidates iterators, and changes the order of elements - + Changes the number of buckets so that there at least n buckets, and so that the load factor is less than the maximum load factor. + Invalidates iterators, and changes the order of elements - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - + The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. @@ -2933,12 +2521,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) void - x.swap(y) - + x.swap(y) - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred. - + Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of Hash or Pred.