diff --git a/doc/bibliography.xml b/doc/bibliography.xml deleted file mode 100644 index 68e8f2bf..00000000 --- a/doc/bibliography.xml +++ /dev/null @@ -1,26 +0,0 @@ - -
-Bibliography - - - - C/C++ Users Journal - February, 2006 - - - - - Pete - Becker - - - <ulink url="http://www.ddj.com/cpp/184402066">STL and TR1: Part III - Unordered containers</ulink> - - An introducation to the standard unordered containers. - - -
diff --git a/doc/buckets.qbk b/doc/buckets.qbk deleted file mode 100644 index 54d2bc94..00000000 --- a/doc/buckets.qbk +++ /dev/null @@ -1,168 +0,0 @@ -[/ Copyright 2006-2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[section:buckets The Data Structure] - -The containers are made up of a number of 'buckets', each of which can contain -any number of elements. For example, the following diagram shows an [classref -boost::unordered_set unordered_set] with 7 buckets containing 5 elements, `A`, -`B`, `C`, `D` and `E` (this is just for illustration, containers will typically -have more buckets). - -[diagram buckets] - -In order to decide which bucket to place an element in, the container applies -the hash function, `Hash`, to the element's key (for `unordered_set` and -`unordered_multiset` the key is the whole element, but is referred to as the key -so that the same terminology can be used for sets and maps). This returns a -value of type `std::size_t`. `std::size_t` has a much greater range of values -then the number of buckets, so the container applies another transformation to -that value to choose a bucket to place the element in. - -Retrieving the elements for a given key is simple. The same process is applied -to the key to find the correct bucket. Then the key is compared with the -elements in the bucket to find any elements that match (using the equality -predicate `Pred`). If the hash function has worked well the elements will be -evenly distributed amongst the buckets so only a small number of elements will -need to be examined. - -There is [link unordered.hash_equality more information on hash functions and -equality predicates in the next section]. - -You can see in the diagram that `A` & `D` have been placed in the same bucket. -When looking for elements in this bucket up to 2 comparisons are made, making -the search slower. This is known as a collision. To keep things fast we try to -keep collisions to a minimum. - -''' -Methods for Accessing Buckets - - - Method - Description - - - - '''`size_type bucket_count() const`''' - '''The number of buckets.''' - - - '''`size_type max_bucket_count() const`''' - '''An upper bound on the number of buckets.''' - - - '''`size_type bucket_size(size_type n) const`''' - '''The number of elements in bucket `n`.''' - - - '''`size_type bucket(key_type const& k) const`''' - '''Returns the index of the bucket which would contain `k`.''' - - - '''`local_iterator begin(size_type n);`''' - '''Return begin and end iterators for bucket `n`.''' - - - '''`local_iterator end(size_type n);`''' - - - '''`const_local_iterator begin(size_type n) const;`''' - - - '''`const_local_iterator end(size_type n) const;`''' - - - '''`const_local_iterator cbegin(size_type n) const;`''' - - - '''`const_local_iterator cend(size_type n) const;`''' - - - -
-''' - -[h2 Controlling the number of buckets] - -As more elements are added to an unordered associative container, the number -of elements in the buckets will increase causing performance to degrade. -To combat this the containers increase the bucket count as elements are inserted. -You can also tell the container to change the bucket count (if required) by -calling `rehash`. - -The standard leaves a lot of freedom to the implementer to decide how the -number of buckets is chosen, but it does make some requirements based on the -container's 'load factor', the average number of elements per bucket. -Containers also have a 'maximum load factor' which they should try to keep the -load factor below. - -You can't control the bucket count directly but there are two ways to -influence it: - -* Specify the minimum number of buckets when constructing a container or - when calling `rehash`. -* Suggest a maximum load factor by calling `max_load_factor`. - -`max_load_factor` doesn't let you set the maximum load factor yourself, it just -lets you give a /hint/. And even then, the draft standard doesn't actually -require the container to pay much attention to this value. The only time the -load factor is /required/ to be less than the maximum is following a call to -`rehash`. But most implementations will try to keep the number of elements -below the max load factor, and set the maximum load factor to be the same as -or close to the hint - unless your hint is unreasonably small or large. - -[table:bucket_size Methods for Controlling Bucket Size - [[Method] [Description]] - - [ - [`X(size_type n)`] - [Construct an empty container with at least `n` buckets (`X` is the container type).] - ] - [ - [`X(InputIterator i, InputIterator j, size_type n)`] - [Construct an empty container with at least `n` buckets and insert elements - from the range \[`i`, `j`) (`X` is the container type).] - ] - [ - [`float load_factor() const`] - [The average number of elements per bucket.] - ] - [ - [`float max_load_factor() const`] - [Returns the current maximum load factor.] - ] - [ - [`float max_load_factor(float z)`] - [Changes the container's maximum load factor, using `z` as a hint.] - ] - [ - [`void rehash(size_type n)`] - [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.] - ] - -] - -[h2 Iterator Invalidation] - -It is not specified how member functions other than `rehash` affect -the bucket count, although `insert` is only allowed to invalidate iterators -when the insertion causes the load factor to be greater than or equal to the -maximum load factor. For most implementations this means that `insert` will only -change the number of buckets when this happens. While iterators can be -invalidated by calls to `insert` and `rehash`, pointers and references to the -container's elements are never invalidated. - -In a similar manner to using `reserve` for `vector`s, it can be a good idea -to call `rehash` before inserting a large number of elements. This will get -the expensive rehashing out of the way and let you store iterators, safe in -the knowledge that they won't be invalidated. If you are inserting `n` -elements into container `x`, you could first call: - - x.rehash((x.size() + n) / x.max_load_factor()); - -[blurb Note: `rehash`'s argument is the minimum number of buckets, not the -number of elements, which is why the new size is divided by the maximum load factor.] - -[endsect] diff --git a/doc/changes.qbk b/doc/changes.qbk deleted file mode 100644 index fc2dd55d..00000000 --- a/doc/changes.qbk +++ /dev/null @@ -1,375 +0,0 @@ - -[/ Copyright 2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[template ticket[number]''''''#[number]''''''] - -[template pull_request[number][@https://github.com/boostorg/unordered/pull/[number] GitHub #[number]]] - -[section:changes Change Log] - -[heading Changes in Boost 1.79.0] - -* Improved C++20 support: - * All containers have been updated to support - heterogeneous `count`, `equal_range` and `find`. - * All containers now implement the member function `contains` -* Improved C++23 support: - * All containers have been updated to support - heterogeneous `erase` and `extract`. -* Changed behavior of `reserve` to eagerly - allocate ([@https://github.com/boostorg/unordered/pull/59 PR#59]). -* Various warning fixes in the test suite. -* Update code to internally use `boost::allocator_traits`. - -[heading Changes in Boost 1.67.0] - -* Improved C++17 support: - * Add template deduction guides from the standard. - * Use a simple implementation of `optional` in node handles, so - that they're closer to the standard. - * Add missing `noexcept` specifications to `swap`, `operator=` - and node handles, and change the implementation to match. - Using `std::allocator_traits::is_always_equal`, or our own - implementation when not available, and - `boost::is_nothrow_swappable` in the implementation. -* Improved C++20 support: - * Use `boost::to_address`, which has the proposed C++20 semantics, - rather than the old custom implementation. -* Add `element_type` to iterators, so that `std::pointer_traits` - will work. -* Use `std::piecewise_construct` on recent versions of Visual C++, - and other uses of the Dinkumware standard library, - now using Boost.Predef to check compiler and library versions. -* Use `std::iterator_traits` rather than the boost iterator traits - in order to remove dependency on Boost.Iterator. -* Remove iterators' inheritance from `std::iterator`, which is - deprecated in C++17, thanks to Daniela Engert - ([@https://github.com/boostorg/unordered/pull/7 PR#7]). -* Stop using `BOOST_DEDUCED_TYPENAME`. -* Update some Boost include paths. -* Rename some internal methods, and variables. -* Various testing improvements. -* Miscellaneous internal changes. - -[heading Changes in Boost 1.66.0] - -* Simpler move construction implementation. -* Documentation fixes ([pull_request 6]). - -[heading Changes in Boost 1.65.0] - -* Add deprecated attributes to `quick_erase` and `erase_return_void`. - I really will remove them in a future version this time. -* Small standards compliance fixes: - * `noexpect` specs for `swap` free functions. - * Add missing `insert(P&&)` methods. - -[heading Changes in Boost 1.64.0] - -* Initial support for new C++17 member functions: - `insert_or_assign` and `try_emplace` in `unordered_map`, -* Initial support for `merge` and `extract`. - Does not include transferring nodes between - `unordered_map` and `unordered_multimap` or between `unordered_set` and - `unordered_multiset` yet. That will hopefully be in the next version of - Boost. - -[heading Changes in Boost 1.63.0] - -* Check hint iterator in `insert`/`emplace_hint`. -* Fix some warnings, mostly in the tests. -* Manually write out `emplace_args` for small numbers of arguments - - should make template error messages a little more bearable. -* Remove superfluous use of `boost::forward` in emplace arguments, - which fixes emplacing string literals in old versions of Visual C++. -* Fix an exception safety issue in assignment. If bucket allocation - throws an exception, it can overwrite the hash and equality functions while - leaving the existing elements in place. This would mean that the function - objects wouldn't match the container elements, so elements might be in the - wrong bucket and equivalent elements would be incorrectly handled. -* Various reference documentation improvements. -* Better allocator support ([ticket 12459]). -* Make the no argument constructors implicit. -* Implement missing allocator aware constructors. -* Fix assigning the hash/key equality functions for empty containers. -* Remove unary/binary_function from the examples in the documentation. - They are removed in C++17. -* Support 10 constructor arguments in emplace. It was meant to support up to 10 - arguments, but an off by one error in the preprocessor code meant it only - supported up to 9. - -[heading Changes in Boost 1.62.0] - -* Remove use of deprecated `boost::iterator`. -* Remove `BOOST_NO_STD_DISTANCE` workaround. -* Remove `BOOST_UNORDERED_DEPRECATED_EQUALITY` warning. -* Simpler implementation of assignment, fixes an exception safety issue - for `unordered_multiset` and `unordered_multimap`. Might be a little slower. -* Stop using return value SFINAE which some older compilers have issues - with. - -[heading Changes in Boost 1.58.0] - -* Remove unnecessary template parameter from const iterators. -* Rename private `iterator` typedef in some iterator classes, as it - confuses some traits classes. -* Fix move assignment with stateful, propagate_on_container_move_assign - allocators ([ticket 10777]). -* Fix rare exception safety issue in move assignment. -* Fix potential overflow when calculating number of buckets to allocate - ([@https://github.com/boostorg/unordered/pull/4 GitHub #4]). - -[heading Changes in Boost 1.57.0] - -* Fix the `pointer` typedef in iterators ([ticket 10672]). -* Fix Coverity warning - ([@https://github.com/boostorg/unordered/pull/2 GitHub #2]). - -[heading Changes in Boost 1.56.0] - -* Fix some shadowed variable warnings ([ticket 9377]). -* Fix allocator use in documentation ([ticket 9719]). -* Always use prime number of buckets for integers. Fixes performance - regression when inserting consecutive integers, although makes other - uses slower ([ticket 9282]). -* Only construct elements using allocators, as specified in C++11 standard. - -[heading Changes in Boost 1.55.0] - -* Avoid some warnings ([ticket 8851], [ticket 8874]). -* Avoid exposing some detail functions via. ADL on the iterators. -* Follow the standard by only using the allocators' construct and destroy - methods to construct and destroy stored elements. Don't use them for internal - data like pointers. - -[heading Changes in Boost 1.54.0] - -* Mark methods specified in standard as `noexpect`. More to come in the next - release. -* If the hash function and equality predicate are known to both have nothrow - move assignment or construction then use them. - -[heading Changes in Boost 1.53.0] - -* Remove support for the old pre-standard variadic pair constructors, and - equality implementation. Both have been deprecated since Boost 1.48. -* Remove use of deprecated config macros. -* More internal implementation changes, including a much simpler - implementation of `erase`. - -[heading Changes in Boost 1.52.0] - -* Faster assign, which assigns to existing nodes where possible, rather than - creating entirely new nodes and copy constructing. -* Fixed bug in `erase_range` ([ticket 7471]). -* Reverted some of the internal changes to how nodes are created, especially - for C++11 compilers. 'construct' and 'destroy' should work a little better - for C++11 allocators. -* Simplified the implementation a bit. Hopefully more robust. - -[heading Changes in Boost 1.51.0] - -* Fix construction/destruction issue when using a C++11 compiler with a - C++03 allocator ([ticket 7100]). -* Remove a `try..catch` to support compiling without exceptions. -* Adjust SFINAE use to try to support g++ 3.4 ([ticket 7175]). -* Updated to use the new config macros. - -[heading Changes in Boost 1.50.0] - -* Fix equality for `unordered_multiset` and `unordered_multimap`. -* [@https://svn.boost.org/trac/boost/ticket/6857 Ticket 6857]: - Implement `reserve`. -* [@https://svn.boost.org/trac/boost/ticket/6771 Ticket 6771]: - Avoid gcc's `-Wfloat-equal` warning. -* [@https://svn.boost.org/trac/boost/ticket/6784 Ticket 6784]: - Fix some Sun specific code. -* [@https://svn.boost.org/trac/boost/ticket/6190 Ticket 6190]: - Avoid gcc's `-Wshadow` warning. -* [@https://svn.boost.org/trac/boost/ticket/6905 Ticket 6905]: - Make namespaces in macros compatible with `bcp` custom namespaces. - Fixed by Luke Elliott. -* Remove some of the smaller prime number of buckets, as they may make - collisions quite probable (e.g. multiples of 5 are very common because - we used base 10). -* On old versions of Visual C++, use the container library's implementation - of `allocator_traits`, as it's more likely to work. -* On machines with 64 bit std::size_t, use power of 2 buckets, with Thomas - Wang's hash function to pick which one to use. As modulus is very slow - for 64 bit values. -* Some internal changes. - -[heading Changes in Boost 1.49.0] - -* Fix warning due to accidental odd assignment. -* Slightly better error messages. - -[heading Changes in Boost 1.48.0 - Major update] - -This is major change which has been converted to use Boost.Move's move -emulation, and be more compliant with the C++11 standard. See the -[link unordered.compliance compliance section] for details. - -The container now meets C++11's complexity requirements, but to do so -uses a little more memory. This means that `quick_erase` and -`erase_return_void` are no longer required, they'll be removed in a -future version. - -C++11 support has resulted in some breaking changes: - -* Equality comparison has been changed to the C++11 specification. - In a container with equivalent keys, elements in a group with equal - keys used to have to be in the same order to be considered equal, - now they can be a permutation of each other. To use the old - behavior define the macro `BOOST_UNORDERED_DEPRECATED_EQUALITY`. - -* The behaviour of swap is different when the two containers to be - swapped has unequal allocators. It used to allocate new nodes using - the appropriate allocators, it now swaps the allocators if - the allocator has a member structure `propagate_on_container_swap`, - such that `propagate_on_container_swap::value` is true. - -* Allocator's `construct` and `destroy` functions are called with raw - pointers, rather than the allocator's `pointer` type. - -* `emplace` used to emulate the variadic pair constructors that - appeared in early C++0x drafts. Since they were removed it no - longer does so. It does emulate the new `piecewise_construct` - pair constructors - only you need to use - `boost::piecewise_construct`. To use the old emulation of - the variadic constructors define - `BOOST_UNORDERED_DEPRECATED_PAIR_CONSTRUCT`. - -[heading Changes in Boost 1.45.0] - -* Fix a bug when inserting into an `unordered_map` or `unordered_set` using - iterators which returns `value_type` by copy. - -[heading Changes in Boost 1.43.0] - -* [@http://svn.boost.org/trac/boost/ticket/3966 Ticket 3966]: - `erase_return_void` is now `quick_erase`, which is the - [@http://home.roadrunner.com/~hinnant/issue_review/lwg-active.html#579 - current forerunner for resolving the slow erase by iterator], although - there's a strong possibility that this may change in the future. The old - method name remains for backwards compatibility but is considered deprecated - and will be removed in a future release. -* Use Boost.Exception. -* Stop using deprecated `BOOST_HAS_*` macros. - -[heading Changes in Boost 1.42.0] - -* Support instantiating the containers with incomplete value types. -* Reduced the number of warnings (mostly in tests). -* Improved codegear compatibility. -* [@http://svn.boost.org/trac/boost/ticket/3693 Ticket 3693]: - Add `erase_return_void` as a temporary workaround for the current - `erase` which can be inefficient because it has to find the next - element to return an iterator. -* Add templated find overload for compatible keys. -* [@http://svn.boost.org/trac/boost/ticket/3773 Ticket 3773]: - Add missing `std` qualifier to `ptrdiff_t`. -* Some code formatting changes to fit almost all lines into 80 characters. - -[heading Changes in Boost 1.41.0 - Major update] - -* The original version made heavy use of macros to sidestep some of the older - compilers' poor template support. But since I no longer support those - compilers and the macro use was starting to become a maintenance burden it - has been rewritten to use templates instead of macros for the implementation - classes. - -* The container object is now smaller thanks to using `boost::compressed_pair` - for EBO and a slightly different function buffer - now using a bool instead - of a member pointer. - -* Buckets are allocated lazily which means that constructing an empty container - will not allocate any memory. - -[heading Changes in Boost 1.40.0] - -* [@https://svn.boost.org/trac/boost/ticket/2975 Ticket 2975]: - Store the prime list as a preprocessor sequence - so that it will always get - the length right if it changes again in the future. -* [@https://svn.boost.org/trac/boost/ticket/1978 Ticket 1978]: - Implement `emplace` for all compilers. -* [@https://svn.boost.org/trac/boost/ticket/2908 Ticket 2908], - [@https://svn.boost.org/trac/boost/ticket/3096 Ticket 3096]: - Some workarounds for old versions of borland, including adding explicit - destructors to all containers. -* [@https://svn.boost.org/trac/boost/ticket/3082 Ticket 3082]: - Disable incorrect Visual C++ warnings. -* Better configuration for C++0x features when the headers aren't available. -* Create less buckets by default. - -[heading Changes in Boost 1.39.0] - -* [@https://svn.boost.org/trac/boost/ticket/2756 Ticket 2756]: Avoid a warning - on Visual C++ 2009. -* Some other minor internal changes to the implementation, tests and - documentation. -* Avoid an unnecessary copy in `operator[]`. -* [@https://svn.boost.org/trac/boost/ticket/2975 Ticket 2975]: Fix length of - prime number list. - -[heading Changes in Boost 1.38.0] - -* Use [@boost:/libs/core/swap.html `boost::swap`]. -* [@https://svn.boost.org/trac/boost/ticket/2237 Ticket 2237]: - Document that the equality and inequality operators are undefined for two - objects if their equality predicates aren't equivalent. Thanks to Daniel - Krügler. -* [@https://svn.boost.org/trac/boost/ticket/1710 Ticket 1710]: - Use a larger prime number list. Thanks to Thorsten Ottosen and Hervé - Brönnimann. -* Use - [@boost:/libs/type_traits/doc/html/boost_typetraits/category/alignment.html - aligned storage] to store the types. This changes the way the allocator is - used to construct nodes. It used to construct the node with two calls to - the allocator's `construct` method - once for the pointers and once for the - value. It now constructs the node with a single call to construct and - then constructs the value using in place construction. -* Add support for C++0x initializer lists where they're available (currently - only g++ 4.4 in C++0x mode). - -[heading Changes in Boost 1.37.0] - -* Rename overload of `emplace` with hint, to `emplace_hint` as specified in - [@http://www.open-std.org/JTC1/SC22/WG21/docs/papers/2008/n2691.pdf n2691]. -* Provide forwarding headers at `` and - ``. -* Move all the implementation inside `boost/unordered`, to assist - modularization and hopefully make it easier to track Changes in Boost subversion. - -[heading Changes in Boost 1.36.0] - -First official release. - -* Rearrange the internals. -* Move semantics - full support when rvalue references are available, emulated - using a cut down version of the Adobe move library when they are not. -* Emplace support when rvalue references and variadic template are available. -* More efficient node allocation when rvalue references and variadic template - are available. -* Added equality operators. - -[heading Boost 1.35.0 Add-on - 31st March 2008] - -Unofficial release uploaded to vault, to be used with Boost 1.35.0. Incorporated -many of the suggestions from the review. - -* Improved portability thanks to Boost regression testing. -* Fix lots of typos, and clearer text in the documentation. -* Fix floating point to `std::size_t` conversion when calculating sizes from - the max load factor, and use `double` in the calculation for greater accuracy. -* Fix some errors in the examples. - -[heading Review Version] - -Initial review version, for the review conducted from 7th December 2007 to -16th December 2007. - -[endsect] diff --git a/doc/comparison.qbk b/doc/comparison.qbk deleted file mode 100644 index 6f6bef9e..00000000 --- a/doc/comparison.qbk +++ /dev/null @@ -1,161 +0,0 @@ -[/ Copyright 2006-2011 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[section:comparison Comparison with Associative Containers] - -[table:interface_differences Interface differences. - [[Associative Containers] [Unordered Associative Containers]] - - [ - [Parameterized by an ordering relation `Compare`] - [Parameterized by a function object `Hash` and an equivalence relation - `Pred`] - ] - [ - [Keys can be compared using `key_compare` which is accessed by member function `key_comp()`, - values can be compared using `value_compare` which is accessed by member function `value_comp()`.] - [Keys can be hashed using `hasher` which is accessed by member function `hash_function()`, - and checked for equality using `key_equal` which is accessed by member function `key_eq()`. - There is no function object for compared or hashing values.] - ] - [ - [Constructors have optional extra parameters for the comparison object.] - [Constructors have optional extra parameters for the initial minimum - number of buckets, a hash function and an equality object.] - ] - - [ - [Keys `k1`, `k2` are considered equivalent if - `!Compare(k1, k2) && !Compare(k2, k1)`] - [Keys `k1`, `k2` are considered equivalent if `Pred(k1, k2)`] - ] - [ - [Member function `lower_bound(k)` and `upper_bound(k)`] - [No equivalent. Since the elements aren't ordered `lower_bound` and - `upper_bound` would be meaningless.] - ] - [ - [`equal_range(k)` returns an empty range at the position that k - would be inserted if k isn't present in the container.] - [`equal_range(k)` returns a range at the end of the container if - k isn't present in the container. It can't return a positioned - range as k could be inserted into multiple place. To find out the - bucket that k would be inserted into use `bucket(k)`. But remember - that an insert can cause the container to rehash - meaning that the - element can be inserted into a different bucket.] - ] - [ - [`iterator`, `const_iterator` are of the bidirectional category.] - [`iterator`, `const_iterator` are of at least the forward category.] - ] - [ - [Iterators, pointers and references to the container's elements are - never invalidated.] - [[link unordered.buckets.iterator_invalidation Iterators can - be invalidated by calls to insert or rehash]. Pointers and - references to the container's elements are never invalidated.] - ] - [ - [Iterators iterate through the container in the order defined by - the comparison object.] - [Iterators iterate through the container in an arbitrary order, that - can change as elements are inserted, although equivalent elements - are always adjacent.] - ] - [ - [No equivalent] - [Local iterators can be used to iterate through individual buckets. - (The order of local iterators and iterators aren't - required to have any correspondence.)] - ] - [ - [Can be compared using the `==`, `!=`, `<`, `<=`, `>`, `>=` operators.] - [Can be compared using the `==` and `!=` operators.] - ] - [ - [] - [When inserting with a hint, implementations are permitted to ignore - the hint.] - ] - [ - [`erase` never throws an exception] - [The containers' hash or predicate function can throw exceptions - from `erase`] - ] -] - -[table:complexity_guarantees Complexity Guarantees - [[Operation] [Associative Containers] [Unordered Associative Containers]] - [ - [Construction of empty container] - [constant] - [O(/n/) where /n/ is the minimum number of buckets.] - ] - [ - [Construction of container from a range of /N/ elements] - [O(/N/ log /N/), O(/N/) if the range is sorted with `value_comp()`] - [Average case O(/N/), worst case - O(/N/'''2''')] - ] - [ - [Insert a single element] - [logarithmic] - [Average case constant, worst case linear] - ] - [ - [Insert a single element with a hint] - [Amortized constant if t elements inserted right after hint, - logarithmic otherwise] - [Average case constant, worst case linear (ie. the same as - a normal insert).] - ] - [ - [Inserting a range of /N/ elements] - [ /N/ log(`size()`+/N/) ] - [Average case O(/N/), worst case O(/N/ * `size()`)] - ] - [ - [Erase by key, `k`] - [O(log(`size()`) + `count(k)`)] - [Average case: O(`count(k)`), Worst case: O(`size()`)] - ] - [ - [Erase a single element by iterator] - [Amortized constant] - [Average case: O(1), Worst case: O(`size()`)] - ] - [ - [Erase a range of /N/ elements] - [O(log(`size()`) + /N/)] - [Average case: O(/N/), Worst case: O(`size()`)] - ] - [ - [Clearing the container] - [O(`size()`)] - [O(`size()`)] - ] - [ - [Find] - [logarithmic] - [Average case: O(1), Worst case: O(`size()`)] - ] - [/ TODO: Average case is probably wrong. ] - [ - [Count] - [O(log(`size()`) + `count(k)`)] - [Average case: O(1), Worst case: O(`size()`)] - ] - [ - [`equal_range(k)`] - [logarithmic] - [Average case: O(`count(k)`), Worst case: O(`size()`)] - ] - [ - [`lower_bound`,`upper_bound`] - [logarithmic] - [n/a] - ] -] - -[endsect] diff --git a/doc/compliance.qbk b/doc/compliance.qbk deleted file mode 100644 index 7769df4c..00000000 --- a/doc/compliance.qbk +++ /dev/null @@ -1,128 +0,0 @@ -[/ Copyright 2011 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[section:compliance Standard Compliance] - -The intent of Boost.Unordered is to implement a close (but imperfect) -implementation of the C++17 standard, that will work with C++98 upwards. -The wide compatibility does mean some comprimises have to be made. -With a compiler and library that fully support C++11, the differences should -be minor. - -[section:move Move emulation] - -Support for move semantics is implemented using Boost.Move. If rvalue -references are available it will use them, but if not it uses a close, -but imperfect emulation. On such compilers: - -* Non-copyable objects can be stored in the containers. - They can be constructed in place using `emplace`, or if they support - Boost.Move, moved into place. -* The containers themselves are not movable. -* Argument forwarding is not perfect. - -[endsect] - -[section:allocator_compliance Use of allocators] - -C++11 introduced a new allocator system. It's backwards compatible due to -the lax requirements for allocators in the old standard, but might need -some changes for allocators which worked with the old versions of the -unordered containers. -It uses a traits class, `allocator_traits` to handle the allocator -adding extra functionality, and making some methods and types optional. -During development a stable release of -`allocator_traits` wasn't available so an internal partial implementation -is always used in this version. Hopefully a future version will use the -standard implementation where available. - -The member functions `construct`, `destroy` and `max_size` are now -optional, if they're not available a fallback is used. -A full implementation of `allocator_traits` requires sophisticated -member function detection so that the fallback is used whenever the -member function call is not well formed. -This requires support for SFINAE expressions, which are available on -GCC from version 4.4 and Clang. - -On other compilers, there's just a test to see if the allocator has -a member, but no check that it can be called. So rather than using a -fallback there will just be a compile error. - -`propagate_on_container_copy_assignment`, -`propagate_on_container_move_assignment`, -`propagate_on_container_swap` and -`select_on_container_copy_construction` are also supported. -Due to imperfect move emulation, some assignments might check -`propagate_on_container_copy_assignment` on some compilers and -`propagate_on_container_move_assignment` on others. - -[endsect] - -[section:construction Construction/Destruction using allocators] - -The following support is required for full use of C++11 style -construction/destruction: - -* Variadic templates. -* Piecewise construction of `std::pair`. -* Either `std::allocator_traits` or expression SFINAE. - -This is detected using Boost.Config. The macro -`BOOST_UNORDERED_CXX11_CONSTRUCTION` will be set to 1 if it is found, or 0 -otherwise. - -When this is the case `allocator_traits::construct` and -`allocator_traits::destroy` will always be used, apart from when piecewise -constructing a `std::pair` using `boost::tuple` (see [link -unordered.compliance.pairs below]), but that should be easily avoided. - -When support is not available `allocator_traits::construct` and -`allocator_traits::destroy` are never called. - -[endsect] - -[section:pointer_traits Pointer Traits] - -`pointer_traits` aren't used. Instead, pointer types are obtained from -rebound allocators, this can cause problems if the allocator can't be -used with incomplete types. If `const_pointer` is not defined in the -allocator, `boost::pointer_to_other::type` -is used to obtain a const pointer. - -[endsect] - -[#unordered.compliance.pairs] -[section:pairs Pairs] - -Since the containers use `std::pair` they're limited to the version -from the current standard library. But since C++11 `std::pair`'s -`piecewise_construct` based constructor is very useful, `emplace` -emulates it with a `piecewise_construct` in the `boost::unordered` -namespace. So for example, the following will work: - - boost::unordered_multimap x; - - x.emplace( - boost::unordered::piecewise_construct, - boost::make_tuple("key"), boost::make_tuple(1, 2)); - -Older drafts of the standard also supported variadic constructors -for `std::pair`, where the first argument would be used for the -first part of the pair, and the remaining for the second part. - -[endsect] - -[section:misc Miscellaneous] - -When swapping, `Pred` and `Hash` are not currently swapped by calling -`swap`, their copy constructors are used. As a consequence when swapping -an exception may be thrown from their copy constructor. - -Variadic constructor arguments for `emplace` are only used when both -rvalue references and variadic template parameters are available. -Otherwise `emplace` can only take up to 10 constructors arguments. - -[endsect] - -[endsect] diff --git a/doc/diagrams/buckets.svg b/doc/diagrams/buckets.svg deleted file mode 100644 index d16b432c..00000000 --- a/doc/diagrams/buckets.svg +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - Bucket 1 - - - - Bucket 2 - - - - Bucket 3 - - - - Bucket 4 - - - - Bucket 5 - - - - Bucket 6 - - - - Bucket 7 - - - - A - - - B - - - C - - - D - - - E - diff --git a/doc/hash_equality.qbk b/doc/hash_equality.qbk deleted file mode 100644 index c13fcc48..00000000 --- a/doc/hash_equality.qbk +++ /dev/null @@ -1,86 +0,0 @@ -[/ Copyright 2006-2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[section:hash_equality Equality Predicates and Hash Functions] - -While the associative containers use an ordering relation to specify how the -elements are stored, the unordered associative containers use an equality -predicate and a hash function. For example, [classref boost::unordered_map] -is declared as: - - template < - class Key, class Mapped, - class Hash = ``[classref boost::hash]``, - class Pred = std::equal_to, - class Alloc = std::allocator > > - class ``[classref boost::unordered_map unordered_map]``; - -The hash function comes first as you might want to change the hash function -but not the equality predicate. For example, if you wanted to use the -[@http://www.isthe.com/chongo/tech/comp/fnv/ FNV-1 hash] you could write: - -[import src_code/dictionary.cpp] -[case_sensitive_dictionary_fnv] - -There is an [@boost:/libs/unordered/examples/fnv1.hpp implementation -of FNV-1] in the examples directory. - -If you wish to use a different equality function, -you will also need to use a matching hash function. For -example, to implement a case insensitive dictionary you need to define a -case insensitive equality predicate and hash function: - -[case_insensitive_functions] - -Which you can then use in a case insensitive dictionary: - -[case_insensitive_dictionary] - -This is a simplified version of the example at -[@boost:/libs/unordered/examples/case_insensitive.hpp /libs/unordered/examples/case_insensitive.hpp] -which supports other locales and string types. - -[caution -Be careful when using the equality (`==`) operator with custom equality -predicates, especially if you're using a function pointer. If you compare two -containers with different equality predicates then the result is undefined. -For most stateless function objects this is impossible - since you can only -compare objects with the same equality predicate you know the equality -predicates must be equal. But if you're using function pointers or a stateful -equality predicate (e.g. boost::function) then you can get into trouble. -] - -[h2 Custom Types] - -Similarly, a custom hash function can be used for custom types: - -[import src_code/point1.cpp] -[point_example1] - -Since the default hash function is [link hash Boost.Hash], -we can [link hash.custom extend it to support the type] -so that the hash function doesn't need to be explicitly given: - -[import src_code/point2.cpp] -[point_example2] - -See the [link hash.custom Boost.Hash documentation] for more detail on how to -do this. Remember that it relies on extensions to the draft standard - so it -won't work for other implementations of the unordered associative containers, -you'll need to explicitly use Boost.Hash. - -[table:access_methods Methods for accessing the hash and equality functions. - [[Method] [Description]] - - [ - [`hasher hash_function() const`] - [Returns the container's hash function.] - ] - [ - [`key_equal key_eq() const`] - [Returns the container's key equality function.] - ] -] - -[endsect] diff --git a/doc/intro.qbk b/doc/intro.qbk deleted file mode 100644 index 73e6e48c..00000000 --- a/doc/intro.qbk +++ /dev/null @@ -1,101 +0,0 @@ -[/ Copyright 2006-2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[def __hash-table__ [@http://en.wikipedia.org/wiki/Hash_table - hash table]] -[def __hash-function__ [@http://en.wikipedia.org/wiki/Hash_function - hash function]] - -[section:intro Introduction] - -For accessing data based on key lookup, the C++ standard library offers `std::set`, -`std::map`, `std::multiset` and `std::multimap`. These are generally -implemented using balanced binary trees so that lookup time has -logarithmic complexity. That is generally okay, but in many cases a -__hash-table__ can perform better, as accessing data has constant complexity, -on average. The worst case complexity is linear, but that occurs rarely and -with some care, can be avoided. - -Also, the existing containers require a 'less than' comparison object -to order their elements. For some data types this is impossible to implement -or isn't practical. In contrast, a hash table only needs an equality function -and a hash function for the key. - -With this in mind, unordered associative containers were added to the C++ -standard. This is an implementation of the containers described in C++11, -with some [link unordered.compliance deviations from the standard] in -order to work with non-C++11 compilers and libraries. - -`unordered_set` and `unordered_multiset` are defined in the header -<[headerref boost/unordered_set.hpp]> - - namespace boost { - template < - class Key, - class Hash = ``[classref boost::hash]``, - class Pred = std::equal_to, - class Alloc = std::allocator > - class ``[classref boost::unordered_set unordered_set]``; - - template< - class Key, - class Hash = ``[classref boost::hash]``, - class Pred = std::equal_to, - class Alloc = std::allocator > - class ``[classref boost::unordered_multiset unordered_multiset]``; - } - -`unordered_map` and `unordered_multimap` are defined in the header -<[headerref boost/unordered_map.hpp]> - - namespace boost { - template < - class Key, class Mapped, - class Hash = ``[classref boost::hash]``, - class Pred = std::equal_to, - class Alloc = std::allocator > > - class ``[classref boost::unordered_map unordered_map]``; - - template< - class Key, class Mapped, - class Hash = ``[classref boost::hash]``, - class Pred = std::equal_to, - class Alloc = std::allocator > > - class ``[classref boost::unordered_multimap unordered_multimap]``; - } - -When using Boost.TR1, these classes are included from `` and -``, with the classes added to the `std::tr1` namespace. - -The containers are used in a similar manner to the normal associative -containers: - -[import src_code/intro.cpp] -[intro_example1_2] - -But since the elements aren't ordered, the output of: - -[intro_example1_3] - -can be in any order. For example, it might be: - - two,2 - one,1 - three,3 - -To store an object in an unordered associative container requires both a -key equality function and a hash function. The default function objects in -the standard containers support a few basic types including integer types, -floating point types, pointer types, and the standard strings. Since -Boost.Unordered uses [classref boost::hash] it also supports some other types, -including standard containers. To use any types not supported by these methods -you have to [link hash.custom extend Boost.Hash to support the type] or use -your own custom equality predicates and hash functions. See the -[link unordered.hash_equality Equality Predicates and Hash Functions] section -for more details. - -There are other differences, which are listed in the -[link unordered.comparison Comparison with Associative Containers] section. - -[endsect] diff --git a/doc/rationale.qbk b/doc/rationale.qbk deleted file mode 100644 index 88af0702..00000000 --- a/doc/rationale.qbk +++ /dev/null @@ -1,111 +0,0 @@ -[/ Copyright 2006-2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[def __wang__ - [@http://web.archive.org/web/20121102023700/http://www.concentric.net/~Ttwang/tech/inthash.htm - Thomas Wang's article on integer hash functions]] - -[section:rationale Implementation Rationale] - -The intent of this library is to implement the unordered -containers in the draft standard, so the interface was fixed. But there are -still some implementation decisions to make. The priorities are -conformance to the standard and portability. - -The [@http://en.wikipedia.org/wiki/Hash_table Wikipedia article on hash tables] -has a good summary of the implementation issues for hash tables in general. - -[h2 Data Structure] - -By specifying an interface for accessing the buckets of the container the -standard pretty much requires that the hash table uses chained addressing. - -It would be conceivable to write a hash table that uses another method. For -example, it could use open addressing, and use the lookup chain to act as a -bucket but there are some serious problems with this: - -* The draft standard requires that pointers to elements aren't invalidated, so - the elements can't be stored in one array, but will need a layer of - indirection instead - losing the efficiency and most of the memory gain, - the main advantages of open addressing. - -* Local iterators would be very inefficient and may not be able to - meet the complexity requirements. - -* There are also the restrictions on when iterators can be invalidated. Since - open addressing degrades badly when there are a high number of collisions the - restrictions could prevent a rehash when it's really needed. The maximum load - factor could be set to a fairly low value to work around this - but the - standard requires that it is initially set to 1.0. - -* And since the standard is written with a eye towards chained - addressing, users will be surprised if the performance doesn't reflect that. - -So chained addressing is used. - -[/ (Removing for now as this is out of date) - -For containers with unique keys I store the buckets in a single-linked list. -There are other possible data structures (such as a double-linked list) -that allow for some operations to be faster (such as erasing and iteration) -but the possible gain seems small compared to the extra memory needed. -The most commonly used operations (insertion and lookup) would not be improved -at all. - -But for containers with equivalent keys a single-linked list can degrade badly -when a large number of elements with equivalent keys are inserted. I think it's -reasonable to assume that users who choose to use `unordered_multiset` or -`unordered_multimap` do so because they are likely to insert elements with -equivalent keys. So I have used an alternative data structure that doesn't -degrade, at the expense of an extra pointer per node. - -This works by adding storing a circular linked list for each group of equivalent -nodes in reverse order. This allows quick navigation to the end of a group (since -the first element points to the last) and can be quickly updated when elements -are inserted or erased. The main disadvantage of this approach is some hairy code -for erasing elements. -] - -[/ (Starting to write up new structure, might not be ready in time) -The node used to be stored in a linked list for each bucket but that -didn't meet the complexity requirements for C++11, so now the nodes -are stored in one long single linked list. But there needs a way to get -the bucket from the node, to do that a copy of the key's hash value is -stored in the node. Another possibility would be to store a pointer to -the bucket, or the bucket's index, but storing the hash value allows -some operations to be faster. -] - -[h2 Number of Buckets] - -There are two popular methods for choosing the number of buckets in a hash -table. One is to have a prime number of buckets, another is to use a power -of 2. - -Using a prime number of buckets, and choosing a bucket by using the modulus -of the hash function's result will usually give a good result. The downside -is that the required modulus operation is fairly expensive. This is what the -containers do in most cases. - -Using a power of 2 allows for much quicker selection of the bucket -to use, but at the expense of losing the upper bits of the hash value. -For some specially designed hash functions it is possible to do this and -still get a good result but as the containers can take arbitrary hash -functions this can't be relied on. - -To avoid this a transformation could be applied to the hash function, for an -example see __wang__. Unfortunately, a transformation like Wang's requires -knowledge of the number of bits in the hash value, so it isn't portable enough -to use as a default. It can applicable in certain cases so the containers -have a policy based implementation that can use this alternative technique. - -Currently this is only done on 64 bit architectures, where prime number -modulus can be expensive. Although this varies depending on the architecture, -so I probably should revisit it. - -I'm also thinking of introducing a mechanism whereby a hash function can -indicate that it's safe to be used directly with power of 2 buckets, in -which case a faster plain power of 2 implementation can be used. - -[endsect] diff --git a/doc/ref.php b/doc/ref.php deleted file mode 100644 index 9a569455..00000000 --- a/doc/ref.php +++ /dev/null @@ -1,1962 +0,0 @@ - - - - - -EOL; - - $key_type = 'Key'; - $key_name = 'key'; - $value_type = 'std::pair<Key const, Mapped>'; - $full_type = $name.'<Key, Mapped, Hash, Pred, Alloc>'; - } - else - { - $template_value = << - - -EOL; - - $key_type = 'Value'; - $key_name = 'value'; - $value_type = 'Value'; - $full_type = $name.'<Value, Hash, Pred, Alloc>'; - } -?> - - - - An unordered associative container that - - - - Template Parameters - - - - - - Key - Key must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - Mapped - Mapped must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - - Value - Value must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - - Hash - A unary function object type that acts a hash function for a . It takes a single argument of type and returns a value of type std::size_t. - - Pred - A binary function object that implements an equivalence relation on values of type . - A binary function object that induces an equivalence relation on values of type . - It takes two arguments of type 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. - The number of buckets can be automatically increased by a call to insert, or as the result of calling rehash. - - - - - - - - - - Mapped - - - - Hash - - - Pred - - - Alloc - - - typename allocator_type::pointer - - - value_type* if - allocator_type::pointer is not defined. - - - - - typename allocator_type::const_pointer - - - boost::pointer_to_other<pointer, value_type>::type - if allocator_type::const_pointer is not defined. - - - - - value_type& - lvalue of value_type. - - - value_type const& - const lvalue of value_type. - - - implementation-defined - - 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. - - - - implementation-defined - - iterator whose value type is value_type. - The iterator category is at least a forward iterator. - Convertible to const_iterator. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward 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. - - - - 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. - - - - implementation-defined - - See node_handle_ for details. - - - - - implementation-defined - - Structure returned by inserting node_type. - - - - - - size() == 0 - - - Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - allocator_type() - - - 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 allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - const& - - - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - If Allocator::select_on_container_copy_construction - exists and has the right signature, the allocator will be - constructed from its result. - - - value_type is copy constructible - - - - - && - - - The move constructor. - - - This is implemented using Boost.Move. - - - - value_type is move constructible. - - - On compilers without rvalue reference support the - emulation does not support moving without calling - boost::move if value_type is - not copyable. So, for example, you can't return the - container from a function. - - - - - - Allocator const& - - - Constructs an empty container, using allocator a. - - - - - const& - - - Allocator const& - - - Constructs an container, copying x's contained elements, hash function, predicate, maximum load factor, but using allocator a. - - - - - && - - - Allocator const& - - - Construct a container moving x's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a. - - - This is implemented using Boost.Move. - - - - value_type is move insertable. - - - - - - initializer_list<value_type> - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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 il into it. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default hash function and key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - hasher and key_equal need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - key_equal needs to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using a as the allocator, with the - default hash function and key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - hasher, key_equal need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - hasher const& - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - a as the allocator, with the - default key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - key_equal needs to be DefaultConstructible. - - - - - - The destructor is applied to every element, and all memory is deallocated - - - - - const& - - & - - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - If Alloc::propagate_on_container_copy_assignment - exists and Alloc::propagate_on_container_copy_assignment::value - is true, the allocator is overwritten, if not the - copied elements are created using the existing - allocator. - - - value_type is copy constructible - - - - - && - - & - - The move assignment operator. - If Alloc::propagate_on_container_move_assignment - exists and Alloc::propagate_on_container_move_assignment::value - is true, the allocator is overwritten, if not the - moved elements are created using the existing - allocator. - - - - On compilers without rvalue references, this is emulated using - Boost.Move. Note that on some compilers the copy assignment - operator may be used in some circumstances. - - - - - value_type is move constructible. - - - - - - initializer_list<value_type> - - & - - Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed. - - - - value_type is CopyInsertable into the container and - CopyAssignable. - - - - - allocator_type - - - - bool - - size() == 0 - - - - size_type - - std::distance(begin(), end()) - - - - size_type - size() of the largest possible container. - - - - - - iterator - const_iterator - An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - - iterator - - - const_iterator - - An iterator which refers to the past-the-end value for the container. - - - - const_iterator - A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - const_iterator - A constant iterator which refers to the past-the-end value for the container. - - - - - - - - Args&& - - - - Inserts an object, constructed with the arguments args, in the container - - - value_type is EmplaceConstructible into - X from args. - - - - - 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 . - - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - - const_iterator - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, in the container - hint is a suggestion to where the element should be inserted. - - - value_type is EmplaceConstructible into - X from args. - - - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - value_type const& - - - - Inserts obj in the container - - - value_type is CopyInsertable. - - - - 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 . - - - - 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 - - - value_type is MoveInsertable. - - - - 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 . - - - - 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 - - - value_type const& - - 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. - - - value_type is CopyInsertable. - - - - 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. - - - value_type is MoveInsertable. - - - - 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. - - - - - - InputIterator - - - InputIterator - - 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_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - node_type - - Removes the element pointed to by position. - - - A node_type owning the element. - - - - In C++17 a node extracted using this method can be inserted into a compatible , - but that is not supported yet. - - - - - - key_type const& - - node_type - - Removes an element with key equivalent to k. - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible , - but that is not supported yet. - - - - - - - K&& - - node_type - - Removes an element with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible , - but that is not supported yet. - - - - - - node_type&& - - - - If nh is empty, has no affect. - - Otherwise inserts the element owned by nh - - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent . - - - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted element. - - If nh was empty, returns an insert_return_type with: - inserted equal to false, - position equal to end() and - node empty. - Otherwise if there was already an element with an equivalent key, returns an insert_return_type with: - inserted equal to false, - position pointing to a matching element and - node contains the node from nh. - Otherwise if the insertion succeeded, returns an insert_return_type with: - inserted equal to true, - position pointing to the newly inserted element and - node empty. - - - - 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. - In C++17 this can be used to insert a node extracted from a compatible , - but that is not supported yet. - - - - - const_iterator - - - node_type&& - - iterator - - If nh is empty, has no affect. - - Otherwise inserts the element owned by nh - - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent . - - If there is already an element in the container with an equivalent - has no effect on nh (i.e. nh still contains the node.) - - hint is a suggestion to where the element should be inserted. - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted element. - - If nh was empty returns end(). - If there was already an element in the container with an equivalent - returns an iterator pointing to that. - Otherwise returns an iterator pointing to the newly inserted element. - - - - 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. - In C++17 this can be used to insert a node extracted from a compatible , - but that is not supported yet. - - - - - const_iterator - - iterator - - Erase the element pointed to by position. - - - The iterator following position before the erasure. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In older versions this could be inefficient because it had to search - through several buckets to find the position of the returned iterator. - The data structure has been changed so that this is no longer the case, - and the alternative erase methods have been deprecated. - - - - - - key_type const& - - size_type - - Erase all elements with key equivalent to k. - - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - - - K&& - - size_type - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - Erase all elements with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - const_iterator - - - const_iterator - - iterator - - Erases the elements in the range from first to last. - - - The iterator following the erased elements - i.e. last. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - void - - Erases all elements in the container. - - - size() == 0 - - - Never throws an exception. - - - - - & - - void - - Swaps the contents of the container with the parameter. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - <Key, Mapped, H2, P2, Alloc>& - - <Value, H2, P2, Alloc>& - - - - Does not support merging with a compatible yet. - - - - - - - <Key, Mapped, H2, P2, Alloc>&& - - <Value, H2, P2, Alloc>&& - - - - Does not support merging with a compatible yet. - - - - - - - <Key, Mapped, H2, P2, Alloc>& - - <Value, H2, P2, Alloc>& - - - - - - - - <Key, Mapped, H2, P2, Alloc>&& - - <Value, H2, P2, Alloc>&& - - - -*/ ?> - - - - hasher - The container's hash function. - - - - key_equal - The container's key equality predicate. - - - - - - - - key_type const& - - iterator - - - - key_type const& - - const_iterator - - - - - K const& - - iterator - - - - - K const& - - const_iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - const_iterator - - - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - - - - The templated overloads containing CompatibleKey, - CompatibleHash and CompatiblePredicate - are non-standard extensions which allow you to use a compatible - hash function and equality predicate for a key of a different type - in order to avoid an expensive type cast. In general, its use is - not encouraged and instead the K member function - templates should be used. - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - bool - - - - - K const& - - bool - - - - A boolean indicating whether or not there is an element with key equal to key in the container - - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - size_type - - - - - K const& - - size_type - - - The number of elements with key equivalent to k. - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - std::pair<iterator, iterator> - - - - key_type const& - - std::pair<const_iterator, const_iterator> - - - - - K const& - - std::pair<iterator, iterator> - - - - - K const& - - std::pair<const_iterator, const_iterator> - - - A range containing all elements with key equivalent to k. - If the container doesn't contain any such elements, returns - std::make_pair(b.end(),b.end()). - - - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - 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 - - - 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. - - - - Mapped& - key_type const& - Mapped const& - key_type const& - - A reference to x.second where x is the (unique) element whose key is equivalent to k. - - - An exception object of type std::out_of_range if no such element is present. - - - - - - - size_type - - The number of buckets. - - - - size_type - - An upper bound on the number of buckets. - - - - - size_type - - size_type - - n < bucket_count() - - - The number of elements in bucket n. - - - - - key_type const& - - size_type - - The index of the bucket which would contain an element with key k. - - - The return value is less than bucket_count() - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - n shall be in the range [0, bucket_count()). - - - A local iterator pointing the first element in the bucket with index n. - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - 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. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the first element in the bucket with index n. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the 'one past the end' element in the bucket with index n. - - - - - - float - - The average number of elements per bucket. - - - - float - - Returns the current maximum load factor. - - - - - float - - void - - Changes the container's maximum load factor, using z as a hint. - - - - - size_type - - 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. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - size_type - - void - - Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - - - - const& - - - const& - - bool - - - Return true if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - Return true if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - const& - - - const& - - bool - - - Return false if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - Return false if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - - - & - - - & - - void - - x.swap(y) - - - Swaps the contents of x and y. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - - - - - An object that owns a single element extracted from an - unordered_ or an - unordered_multi, that - can then be inserted into a compatible container type. - - - The name and template parameters of this type are implementation - defined, and should be obtained using the node_type - member typedef from the appropriate container. - - - - - typename Container::key_type - - - typename Container::mapped_type - - - - typename Container::value_type> - - - - typename Container::allocator_type> - - - - - - - && - - - - - && - - & - - - - key_type& - - - mapped_type& - - - - value_type& - - - - allocator_type - - - - - bool - - - - & - - void - - - In C++17 is also noexcept if ator_traits::is_always_equal::value is true. - But we don't support that trait yet. - - - - - - - - & - - - & - - void - - x.swap(y) - - - - - - - -
- - - -
-
- - - -
- diff --git a/doc/ref.xml b/doc/ref.xml deleted file mode 100644 index 2e49f4b4..00000000 --- a/doc/ref.xml +++ /dev/null @@ -1,6585 +0,0 @@ - -
- - - - - An unordered associative container that stores unique values. - - - Template Parameters - - - - - Value - Value must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - 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 Value. - It takes two arguments of type Value 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. - - - Value - - - Value - - - Hash - - - Pred - - - Alloc - - - typename allocator_type::pointer - - - value_type* if - allocator_type::pointer is not defined. - - - - - typename allocator_type::const_pointer - - - boost::pointer_to_other<pointer, value_type>::type - if allocator_type::const_pointer is not defined. - - - - - value_type& - lvalue of value_type. - - - value_type const& - const lvalue of value_type. - - - implementation-defined - - 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. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward iterator. - Convertible to const_iterator. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward 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. - - - - 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. - - - - implementation-defined - - See node_handle_set for details. - - - - implementation-defined - - Structure returned by inserting node_type. - - - - - size() == 0 - - - Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - allocator_type() - - - 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 allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - unordered_set const& - - - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - If Allocator::select_on_container_copy_construction - exists and has the right signature, the allocator will be - constructed from its result. - - - value_type is copy constructible - - - - - unordered_set && - - - The move constructor. - - - This is implemented using Boost.Move. - - - - value_type is move constructible. - - - On compilers without rvalue reference support the - emulation does not support moving without calling - boost::move if value_type is - not copyable. So, for example, you can't return the - container from a function. - - - - - - Allocator const& - - - Constructs an empty container, using allocator a. - - - - - unordered_set const& - - - Allocator const& - - - Constructs an container, copying x's contained elements, hash function, predicate, maximum load factor, but using allocator a. - - - - - unordered_set && - - - Allocator const& - - - Construct a container moving x's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a. - - - This is implemented using Boost.Move. - - - - value_type is move insertable. - - - - - - initializer_list<value_type> - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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 il into it. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default hash function and key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - hasher and key_equal need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - key_equal needs to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using a as the allocator, with the - default hash function and key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - hasher, key_equal need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - hasher const& - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - a as the allocator, with the - default key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - key_equal needs to be DefaultConstructible. - - - - - - The destructor is applied to every element, and all memory is deallocated - - - - - unordered_set const& - - unordered_set& - - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - If Alloc::propagate_on_container_copy_assignment - exists and Alloc::propagate_on_container_copy_assignment::value - is true, the allocator is overwritten, if not the - copied elements are created using the existing - allocator. - - - value_type is copy constructible - - - - - unordered_set && - - unordered_set& - - The move assignment operator. - If Alloc::propagate_on_container_move_assignment - exists and Alloc::propagate_on_container_move_assignment::value - is true, the allocator is overwritten, if not the - moved elements are created using the existing - allocator. - - - - On compilers without rvalue references, this is emulated using - Boost.Move. Note that on some compilers the copy assignment - operator may be used in some circumstances. - - - - - value_type is move constructible. - - - - - - initializer_list<value_type> - - unordered_set& - - Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed. - - - - value_type is CopyInsertable into the container and - CopyAssignable. - - - - - allocator_type - - - - bool - - size() == 0 - - - - size_type - - std::distance(begin(), end()) - - - - size_type - size() of the largest possible container. - - - - - - iterator - const_iterator - An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - - iterator - - - const_iterator - - An iterator which refers to the past-the-end value for the container. - - - - const_iterator - A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - const_iterator - A constant iterator which refers to the past-the-end value for the container. - - - - - - - - Args&& - - std::pair<iterator, bool> - - Inserts an object, constructed with the arguments args, in the container if and only if there is no element in the container with an equivalent value. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - - const_iterator - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, 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. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - value_type const& - - std::pair<iterator, bool> - - Inserts obj in the container if and only if there is no element in the container with an equivalent value. - - - value_type is CopyInsertable. - - - 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. - - - - - 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. - - - value_type is MoveInsertable. - - - 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 - - - value_type 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. - - - value_type is CopyInsertable. - - - 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. - - - - - 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. - - - value_type is MoveInsertable. - - - 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. - - - - - - InputIterator - - - InputIterator - - 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. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - node_type - - Removes the element pointed to by position. - - - A node_type owning the element. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multiset, - but that is not supported yet. - - - - - - key_type const& - - node_type - - Removes an element with key equivalent to k. - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multiset, - but that is not supported yet. - - - - - - - K&& - - node_type - - Removes an element with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multiset, - but that is not supported yet. - - - - - - node_type&& - - insert_return_type - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent value. - - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns an insert_return_type with: - inserted equal to false, - position equal to end() and - node empty. - Otherwise if there was already an element with an equivalent key, returns an insert_return_type with: - inserted equal to false, - position pointing to a matching element and - node contains the node from nh. - Otherwise if the insertion succeeded, returns an insert_return_type with: - inserted equal to true, - position pointing to the newly inserted element and - node empty. - - - 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. - In C++17 this can be used to insert a node extracted from a compatible unordered_multiset, - but that is not supported yet. - - - - - const_iterator - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent value. - - If there is already an element in the container with an equivalent value has no effect on nh (i.e. nh still contains the node.) - hint is a suggestion to where the element should be inserted. - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty returns end(). - If there was already an element in the container with an equivalent value returns an iterator pointing to that. - Otherwise returns an iterator pointing to the newly inserted element. - - - 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. - In C++17 this can be used to insert a node extracted from a compatible unordered_multiset, - but that is not supported yet. - - - - - const_iterator - - iterator - - Erase the element pointed to by position. - - - The iterator following position before the erasure. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In older versions this could be inefficient because it had to search - through several buckets to find the position of the returned iterator. - The data structure has been changed so that this is no longer the case, - and the alternative erase methods have been deprecated. - - - - - - key_type const& - - size_type - - Erase all elements with key equivalent to k. - - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - - - K&& - - size_type - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - Erase all elements with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - const_iterator - - - const_iterator - - iterator - - Erases the elements in the range from first to last. - - - The iterator following the erased elements - i.e. last. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - void - - Erases all elements in the container. - - - size() == 0 - - - Never throws an exception. - - - - - unordered_set& - - void - - Swaps the contents of the container with the parameter. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - unordered_set<Value, H2, P2, Alloc>& - - - Does not support merging with a compatible unordered_multiset yet. - - - - - - unordered_set<Value, H2, P2, Alloc>&& - - - Does not support merging with a compatible unordered_multiset yet. - - - - - - hasher - The container's hash function. - - - - key_equal - The container's key equality predicate. - - - - - - - - key_type const& - - iterator - - - - key_type const& - - const_iterator - - - - - K const& - - iterator - - - - - K const& - - const_iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - const_iterator - - - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - - - - The templated overloads containing CompatibleKey, - CompatibleHash and CompatiblePredicate - are non-standard extensions which allow you to use a compatible - hash function and equality predicate for a key of a different type - in order to avoid an expensive type cast. In general, its use is - not encouraged and instead the K member function - templates should be used. - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - bool - - - - - K const& - - bool - - - - A boolean indicating whether or not there is an element with key equal to key in the container - - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - size_type - - - - - K const& - - size_type - - - The number of elements with key equivalent to k. - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - std::pair<iterator, iterator> - - - - key_type const& - - std::pair<const_iterator, const_iterator> - - - - - K const& - - std::pair<iterator, iterator> - - - - - K const& - - std::pair<const_iterator, const_iterator> - - - A range containing all elements with key equivalent to k. - If the container doesn't contain any such elements, returns - std::make_pair(b.end(),b.end()). - - - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - size_type - - The number of buckets. - - - - size_type - - An upper bound on the number of buckets. - - - - - size_type - - size_type - - n < bucket_count() - - - The number of elements in bucket n. - - - - - key_type const& - - size_type - - The index of the bucket which would contain an element with key k. - - - The return value is less than bucket_count() - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - n shall be in the range [0, bucket_count()). - - - A local iterator pointing the first element in the bucket with index n. - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - 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. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the first element in the bucket with index n. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the 'one past the end' element in the bucket with index n. - - - - - - float - - The average number of elements per bucket. - - - - float - - Returns the current maximum load factor. - - - - - float - - void - - Changes the container's maximum load factor, using z as a hint. - - - - - size_type - - 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. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - size_type - - void - - Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - - - - unordered_set<Value, Hash, Pred, Alloc> const& - - - unordered_set<Value, Hash, Pred, Alloc> const& - - bool - - Return true if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - unordered_set<Value, Hash, Pred, Alloc> const& - - - unordered_set<Value, Hash, Pred, Alloc> const& - - bool - - Return false if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - - - unordered_set<Value, Hash, Pred, Alloc>& - - - unordered_set<Value, Hash, Pred, Alloc>& - - void - - x.swap(y) - - - Swaps the contents of x and y. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - - An unordered associative container that stores values. The same key can be stored multiple times. - - - Template Parameters - - - - - Value - Value must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - 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 Value. - It takes two arguments of type Value 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. - - - Value - - - Value - - - Hash - - - Pred - - - Alloc - - - typename allocator_type::pointer - - - value_type* if - allocator_type::pointer is not defined. - - - - - typename allocator_type::const_pointer - - - boost::pointer_to_other<pointer, value_type>::type - if allocator_type::const_pointer is not defined. - - - - - value_type& - lvalue of value_type. - - - value_type const& - const lvalue of value_type. - - - implementation-defined - - 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. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward iterator. - Convertible to const_iterator. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward 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. - - - - 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. - - - - implementation-defined - - See node_handle_set for details. - - - - - size() == 0 - - - Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - allocator_type() - - - 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 allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - unordered_multiset const& - - - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - If Allocator::select_on_container_copy_construction - exists and has the right signature, the allocator will be - constructed from its result. - - - value_type is copy constructible - - - - - unordered_multiset && - - - The move constructor. - - - This is implemented using Boost.Move. - - - - value_type is move constructible. - - - On compilers without rvalue reference support the - emulation does not support moving without calling - boost::move if value_type is - not copyable. So, for example, you can't return the - container from a function. - - - - - - Allocator const& - - - Constructs an empty container, using allocator a. - - - - - unordered_multiset const& - - - Allocator const& - - - Constructs an container, copying x's contained elements, hash function, predicate, maximum load factor, but using allocator a. - - - - - unordered_multiset && - - - Allocator const& - - - Construct a container moving x's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a. - - - This is implemented using Boost.Move. - - - - value_type is move insertable. - - - - - - initializer_list<value_type> - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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 il into it. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default hash function and key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - hasher and key_equal need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - key_equal needs to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using a as the allocator, with the - default hash function and key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - hasher, key_equal need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - hasher const& - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - a as the allocator, with the - default key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - key_equal needs to be DefaultConstructible. - - - - - - The destructor is applied to every element, and all memory is deallocated - - - - - unordered_multiset const& - - unordered_multiset& - - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - If Alloc::propagate_on_container_copy_assignment - exists and Alloc::propagate_on_container_copy_assignment::value - is true, the allocator is overwritten, if not the - copied elements are created using the existing - allocator. - - - value_type is copy constructible - - - - - unordered_multiset && - - unordered_multiset& - - The move assignment operator. - If Alloc::propagate_on_container_move_assignment - exists and Alloc::propagate_on_container_move_assignment::value - is true, the allocator is overwritten, if not the - moved elements are created using the existing - allocator. - - - - On compilers without rvalue references, this is emulated using - Boost.Move. Note that on some compilers the copy assignment - operator may be used in some circumstances. - - - - - value_type is move constructible. - - - - - - initializer_list<value_type> - - unordered_multiset& - - Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed. - - - - value_type is CopyInsertable into the container and - CopyAssignable. - - - - - allocator_type - - - - bool - - size() == 0 - - - - size_type - - std::distance(begin(), end()) - - - - size_type - size() of the largest possible container. - - - - - - iterator - const_iterator - An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - - iterator - - - const_iterator - - An iterator which refers to the past-the-end value for the container. - - - - const_iterator - A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - const_iterator - A constant iterator which refers to the past-the-end value for the container. - - - - - - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, in the container. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - - const_iterator - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - value_type const& - - iterator - - Inserts obj in the container. - - - value_type is CopyInsertable. - - - 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. - - - 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&& - - iterator - - Inserts obj in the container. - - - value_type is MoveInsertable. - - - 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. - - - 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 const& - - iterator - - Inserts obj in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is CopyInsertable. - - - 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. - - - 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. - - - - - const_iterator - - - value_type&& - - iterator - - Inserts obj in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is MoveInsertable. - - - 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. - - - 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. - - - - - - InputIterator - - - InputIterator - - void - - Inserts a range of elements into the container. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - void - - Inserts a range of elements into the container. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - node_type - - Removes the element pointed to by position. - - - A node_type owning the element. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_set, - but that is not supported yet. - - - - - - key_type const& - - node_type - - Removes an element with key equivalent to k. - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_set, - but that is not supported yet. - - - - - - - K&& - - node_type - - Removes an element with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_set, - but that is not supported yet. - - - - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted 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. - Pointers and references to elements are never invalidated. - In C++17 this can be used to insert a node extracted from a compatible unordered_set, - but that is not supported yet. - - - - - const_iterator - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - hint is a suggestion to where the element should be inserted. - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted element. - - - 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. - In C++17 this can be used to insert a node extracted from a compatible unordered_set, - but that is not supported yet. - - - - - const_iterator - - iterator - - Erase the element pointed to by position. - - - The iterator following position before the erasure. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In older versions this could be inefficient because it had to search - through several buckets to find the position of the returned iterator. - The data structure has been changed so that this is no longer the case, - and the alternative erase methods have been deprecated. - - - - - - key_type const& - - size_type - - Erase all elements with key equivalent to k. - - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - - - K&& - - size_type - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - Erase all elements with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - const_iterator - - - const_iterator - - iterator - - Erases the elements in the range from first to last. - - - The iterator following the erased elements - i.e. last. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - void - - Erases all elements in the container. - - - size() == 0 - - - Never throws an exception. - - - - - unordered_multiset& - - void - - Swaps the contents of the container with the parameter. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - unordered_multiset<Value, H2, P2, Alloc>& - - - Does not support merging with a compatible unordered_set yet. - - - - - - unordered_multiset<Value, H2, P2, Alloc>&& - - - Does not support merging with a compatible unordered_set yet. - - - - - - hasher - The container's hash function. - - - - key_equal - The container's key equality predicate. - - - - - - - - key_type const& - - iterator - - - - key_type const& - - const_iterator - - - - - K const& - - iterator - - - - - K const& - - const_iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - const_iterator - - - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - - - - The templated overloads containing CompatibleKey, - CompatibleHash and CompatiblePredicate - are non-standard extensions which allow you to use a compatible - hash function and equality predicate for a key of a different type - in order to avoid an expensive type cast. In general, its use is - not encouraged and instead the K member function - templates should be used. - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - bool - - - - - K const& - - bool - - - - A boolean indicating whether or not there is an element with key equal to key in the container - - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - size_type - - - - - K const& - - size_type - - - The number of elements with key equivalent to k. - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - std::pair<iterator, iterator> - - - - key_type const& - - std::pair<const_iterator, const_iterator> - - - - - K const& - - std::pair<iterator, iterator> - - - - - K const& - - std::pair<const_iterator, const_iterator> - - - A range containing all elements with key equivalent to k. - If the container doesn't contain any such elements, returns - std::make_pair(b.end(),b.end()). - - - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - size_type - - The number of buckets. - - - - size_type - - An upper bound on the number of buckets. - - - - - size_type - - size_type - - n < bucket_count() - - - The number of elements in bucket n. - - - - - key_type const& - - size_type - - The index of the bucket which would contain an element with key k. - - - The return value is less than bucket_count() - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - n shall be in the range [0, bucket_count()). - - - A local iterator pointing the first element in the bucket with index n. - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - 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. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the first element in the bucket with index n. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the 'one past the end' element in the bucket with index n. - - - - - - float - - The average number of elements per bucket. - - - - float - - Returns the current maximum load factor. - - - - - float - - void - - Changes the container's maximum load factor, using z as a hint. - - - - - size_type - - 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. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - size_type - - void - - Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - - - - unordered_multiset<Value, Hash, Pred, Alloc> const& - - - unordered_multiset<Value, Hash, Pred, Alloc> const& - - bool - - Return true if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - unordered_multiset<Value, Hash, Pred, Alloc> const& - - - unordered_multiset<Value, Hash, Pred, Alloc> const& - - bool - - Return false if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - - - unordered_multiset<Value, Hash, Pred, Alloc>& - - - unordered_multiset<Value, Hash, Pred, Alloc>& - - void - - x.swap(y) - - - Swaps the contents of x and y. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - - - - An object that owns a single element extracted from an - unordered_set or an - unordered_multiset, that - can then be inserted into a compatible container type. - - - The name and template parameters of this type are implementation - defined, and should be obtained using the node_type - member typedef from the appropriate container. - - - - typename Container::value_type> - - - typename Container::allocator_type> - - - - - - - node_handle_set && - - - - - node_handle_set&& - - node_handle_set& - - - value_type& - - - allocator_type - - - - - bool - - - - node_handle_set& - - void - - - In C++17 is also noexcept if ator_traits::is_always_equal::value is true. - But we don't support that trait yet. - - - - - - - - node_handle_set<ImplementationDefined>& - - - node_handle_set<ImplementationDefined>& - - void - - x.swap(y) - - - - - - -
-
- - - - - An unordered associative container that associates unique keys with another value. - - - Template Parameters - - - - - Key - Key must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - Mapped - Mapped must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - 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. - - 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 - - - std::pair<Key const, Mapped> - - - Mapped - - - Hash - - - Pred - - - Alloc - - - typename allocator_type::pointer - - - value_type* if - allocator_type::pointer is not defined. - - - - - typename allocator_type::const_pointer - - - boost::pointer_to_other<pointer, value_type>::type - if allocator_type::const_pointer is not defined. - - - - - value_type& - lvalue of value_type. - - - value_type const& - const lvalue of value_type. - - - implementation-defined - - 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. - - - - implementation-defined - - An iterator whose value type is value_type. - The iterator category is at least a forward iterator. - Convertible to const_iterator. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward 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. - - - - 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. - - - - implementation-defined - - See node_handle_map for details. - - - - implementation-defined - - Structure returned by inserting node_type. - - - - - size() == 0 - - - Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - allocator_type() - - - 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 allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - unordered_map const& - - - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - If Allocator::select_on_container_copy_construction - exists and has the right signature, the allocator will be - constructed from its result. - - - value_type is copy constructible - - - - - unordered_map && - - - The move constructor. - - - This is implemented using Boost.Move. - - - - value_type is move constructible. - - - On compilers without rvalue reference support the - emulation does not support moving without calling - boost::move if value_type is - not copyable. So, for example, you can't return the - container from a function. - - - - - - Allocator const& - - - Constructs an empty container, using allocator a. - - - - - unordered_map const& - - - Allocator const& - - - Constructs an container, copying x's contained elements, hash function, predicate, maximum load factor, but using allocator a. - - - - - unordered_map && - - - Allocator const& - - - Construct a container moving x's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a. - - - This is implemented using Boost.Move. - - - - value_type is move insertable. - - - - - - initializer_list<value_type> - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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 il into it. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default hash function and key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - hasher and key_equal need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - key_equal needs to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using a as the allocator, with the - default hash function and key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - hasher, key_equal need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - hasher const& - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - a as the allocator, with the - default key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - key_equal needs to be DefaultConstructible. - - - - - - The destructor is applied to every element, and all memory is deallocated - - - - - unordered_map const& - - unordered_map& - - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - If Alloc::propagate_on_container_copy_assignment - exists and Alloc::propagate_on_container_copy_assignment::value - is true, the allocator is overwritten, if not the - copied elements are created using the existing - allocator. - - - value_type is copy constructible - - - - - unordered_map && - - unordered_map& - - The move assignment operator. - If Alloc::propagate_on_container_move_assignment - exists and Alloc::propagate_on_container_move_assignment::value - is true, the allocator is overwritten, if not the - moved elements are created using the existing - allocator. - - - - On compilers without rvalue references, this is emulated using - Boost.Move. Note that on some compilers the copy assignment - operator may be used in some circumstances. - - - - - value_type is move constructible. - - - - - - initializer_list<value_type> - - unordered_map& - - Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed. - - - - value_type is CopyInsertable into the container and - CopyAssignable. - - - - - allocator_type - - - - bool - - size() == 0 - - - - size_type - - std::distance(begin(), end()) - - - - size_type - size() of the largest possible container. - - - - - - iterator - const_iterator - An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - - iterator - - - const_iterator - - An iterator which refers to the past-the-end value for the container. - - - - const_iterator - A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - const_iterator - A constant iterator which refers to the past-the-end value for the container. - - - - - - - - Args&& - - std::pair<iterator, bool> - - Inserts an object, constructed with the arguments args, in the container if and only if there is no element in the container with an equivalent key. - - - value_type is EmplaceConstructible into - X from args. - - - - 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 key. - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - - const_iterator - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, 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. - - - value_type is EmplaceConstructible into - X from args. - - - - If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. - - - 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. - Pointers and references to elements are never invalidated. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - value_type const& - - std::pair<iterator, bool> - - Inserts obj in the container if and only if there is no element in the container with an equivalent key. - - - value_type is CopyInsertable. - - - 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 key. - - - 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&& - - std::pair<iterator, bool> - - Inserts obj in the container if and only if there is no element in the container with an equivalent key. - - - value_type is MoveInsertable. - - - 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 key. - - - 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 - - - value_type 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. - - - value_type is CopyInsertable. - - - If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. - - - 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. - 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 key. - hint is a suggestion to where the element should be inserted. - - - value_type is MoveInsertable. - - - If an insert took place, then the iterator points to the newly inserted element. Otherwise, it points to the element with equivalent key. - - - 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. - Pointers and references to elements are never invalidated. - - - - - - InputIterator - - - InputIterator - - 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. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - node_type - - Removes the element pointed to by position. - - - A node_type owning the element. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multimap, - but that is not supported yet. - - - - - - key_type const& - - node_type - - Removes an element with key equivalent to k. - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multimap, - but that is not supported yet. - - - - - - - K&& - - node_type - - Removes an element with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_multimap, - but that is not supported yet. - - - - - - node_type&& - - insert_return_type - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent key. - - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns an insert_return_type with: - inserted equal to false, - position equal to end() and - node empty. - Otherwise if there was already an element with an equivalent key, returns an insert_return_type with: - inserted equal to false, - position pointing to a matching element and - node contains the node from nh. - Otherwise if the insertion succeeded, returns an insert_return_type with: - inserted equal to true, - position pointing to the newly inserted element and - node empty. - - - 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. - In C++17 this can be used to insert a node extracted from a compatible unordered_multimap, - but that is not supported yet. - - - - - const_iterator - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - if and only if there is no element in the container with an equivalent key. - - If there is already an element in the container with an equivalent key has no effect on nh (i.e. nh still contains the node.) - hint is a suggestion to where the element should be inserted. - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty returns end(). - If there was already an element in the container with an equivalent key returns an iterator pointing to that. - Otherwise returns an iterator pointing to the newly inserted element. - - - 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. - Pointers and references to elements are never invalidated. - In C++17 this can be used to insert a node extracted from a compatible unordered_multimap, - but that is not supported yet. - - - - - const_iterator - - iterator - - Erase the element pointed to by position. - - - The iterator following position before the erasure. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In older versions this could be inefficient because it had to search - through several buckets to find the position of the returned iterator. - The data structure has been changed so that this is no longer the case, - and the alternative erase methods have been deprecated. - - - - - - key_type const& - - size_type - - Erase all elements with key equivalent to k. - - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - - - K&& - - size_type - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - Erase all elements with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - const_iterator - - - const_iterator - - iterator - - Erases the elements in the range from first to last. - - - The iterator following the erased elements - i.e. last. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - void - - Erases all elements in the container. - - - size() == 0 - - - Never throws an exception. - - - - - unordered_map& - - void - - Swaps the contents of the container with the parameter. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - unordered_map<Key, Mapped, H2, P2, Alloc>& - - - Does not support merging with a compatible unordered_multimap yet. - - - - - - unordered_map<Key, Mapped, H2, P2, Alloc>&& - - - Does not support merging with a compatible unordered_multimap yet. - - - - - - hasher - The container's hash function. - - - - key_equal - The container's key equality predicate. - - - - - - - - key_type const& - - iterator - - - - key_type const& - - const_iterator - - - - - K const& - - iterator - - - - - K const& - - const_iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - const_iterator - - - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - - - - The templated overloads containing CompatibleKey, - CompatibleHash and CompatiblePredicate - are non-standard extensions which allow you to use a compatible - hash function and equality predicate for a key of a different type - in order to avoid an expensive type cast. In general, its use is - not encouraged and instead the K member function - templates should be used. - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - bool - - - - - K const& - - bool - - - - A boolean indicating whether or not there is an element with key equal to key in the container - - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - size_type - - - - - K const& - - size_type - - - The number of elements with key equivalent to k. - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - std::pair<iterator, iterator> - - - - key_type const& - - std::pair<const_iterator, const_iterator> - - - - - K const& - - std::pair<iterator, iterator> - - - - - K const& - - std::pair<const_iterator, const_iterator> - - - A range containing all elements with key equivalent to k. - If the container doesn't contain any such elements, returns - std::make_pair(b.end(),b.end()). - - - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - key_type const& - - 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 - - - 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. - - - - Mapped& - key_type const& - Mapped const& - key_type const& - - A reference to x.second where x is the (unique) element whose key is equivalent to k. - - - An exception object of type std::out_of_range if no such element is present. - - - - - - size_type - - The number of buckets. - - - - size_type - - An upper bound on the number of buckets. - - - - - size_type - - size_type - - n < bucket_count() - - - The number of elements in bucket n. - - - - - key_type const& - - size_type - - The index of the bucket which would contain an element with key k. - - - The return value is less than bucket_count() - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - n shall be in the range [0, bucket_count()). - - - A local iterator pointing the first element in the bucket with index n. - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - 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. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the first element in the bucket with index n. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the 'one past the end' element in the bucket with index n. - - - - - - float - - The average number of elements per bucket. - - - - float - - Returns the current maximum load factor. - - - - - float - - void - - Changes the container's maximum load factor, using z as a hint. - - - - - size_type - - 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. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - size_type - - void - - Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - - - - unordered_map<Key, Mapped, Hash, Pred, Alloc> const& - - - unordered_map<Key, Mapped, Hash, Pred, Alloc> const& - - bool - - Return true if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - unordered_map<Key, Mapped, Hash, Pred, Alloc> const& - - - unordered_map<Key, Mapped, Hash, Pred, Alloc> const& - - bool - - Return false if x.size() == - y.size and for every element in x, - there is an element in y with the same - for the same key, with an equal value (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - - - unordered_map<Key, Mapped, Hash, Pred, Alloc>& - - - unordered_map<Key, Mapped, Hash, Pred, Alloc>& - - void - - x.swap(y) - - - Swaps the contents of x and y. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - - An unordered associative container that associates keys with another value. The same key can be stored multiple times. - - - Template Parameters - - - - - Key - Key must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - Mapped - Mapped must be Erasable from the container - (i.e. allocator_traits can destroy it). - - - 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. - - 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 - - - std::pair<Key const, Mapped> - - - Mapped - - - Hash - - - Pred - - - Alloc - - - typename allocator_type::pointer - - - value_type* if - allocator_type::pointer is not defined. - - - - - typename allocator_type::const_pointer - - - boost::pointer_to_other<pointer, value_type>::type - if allocator_type::const_pointer is not defined. - - - - - value_type& - lvalue of value_type. - - - value_type const& - const lvalue of value_type. - - - implementation-defined - - 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. - - - - implementation-defined - - An iterator whose value type is value_type. - The iterator category is at least a forward iterator. - Convertible to const_iterator. - - - - implementation-defined - - A constant iterator whose value type is value_type. - The iterator category is at least a forward 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. - - - - 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. - - - - implementation-defined - - See node_handle_map for details. - - - - - size() == 0 - - - Constructs an empty container using hasher() as the hash function, key_equal() as the key equality predicate, allocator_type() as the allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - allocator_type() - - - 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 allocator and a maximum load factor of 1.0. - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - unordered_multimap const& - - - The copy constructor. Copies the contained elements, hash function, predicate, maximum load factor and allocator. - If Allocator::select_on_container_copy_construction - exists and has the right signature, the allocator will be - constructed from its result. - - - value_type is copy constructible - - - - - unordered_multimap && - - - The move constructor. - - - This is implemented using Boost.Move. - - - - value_type is move constructible. - - - On compilers without rvalue reference support the - emulation does not support moving without calling - boost::move if value_type is - not copyable. So, for example, you can't return the - container from a function. - - - - - - Allocator const& - - - Constructs an empty container, using allocator a. - - - - - unordered_multimap const& - - - Allocator const& - - - Constructs an container, copying x's contained elements, hash function, predicate, maximum load factor, but using allocator a. - - - - - unordered_multimap && - - - Allocator const& - - - Construct a container moving x's contained elements, and having the hash function, predicate and maximum load factor, but using allocate a. - - - This is implemented using Boost.Move. - - - - value_type is move insertable. - - - - - - initializer_list<value_type> - - - size_type - implementation-defined - - - hasher const& - hasher() - - - key_equal const& - key_equal() - - - allocator_type const& - 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 il into it. - - - - If the defaults are used, hasher, key_equal and - allocator_type need to be DefaultConstructible. - - - - - - size_type - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default hash function and key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - hasher and key_equal need to be DefaultConstructible. - - - - - - size_type - - - hasher const& - - - allocator_type const& - - - size() == 0 - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - the default key equality predicate, - a as the allocator and a maximum load factor of 1.0. - - - key_equal needs to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using a as the allocator, with the - default hash function and key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - hasher, key_equal need to be DefaultConstructible. - - - - - - - InputIterator - - - InputIterator - - - size_type - - - hasher const& - - - allocator_type const& - - - Constructs an empty container with at least n buckets, - using hf as the hash function, - a as the allocator, with the - default key equality predicate - and a maximum load factor of 1.0 - and inserts the elements from [f, l) into it. - - - - key_equal needs to be DefaultConstructible. - - - - - - The destructor is applied to every element, and all memory is deallocated - - - - - unordered_multimap const& - - unordered_multimap& - - The assignment operator. Copies the contained elements, hash function, predicate and maximum load factor but not the allocator. - If Alloc::propagate_on_container_copy_assignment - exists and Alloc::propagate_on_container_copy_assignment::value - is true, the allocator is overwritten, if not the - copied elements are created using the existing - allocator. - - - value_type is copy constructible - - - - - unordered_multimap && - - unordered_multimap& - - The move assignment operator. - If Alloc::propagate_on_container_move_assignment - exists and Alloc::propagate_on_container_move_assignment::value - is true, the allocator is overwritten, if not the - moved elements are created using the existing - allocator. - - - - On compilers without rvalue references, this is emulated using - Boost.Move. Note that on some compilers the copy assignment - operator may be used in some circumstances. - - - - - value_type is move constructible. - - - - - - initializer_list<value_type> - - unordered_multimap& - - Assign from values in initializer list. All existing elements are either overwritten by the new elements or destroyed. - - - - value_type is CopyInsertable into the container and - CopyAssignable. - - - - - allocator_type - - - - bool - - size() == 0 - - - - size_type - - std::distance(begin(), end()) - - - - size_type - size() of the largest possible container. - - - - - - iterator - const_iterator - An iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - - iterator - - - const_iterator - - An iterator which refers to the past-the-end value for the container. - - - - const_iterator - A constant iterator referring to the first element of the container, or if the container is empty the past-the-end value for the container. - - - - const_iterator - A constant iterator which refers to the past-the-end value for the container. - - - - - - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, in the container. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - - - 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. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - - const_iterator - - - Args&& - - iterator - - Inserts an object, constructed with the arguments args, in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is EmplaceConstructible into - X from args. - - - - 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. - - - 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. - Pointers and references to elements are never invalidated. - If the compiler doesn't support variadic template arguments or rvalue - references, this is emulated for up to 10 arguments, with no support - for rvalue references or move semantics. - Since existing std::pair implementations don't support - std::piecewise_construct this emulates it, - but using boost::unordered::piecewise_construct. - - - - - value_type const& - - iterator - - Inserts obj in the container. - - - value_type is CopyInsertable. - - - 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. - - - 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&& - - iterator - - Inserts obj in the container. - - - value_type is MoveInsertable. - - - 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. - - - 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 const& - - iterator - - Inserts obj in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is CopyInsertable. - - - 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. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - - value_type&& - - iterator - - Inserts obj in the container. - hint is a suggestion to where the element should be inserted. - - - value_type is MoveInsertable. - - - 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. - - - 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. - Pointers and references to elements are never invalidated. - - - - - - InputIterator - - - InputIterator - - void - - Inserts a range of elements into the container. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - void - - Inserts a range of elements into the container. - - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - initializer_list<value_type> - - 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. - - - value_type is EmplaceConstructible into - X from *first. - - - 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. - Pointers and references to elements are never invalidated. - - - - - const_iterator - - node_type - - Removes the element pointed to by position. - - - A node_type owning the element. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_map, - but that is not supported yet. - - - - - - key_type const& - - node_type - - Removes an element with key equivalent to k. - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_map, - but that is not supported yet. - - - - - - - K&& - - node_type - - Removes an element with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - A node_type owning the element if found, otherwise an empty node_type. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In C++17 a node extracted using this method can be inserted into a compatible unordered_map, - but that is not supported yet. - - - - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted 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. - Pointers and references to elements are never invalidated. - In C++17 this can be used to insert a node extracted from a compatible unordered_map, - but that is not supported yet. - - - - - const_iterator - - - node_type&& - - iterator - - If nh is empty, has no affect. - Otherwise inserts the element owned by nh - hint is a suggestion to where the element should be inserted. - - - nh is empty or nh.get_allocator() is equal to the container's allocator. - - - If nh was empty, returns end(). - Otherwise returns an iterator pointing to the newly inserted element. - - - 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. - Pointers and references to elements are never invalidated. - In C++17 this can be used to insert a node extracted from a compatible unordered_map, - but that is not supported yet. - - - - - const_iterator - - iterator - - Erase the element pointed to by position. - - - The iterator following position before the erasure. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - In older versions this could be inefficient because it had to search - through several buckets to find the position of the returned iterator. - The data structure has been changed so that this is no longer the case, - and the alternative erase methods have been deprecated. - - - - - - key_type const& - - size_type - - Erase all elements with key equivalent to k. - - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - - - - K&& - - size_type - - The number of elements erased. - - - Only throws an exception if it is thrown by hasher or key_equal. - - - Erase all elements with key equivalent to k. - - This overload only participates in overload resolution if Hash::is_transparent - and Pred::is_transparent are valid member typedefs and neither iterator - nor const_iterator are implicitly convertible from K. The library - assumes that Hash is callable with both K and Key and - that Pred is transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - const_iterator - - - const_iterator - - iterator - - Erases the elements in the range from first to last. - - - The iterator following the erased elements - i.e. last. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - - const_iterator - - void - - Erase the element pointed to by position. - - - Only throws an exception if it is thrown by hasher or key_equal. - In this implementation, this overload doesn't call either function object's methods so it is no throw, but this might not be true in other implementations. - - - - This method was implemented because returning an iterator to - the next element from erase was expensive, but - the container has been redesigned so that is no longer the - case. So this method is now deprecated. - - - - - void - - Erases all elements in the container. - - - size() == 0 - - - Never throws an exception. - - - - - unordered_multimap& - - void - - Swaps the contents of the container with the parameter. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - unordered_multimap<Key, Mapped, H2, P2, Alloc>& - - - Does not support merging with a compatible unordered_map yet. - - - - - - unordered_multimap<Key, Mapped, H2, P2, Alloc>&& - - - Does not support merging with a compatible unordered_map yet. - - - - - - hasher - The container's hash function. - - - - key_equal - The container's key equality predicate. - - - - - - - - key_type const& - - iterator - - - - key_type const& - - const_iterator - - - - - K const& - - iterator - - - - - K const& - - const_iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - iterator - - - - - CompatibleKey const& - - - CompatibleHash const& - - - CompatiblePredicate const& - - const_iterator - - - An iterator pointing to an element with key equivalent to k, or b.end() if no such element exists. - - - - The templated overloads containing CompatibleKey, - CompatibleHash and CompatiblePredicate - are non-standard extensions which allow you to use a compatible - hash function and equality predicate for a key of a different type - in order to avoid an expensive type cast. In general, its use is - not encouraged and instead the K member function - templates should be used. - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - bool - - - - - K const& - - bool - - - - A boolean indicating whether or not there is an element with key equal to key in the container - - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - size_type - - - - - K const& - - size_type - - - The number of elements with key equivalent to k. - - - - The template <typename K> overload only participates - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - key_type const& - - std::pair<iterator, iterator> - - - - key_type const& - - std::pair<const_iterator, const_iterator> - - - - - K const& - - std::pair<iterator, iterator> - - - - - K const& - - std::pair<const_iterator, const_iterator> - - - A range containing all elements with key equivalent to k. - If the container doesn't contain any such elements, returns - std::make_pair(b.end(),b.end()). - - - - - The template <typename K> overloads only participate - in overload resolution if Hash::is_transparent and - Pred::is_transparent are valid member typedefs. The - library assumes that Hash is callable with both - K and Key and that Pred is - transparent. This enables heterogeneous lookup which avoids the cost of - instantiating an instance of the Key type. - - - - - - - size_type - - The number of buckets. - - - - size_type - - An upper bound on the number of buckets. - - - - - size_type - - size_type - - n < bucket_count() - - - The number of elements in bucket n. - - - - - key_type const& - - size_type - - The index of the bucket which would contain an element with key k. - - - The return value is less than bucket_count() - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - n shall be in the range [0, bucket_count()). - - - A local iterator pointing the first element in the bucket with index n. - - - - - - size_type - - local_iterator - - - - size_type - - const_local_iterator - - - 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. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the first element in the bucket with index n. - - - - - size_type - - const_local_iterator - - n shall be in the range [0, bucket_count()). - - - A constant local iterator pointing the 'one past the end' element in the bucket with index n. - - - - - - float - - The average number of elements per bucket. - - - - float - - Returns the current maximum load factor. - - - - - float - - void - - Changes the container's maximum load factor, using z as a hint. - - - - - size_type - - 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. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - size_type - - void - - Invalidates iterators, and changes the order of elements. Pointers and references to elements are not invalidated. - - - The function has no effect if an exception is thrown, unless it is thrown by the container's hash function or comparison function. - - - - - - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const& - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const& - - bool - - Return true if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const& - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc> const& - - bool - - Return false if x.size() == - y.size and for every equivalent key group in - x, there is a group in y - for the same key, which is a permutation (using - operator== to compare the value types). - - - - The behavior of this function was changed to match - the C++11 standard in Boost 1.48. - Behavior is undefined if the two containers don't have - equivalent equality predicates. - - - - - - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc>& - - - unordered_multimap<Key, Mapped, Hash, Pred, Alloc>& - - void - - x.swap(y) - - - Swaps the contents of x and y. - If Allocator::propagate_on_container_swap is declared and - Allocator::propagate_on_container_swap::value is true then the - containers' allocators are swapped. Otherwise, swapping with unequal allocators - results in undefined behavior. - - - Doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of key_equal or hasher. - - - The exception specifications aren't quite the same as the C++11 standard, as - the equality predieate and hash function are swapped using their copy constructors. - - - - - - - - - - An object that owns a single element extracted from an - unordered_map or an - unordered_multimap, that - can then be inserted into a compatible container type. - - - The name and template parameters of this type are implementation - defined, and should be obtained using the node_type - member typedef from the appropriate container. - - - - typename Container::key_type - - - typename Container::mapped_type - - - typename Container::allocator_type> - - - - - - - node_handle_map && - - - - - node_handle_map&& - - node_handle_map& - - - key_type& - - - mapped_type& - - - allocator_type - - - - - bool - - - - node_handle_map& - - void - - - In C++17 is also noexcept if ator_traits::is_always_equal::value is true. - But we don't support that trait yet. - - - - - - - - node_handle_map<ImplementationDefined>& - - - node_handle_map<ImplementationDefined>& - - void - - x.swap(y) - - - - - - -
- diff --git a/doc/src_code/dictionary.cpp b/doc/src_code/dictionary.cpp deleted file mode 100644 index 4e080003..00000000 --- a/doc/src_code/dictionary.cpp +++ /dev/null @@ -1,101 +0,0 @@ - -// Copyright 2006-2007 Daniel James. -// Distributed under the Boost Software License, Version 1.0. (See accompanying -// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - -#include -#include -#include -#include "../../examples/fnv1.hpp" - -//[case_insensitive_functions - struct iequal_to - { - bool operator()(std::string const& x, - std::string const& y) const - { - return boost::algorithm::iequals(x, y, std::locale()); - } - }; - - struct ihash - { - std::size_t operator()(std::string const& x) const - { - std::size_t seed = 0; - std::locale locale; - - for(std::string::const_iterator it = x.begin(); - it != x.end(); ++it) - { - boost::hash_combine(seed, std::toupper(*it, locale)); - } - - return seed; - } - }; -//] - -int main() { -//[case_sensitive_dictionary_fnv - boost::unordered_map - dictionary; -//] - - BOOST_TEST(dictionary.empty()); - - dictionary["one"] = 1; - BOOST_TEST(dictionary.size() == 1); - BOOST_TEST(dictionary.find("ONE") == dictionary.end()); - - dictionary.insert(std::make_pair("ONE", 2)); - BOOST_TEST(dictionary.size() == 2); - BOOST_TEST(dictionary.find("ONE") != dictionary.end() && - dictionary.find("ONE")->first == "ONE" && - dictionary.find("ONE")->second == 2); - - dictionary["One"] = 3; - BOOST_TEST(dictionary.size() == 3); - BOOST_TEST(dictionary.find("One") != dictionary.end() && - dictionary.find("One")->first == "One" && - dictionary.find("One")->second == 3); - - dictionary["two"] = 4; - BOOST_TEST(dictionary.size() == 4); - BOOST_TEST(dictionary.find("Two") == dictionary.end() && - dictionary.find("two") != dictionary.end() && - dictionary.find("two")->second == 4); - - -//[case_insensitive_dictionary - boost::unordered_map - idictionary; -//] - - BOOST_TEST(idictionary.empty()); - - idictionary["one"] = 1; - BOOST_TEST(idictionary.size() == 1); - BOOST_TEST(idictionary.find("ONE") != idictionary.end() && - idictionary.find("ONE") == idictionary.find("one")); - - idictionary.insert(std::make_pair("ONE", 2)); - BOOST_TEST(idictionary.size() == 1); - BOOST_TEST(idictionary.find("ONE") != idictionary.end() && - idictionary.find("ONE")->first == "one" && - idictionary.find("ONE")->second == 1); - - idictionary["One"] = 3; - BOOST_TEST(idictionary.size() == 1); - BOOST_TEST(idictionary.find("ONE") != idictionary.end() && - idictionary.find("ONE")->first == "one" && - idictionary.find("ONE")->second == 3); - - idictionary["two"] = 4; - BOOST_TEST(idictionary.size() == 2); - BOOST_TEST(idictionary.find("two") != idictionary.end() && - idictionary.find("TWO")->first == "two" && - idictionary.find("Two")->second == 4); - - return boost::report_errors(); -} diff --git a/doc/src_code/intro.cpp b/doc/src_code/intro.cpp deleted file mode 100644 index 883d3662..00000000 --- a/doc/src_code/intro.cpp +++ /dev/null @@ -1,30 +0,0 @@ - -// Copyright 2006-2009 Daniel James. -// Distributed under the Boost Software License, Version 1.0. (See accompanying -// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - -//[intro_example1_1 -#include -#include -#include -#include -//] - -int main() { -//[intro_example1_2 - typedef boost::unordered_map map; - map x; - x["one"] = 1; - x["two"] = 2; - x["three"] = 3; - - assert(x.at("one") == 1); - assert(x.find("missing") == x.end()); -//] - -//[intro_example1_3 - BOOST_FOREACH(map::value_type i, x) { - std::cout< -#include - -//[point_example1 - struct point { - int x; - int y; - }; - - bool operator==(point const& p1, point const& p2) - { - return p1.x == p2.x && p1.y == p2.y; - } - - struct point_hash - { - std::size_t operator()(point const& p) const - { - std::size_t seed = 0; - boost::hash_combine(seed, p.x); - boost::hash_combine(seed, p.y); - return seed; - } - }; - - boost::unordered_multiset points; -//] - -int main() { - point x[] = {{1,2}, {3,4}, {1,5}, {1,2}}; - for(int i = 0; i < sizeof(x) / sizeof(point); ++i) - points.insert(x[i]); - BOOST_TEST(points.count(x[0]) == 2); - BOOST_TEST(points.count(x[1]) == 1); - point y = {10, 2}; - BOOST_TEST(points.count(y) == 0); - - return boost::report_errors(); -} diff --git a/doc/src_code/point2.cpp b/doc/src_code/point2.cpp deleted file mode 100644 index b012ca3c..00000000 --- a/doc/src_code/point2.cpp +++ /dev/null @@ -1,43 +0,0 @@ - -// Copyright 2006-2009 Daniel James. -// Distributed under the Boost Software License, Version 1.0. (See accompanying -// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - -#include -#include -#include - -//[point_example2 - struct point { - int x; - int y; - }; - - bool operator==(point const& p1, point const& p2) - { - return p1.x == p2.x && p1.y == p2.y; - } - - std::size_t hash_value(point const& p) { - std::size_t seed = 0; - boost::hash_combine(seed, p.x); - boost::hash_combine(seed, p.y); - return seed; - } - - // Now the default function objects work. - boost::unordered_multiset points; -//] - -int main() { - point x[] = {{1,2}, {3,4}, {1,5}, {1,2}}; - for(int i = 0; i < sizeof(x) / sizeof(point); ++i) - points.insert(x[i]); - BOOST_TEST(points.count(x[0]) == 2); - BOOST_TEST(points.count(x[1]) == 1); - point y = {10, 2}; - BOOST_TEST(points.count(y) == 0); - - return boost::report_errors(); -} - diff --git a/doc/unordered.qbk b/doc/unordered.qbk deleted file mode 100644 index f3f4ebe8..00000000 --- a/doc/unordered.qbk +++ /dev/null @@ -1,39 +0,0 @@ -[/ Copyright 2006-2008 Daniel James. - / Distributed under the Boost Software License, Version 1.0. (See accompanying - / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) ] - -[library Boost.Unordered - [quickbook 1.7] - [compatibility-mode 1.5] - [authors [James, Daniel]] - [copyright 2003 2004 Jeremy B. Maitin-Shepard] - [copyright 2005 2006 2007 2008 Daniel James] - [purpose std::tr1 compliant hash containers] - [id unordered] - [dirname unordered] - [license - Distributed under the Boost Software License, Version 1.0. - (See accompanying file LICENSE_1_0.txt or copy at - [@http://www.boost.org/LICENSE_1_0.txt]) - ] -] - -[template diagram[name] ''' - - - - - - -'''] - - -[include:unordered intro.qbk] -[include:unordered buckets.qbk] -[include:unordered hash_equality.qbk] -[include:unordered comparison.qbk] -[include:unordered compliance.qbk] -[include:unordered rationale.qbk] -[include:unordered changes.qbk] -[xinclude ref.xml] -[xinclude bibliography.xml]