From f125ad4b4d6aeadcec4b8f39b21d3f3e221fe967 Mon Sep 17 00:00:00 2001 From: joaquintides Date: Wed, 22 Jan 2025 14:59:21 +0100 Subject: [PATCH 1/3] added header synopses to the reference --- doc/modules/ROOT/nav.adoc | 48 +++++++--- doc/modules/ROOT/pages/changes.adoc | 4 + doc/modules/ROOT/pages/copyright.adoc | 4 +- doc/modules/ROOT/pages/ref.adoc | 48 +++++++--- .../pages/reference/concurrent_flat_map.adoc | 37 +------- .../pages/reference/concurrent_flat_set.adoc | 36 +------ .../pages/reference/concurrent_node_map.adoc | 37 +------- .../pages/reference/concurrent_node_set.adoc | 36 +------ .../ROOT/pages/reference/hash_traits.adoc | 6 +- .../reference/header_concurrent_flat_map.adoc | 58 +++++++++++ .../header_concurrent_flat_map_fwd.adoc | 7 ++ .../reference/header_concurrent_flat_set.adoc | 56 +++++++++++ .../header_concurrent_flat_set_fwd.adoc | 7 ++ .../reference/header_concurrent_node_map.adoc | 58 +++++++++++ .../header_concurrent_node_map_fwd.adoc | 7 ++ .../reference/header_concurrent_node_set.adoc | 56 +++++++++++ .../header_concurrent_node_set_fwd.adoc | 7 ++ .../reference/header_unordered_flat_map.adoc | 58 +++++++++++ .../header_unordered_flat_map_fwd.adoc | 7 ++ .../reference/header_unordered_flat_set.adoc | 56 +++++++++++ .../header_unordered_flat_set_fwd.adoc | 7 ++ .../pages/reference/header_unordered_map.adoc | 95 +++++++++++++++++++ .../reference/header_unordered_map_fwd.adoc | 7 ++ .../reference/header_unordered_map_top.adoc | 9 ++ .../reference/header_unordered_node_map.adoc | 58 +++++++++++ .../header_unordered_node_map_fwd.adoc | 7 ++ .../reference/header_unordered_node_set.adoc | 56 +++++++++++ .../header_unordered_node_set_fwd.adoc | 7 ++ .../pages/reference/header_unordered_set.adoc | 91 ++++++++++++++++++ .../reference/header_unordered_set_fwd.adoc | 7 ++ .../reference/header_unordered_set_top.adoc | 9 ++ .../pages/reference/unordered_flat_map.adoc | 37 +------- .../pages/reference/unordered_flat_set.adoc | 36 +------ .../ROOT/pages/reference/unordered_map.adoc | 37 +------- .../pages/reference/unordered_multimap.adoc | 37 +------- .../pages/reference/unordered_multiset.adoc | 38 ++------ .../pages/reference/unordered_node_map.adoc | 37 +------- .../pages/reference/unordered_node_set.adoc | 38 ++------ .../ROOT/pages/reference/unordered_set.adoc | 36 +------ 39 files changed, 870 insertions(+), 412 deletions(-) create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_flat_map.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_flat_map_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_flat_set.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_flat_set_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_node_map.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_node_map_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_node_set.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_concurrent_node_set_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_flat_map.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_flat_map_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_flat_set.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_flat_set_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_map.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_map_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_map_top.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_node_map.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_node_map_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_node_set.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_node_set_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_set.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_set_fwd.adoc create mode 100644 doc/modules/ROOT/pages/reference/header_unordered_set_top.adoc diff --git a/doc/modules/ROOT/nav.adoc b/doc/modules/ROOT/nav.adoc index 6768e1296..7143f6ab0 100644 --- a/doc/modules/ROOT/nav.adoc +++ b/doc/modules/ROOT/nav.adoc @@ -10,20 +10,42 @@ * xref:benchmarks.adoc[] * xref:rationale.adoc[] * xref:ref.adoc[] -** xref:reference/unordered_map.adoc[unordered_map] -** xref:reference/unordered_multimap.adoc[unordered_multimap] -** xref:reference/unordered_set.adoc[unordered_set] -** xref:reference/unordered_multiset.adoc[unordered_multiset] -** xref:reference/hash_traits.adoc[hash_traits] +** xref:reference/header_unordered_map_fwd.adoc[``] +** xref:reference/header_unordered_map_top.adoc[``] +** xref:reference/header_unordered_map.adoc[``] +** xref:reference/unordered_map.adoc[`unordered_map`] +** xref:reference/unordered_multimap.adoc[`unordered_multimap`] +** xref:reference/header_unordered_set_fwd.adoc[``] +** xref:reference/header_unordered_set_top.adoc[``] +** xref:reference/header_unordered_set.adoc[``] +** xref:reference/unordered_set.adoc[`unordered_set`] +** xref:reference/unordered_multiset.adoc[`unordered_multiset`] +** xref:reference/hash_traits.adoc[Hash Traits] ** xref:reference/stats.adoc[Statistics] -** xref:reference/unordered_flat_map.adoc[unordered_flat_map] -** xref:reference/unordered_flat_set.adoc[unordered_flat_set] -** xref:reference/unordered_node_map.adoc[unordered_node_map] -** xref:reference/unordered_node_set.adoc[unordered_node_set] -** xref:reference/concurrent_flat_map.adoc[concurrent_flat_map] -** xref:reference/concurrent_flat_set.adoc[concurrent_flat_set] -** xref:reference/concurrent_node_map.adoc[concurrent_node_map] -** xref:reference/concurrent_node_set.adoc[concurrent_node_set] +** xref:reference/header_unordered_flat_map_fwd.adoc[``] +** xref:reference/header_unordered_flat_map.adoc[``] +** xref:reference/unordered_flat_map.adoc[`unordered_flat_map`] +** xref:reference/header_unordered_flat_set_fwd.adoc[``] +** xref:reference/header_unordered_flat_set.adoc[``] +** xref:reference/unordered_flat_set.adoc[`unordered_flat_set`] +** xref:reference/header_unordered_node_map_fwd.adoc[``] +** xref:reference/header_unordered_node_map.adoc[``] +** xref:reference/unordered_node_map.adoc[`unordered_node_map`] +** xref:reference/header_unordered_node_set_fwd.adoc[``] +** xref:reference/header_unordered_node_set.adoc[``] +** xref:reference/unordered_node_set.adoc[`unordered_node_set`] +** xref:reference/header_concurrent_flat_map_fwd.adoc[``] +** xref:reference/header_concurrent_flat_map.adoc[``] +** xref:reference/concurrent_flat_map.adoc[`concurrent_flat_map`] +** xref:reference/header_concurrent_flat_set_fwd.adoc[``] +** xref:reference/header_concurrent_flat_set.adoc[``] +** xref:reference/concurrent_flat_set.adoc[`concurrent_flat_set`] +** xref:reference/header_concurrent_node_map_fwd.adoc[``] +** xref:reference/header_concurrent_node_map.adoc[``] +** xref:reference/concurrent_node_map.adoc[`concurrent_node_map`] +** xref:reference/header_concurrent_node_set_fwd.adoc[``] +** xref:reference/header_concurrent_node_set.adoc[``] +** xref:reference/concurrent_node_set.adoc[`concurrent_node_set`] * xref:changes.adoc[] * xref:bibliography.adoc[] * xref:copyright.adoc[] diff --git a/doc/modules/ROOT/pages/changes.adoc b/doc/modules/ROOT/pages/changes.adoc index 32a1bf648..8dc3b4330 100644 --- a/doc/modules/ROOT/pages/changes.adoc +++ b/doc/modules/ROOT/pages/changes.adoc @@ -6,6 +6,10 @@ :github-pr-url: https://github.com/boostorg/unordered/pull :cpp: C++ +== Release 1.88.0 + +* Migrated the documentation to a multipage format using Antora. + == Release 1.87.0 - Major update * Added concurrent, node-based containers `boost::concurrent_node_map` and `boost::concurrent_node_set`. diff --git a/doc/modules/ROOT/pages/copyright.adoc b/doc/modules/ROOT/pages/copyright.adoc index dd03fe7c7..43a906a46 100644 --- a/doc/modules/ROOT/pages/copyright.adoc +++ b/doc/modules/ROOT/pages/copyright.adoc @@ -9,9 +9,9 @@ Copyright (C) 2003, 2004 Jeremy B. Maitin-Shepard Copyright (C) 2005-2008 Daniel James -Copyright (C) 2022-2023 Christian Mazakas +Copyright (C) 2022-2025 Christian Mazakas -Copyright (C) 2022-2024 Joaquín M López Muñoz +Copyright (C) 2022-2025 Joaquín M López Muñoz Copyright (C) 2022-2023 Peter Dimov diff --git a/doc/modules/ROOT/pages/ref.adoc b/doc/modules/ROOT/pages/ref.adoc index 0675a2dae..ad3a8f3cf 100644 --- a/doc/modules/ROOT/pages/ref.adoc +++ b/doc/modules/ROOT/pages/ref.adoc @@ -1,17 +1,39 @@ [#reference] = Reference -* xref:reference/unordered_map.adoc[unordered_map] -* xref:reference/unordered_multimap.adoc[unordered_multimap] -* xref:reference/unordered_set.adoc[unordered_set] -* xref:reference/unordered_multiset.adoc[unordered_multiset] -* xref:reference/hash_traits.adoc[hash_traits] +* xref:reference/header_unordered_map_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_map_top.adoc[`` Synopsis] +* xref:reference/header_unordered_map.adoc[`` Synopsis] +* xref:reference/unordered_map.adoc[Class Template `unordered_map`] +* xref:reference/unordered_multimap.adoc[Class Template `unordered_multimap`] +* xref:reference/header_unordered_set_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_set_top.adoc[`` Synopsis] +* xref:reference/header_unordered_set.adoc[`` Synopsis] +* xref:reference/unordered_set.adoc[Class Template `unordered_set`] +* xref:reference/unordered_multiset.adoc[Class Template `unordered_multiset`] +* xref:reference/hash_traits.adoc[Hash Traits] * xref:reference/stats.adoc[Statistics] -* xref:reference/unordered_flat_map.adoc[unordered_flat_map] -* xref:reference/unordered_flat_set.adoc[unordered_flat_set] -* xref:reference/unordered_node_map.adoc[unordered_node_map] -* xref:reference/unordered_node_set.adoc[unordered_node_set] -* xref:reference/concurrent_flat_map.adoc[concurrent_flat_map] -* xref:reference/concurrent_flat_set.adoc[concurrent_flat_set] -* xref:reference/concurrent_node_map.adoc[concurrent_node_map] -* xref:reference/concurrent_node_set.adoc[concurrent_node_set] +* xref:reference/header_unordered_flat_map_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_flat_map.adoc[`` Synopsis] +* xref:reference/unordered_flat_map.adoc[Class Template `unordered_flat_map`] +* xref:reference/header_unordered_flat_set_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_flat_set.adoc[`` Synopsis] +* xref:reference/unordered_flat_set.adoc[Class Template `unordered_flat_set`] +* xref:reference/header_unordered_node_map_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_node_map.adoc[`` Synopsis] +* xref:reference/unordered_node_map.adoc[Class Template `unordered_node_map`] +* xref:reference/header_unordered_node_set_fwd.adoc[`` Synopsis] +* xref:reference/header_unordered_node_set.adoc[`` Synopsis] +* xref:reference/unordered_node_set.adoc[Class Template `unordered_node_set`] +* xref:reference/header_concurrent_flat_map_fwd.adoc[`` Synopsis] +* xref:reference/header_concurrent_flat_map.adoc[`` Synopsis] +* xref:reference/concurrent_flat_map.adoc[Class Template `concurrent_flat_map`] +* xref:reference/header_concurrent_flat_set_fwd.adoc[`` Synopsis] +* xref:reference/header_concurrent_flat_set.adoc[`` Synopsis] +* xref:reference/concurrent_flat_set.adoc[Class Template `concurrent_flat_set`] +* xref:reference/header_concurrent_node_map_fwd.adoc[`` Synopsis] +* xref:reference/header_concurrent_node_map.adoc[`` Synopsis] +* xref:reference/concurrent_node_map.adoc[Class Template `concurrent_node_map`] +* xref:reference/header_concurrent_node_set_fwd.adoc[`` Synopsis] +* xref:reference/header_concurrent_node_set.adoc[`` Synopsis] +* xref:reference/concurrent_node_set.adoc[Class Template `concurrent_node_set`] diff --git a/doc/modules/ROOT/pages/reference/concurrent_flat_map.adoc b/doc/modules/ROOT/pages/reference/concurrent_flat_map.adoc index 58aa7e274..c3b114aa1 100644 --- a/doc/modules/ROOT/pages/reference/concurrent_flat_map.adoc +++ b/doc/modules/ROOT/pages/reference/concurrent_flat_map.adoc @@ -22,9 +22,11 @@ The internal data structure of `boost::concurrent_flat_map` is similar to that o [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_concurrent_flat_map.adoc[``] namespace boost { +namespace unordered { + template, @@ -320,37 +322,8 @@ namespace boost { Hash, Allocator) -> concurrent_flat_map, Allocator>; - // Equality Comparisons - template - bool xref:#concurrent_flat_map_operator[operator==](const concurrent_flat_map& x, - const concurrent_flat_map& y); - - template - bool xref:#concurrent_flat_map_operator_2[operator!=](const concurrent_flat_map& x, - const concurrent_flat_map& y); - - // swap - template - void xref:#concurrent_flat_map_swap_2[swap](concurrent_flat_map& x, - concurrent_flat_map& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename concurrent_flat_map::size_type - xref:#concurrent_flat_map_erase_if_2[erase_if](concurrent_flat_map& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using concurrent_flat_map = - boost::concurrent_flat_map>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/concurrent_flat_set.adoc b/doc/modules/ROOT/pages/reference/concurrent_flat_set.adoc index d51b146d9..a6937f804 100644 --- a/doc/modules/ROOT/pages/reference/concurrent_flat_set.adoc +++ b/doc/modules/ROOT/pages/reference/concurrent_flat_set.adoc @@ -22,9 +22,11 @@ The internal data structure of `boost::concurrent_flat_set` is similar to that o [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_concurrent_flat_set.adoc[``] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -270,36 +272,8 @@ namespace boost { concurrent_flat_set(std::initializer_list, typename xref:#concurrent_flat_set_deduction_guides[__see below__]::size_type, Hash, Allocator) -> concurrent_flat_set, Allocator>; - // Equality Comparisons - template - bool xref:#concurrent_flat_set_operator[operator==](const concurrent_flat_set& x, - const concurrent_flat_set& y); - - template - bool xref:#concurrent_flat_set_operator_2[operator!=](const concurrent_flat_set& x, - const concurrent_flat_set& y); - - // swap - template - void xref:#concurrent_flat_set_swap_2[swap](concurrent_flat_set& x, - concurrent_flat_set& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename concurrent_flat_set::size_type - xref:#concurrent_flat_set_erase_if_2[erase_if](concurrent_flat_set& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using concurrent_flat_set = - boost::concurrent_flat_set>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/concurrent_node_map.adoc b/doc/modules/ROOT/pages/reference/concurrent_node_map.adoc index ad70eb15e..6ac832c80 100644 --- a/doc/modules/ROOT/pages/reference/concurrent_node_map.adoc +++ b/doc/modules/ROOT/pages/reference/concurrent_node_map.adoc @@ -22,9 +22,11 @@ node handling functionalities are provided, at the expense of potentially lower [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_concurrent_node_map.adoc[``] namespace boost { +namespace unordered { + template, @@ -338,37 +340,8 @@ namespace boost { Hash, Allocator) -> concurrent_node_map, Allocator>; - // Equality Comparisons - template - bool xref:#concurrent_node_map_operator[operator==](const concurrent_node_map& x, - const concurrent_node_map& y); - - template - bool xref:#concurrent_node_map_operator_2[operator!=](const concurrent_node_map& x, - const concurrent_node_map& y); - - // swap - template - void xref:#concurrent_node_map_swap_2[swap](concurrent_node_map& x, - concurrent_node_map& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename concurrent_node_map::size_type - xref:#concurrent_node_map_erase_if_2[erase_if](concurrent_node_map& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using concurrent_node_map = - boost::concurrent_node_map>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/concurrent_node_set.adoc b/doc/modules/ROOT/pages/reference/concurrent_node_set.adoc index 5c62374c1..12ecf6028 100644 --- a/doc/modules/ROOT/pages/reference/concurrent_node_set.adoc +++ b/doc/modules/ROOT/pages/reference/concurrent_node_set.adoc @@ -22,9 +22,11 @@ node handling functionalities are provided, at the expense of potentially lower [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_concurrent_node_set.adoc[``] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -287,36 +289,8 @@ namespace boost { concurrent_node_set(std::initializer_list, typename xref:#concurrent_node_set_deduction_guides[__see below__]::size_type, Hash, Allocator) -> concurrent_node_set, Allocator>; - // Equality Comparisons - template - bool xref:#concurrent_node_set_operator[operator==](const concurrent_node_set& x, - const concurrent_node_set& y); - - template - bool xref:#concurrent_node_set_operator_2[operator!=](const concurrent_node_set& x, - const concurrent_node_set& y); - - // swap - template - void xref:#concurrent_node_set_swap_2[swap](concurrent_node_set& x, - concurrent_node_set& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename concurrent_node_set::size_type - xref:#concurrent_node_set_erase_if_2[erase_if](concurrent_node_set& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using concurrent_node_set = - boost::concurrent_node_set>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/hash_traits.adoc b/doc/modules/ROOT/pages/reference/hash_traits.adoc index 5a60fa829..a311153c9 100644 --- a/doc/modules/ROOT/pages/reference/hash_traits.adoc +++ b/doc/modules/ROOT/pages/reference/hash_traits.adoc @@ -1,14 +1,12 @@ [#hash_traits] -== Hash traits +== Hash Traits :idprefix: hash_traits_ -=== Synopsis +=== `` Synopsis [listing,subs="+macros,+quotes"] ----- -// #include - namespace boost { namespace unordered { diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_flat_map.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_flat_map.adoc new file mode 100644 index 000000000..b7412866c --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_flat_map.adoc @@ -0,0 +1,58 @@ +[#header_concurrent_flat_map] +== `` Synopsis + +:idprefix: header_concurrent_flat_map_ + +Defines `xref:reference/concurrent_flat_map.adoc#concurrent_flat_map[boost::concurrent_flat_map]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/concurrent_flat_map.adoc#concurrent_flat_map[concurrent_flat_map]; + + // Equality Comparisons + template + bool xref:reference/concurrent_flat_map.adoc#concurrent_flat_map_operator[operator++==++](const concurrent_flat_map& x, + const concurrent_flat_map& y); + + template + bool xref:reference/concurrent_flat_map.adoc#concurrent_flat_map_operator_2[operator!=](const concurrent_flat_map& x, + const concurrent_flat_map& y); + + // swap + template + void xref:reference/concurrent_flat_map.adoc#concurrent_flat_map_swap_2[swap](concurrent_flat_map& x, + concurrent_flat_map& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename concurrent_flat_map::size_type + xref:reference/concurrent_flat_map.adoc#concurrent_flat_map_erase_if[erase_if](concurrent_flat_map& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using concurrent_flat_map = + boost::unordered::concurrent_flat_map>>; + } // namespace pmr + +} // namespace unordered + +using unordered::concurrent_flat_map; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_flat_map_fwd.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_flat_map_fwd.adoc new file mode 100644 index 000000000..474b0884e --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_flat_map_fwd.adoc @@ -0,0 +1,7 @@ +[#header_concurrent_flat_map_fwd] +== `` Synopsis + +:idprefix: header_concurrent_flat_map_fwd_ + +Forward declares all the definitions in +xref:reference/header_concurrent_flat_map.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_flat_set.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_flat_set.adoc new file mode 100644 index 000000000..775d847ff --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_flat_set.adoc @@ -0,0 +1,56 @@ +[#header_concurrent_flat_set] +== `` Synopsis + +:idprefix: header_concurrent_flat_set_ + +Defines `xref:reference/concurrent_flat_set.adoc#concurrent_flat_set[boost::concurrent_flat_set]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/concurrent_flat_set.adoc#concurrent_flat_set[concurrent_flat_set]; + + // Equality Comparisons + template + bool xref:reference/concurrent_flat_set.adoc#concurrent_flat_set_operator[operator++==++](const concurrent_flat_set& x, + const concurrent_flat_set& y); + + template + bool xref:reference/concurrent_flat_set.adoc#concurrent_flat_set_operator_2[operator!=](const concurrent_flat_set& x, + const concurrent_flat_set& y); + + // swap + template + void xref:reference/concurrent_flat_set.adoc#concurrent_flat_set_swap_2[swap](concurrent_flat_set& x, + concurrent_flat_set& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename concurrent_flat_set::size_type + xref:reference/concurrent_flat_set.adoc#concurrent_flat_set_erase_if[erase_if](concurrent_flat_set& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using concurrent_flat_set = + boost::unordered::concurrent_flat_set>; + } // namespace pmr + +} // namespace unordered + +using unordered::concurrent_flat_set; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_flat_set_fwd.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_flat_set_fwd.adoc new file mode 100644 index 000000000..a4767c50b --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_flat_set_fwd.adoc @@ -0,0 +1,7 @@ +[#header_concurrent_flat_set_fwd] +== `` Synopsis + +:idprefix: header_concurrent_flat_set_fwd_ + +Forward declares all the definitions in +xref:reference/header_concurrent_flat_set.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_node_map.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_node_map.adoc new file mode 100644 index 000000000..aecf3cbc4 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_node_map.adoc @@ -0,0 +1,58 @@ +[#header_concurrent_node_map] +== `` Synopsis + +:idprefix: header_concurrent_node_map_ + +Defines `xref:reference/concurrent_node_map.adoc#concurrent_node_map[boost::concurrent_node_map]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/concurrent_node_map.adoc#concurrent_node_map[concurrent_node_map]; + + // Equality Comparisons + template + bool xref:reference/concurrent_node_map.adoc#concurrent_node_map_operator[operator++==++](const concurrent_node_map& x, + const concurrent_node_map& y); + + template + bool xref:reference/concurrent_node_map.adoc#concurrent_node_map_operator_2[operator!=](const concurrent_node_map& x, + const concurrent_node_map& y); + + // swap + template + void xref:reference/concurrent_node_map.adoc#concurrent_node_map_swap_2[swap](concurrent_node_map& x, + concurrent_node_map& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename concurrent_node_map::size_type + xref:reference/concurrent_node_map.adoc#concurrent_node_map_erase_if[erase_if](concurrent_node_map& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using concurrent_node_map = + boost::unordered::concurrent_node_map>>; + } // namespace pmr + +} // namespace unordered + +using unordered::concurrent_node_map; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_node_map_fwd.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_node_map_fwd.adoc new file mode 100644 index 000000000..a0d8c9361 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_node_map_fwd.adoc @@ -0,0 +1,7 @@ +[#header_concurrent_node_map_fwd] +== `` Synopsis + +:idprefix: header_concurrent_node_map_fwd_ + +Forward declares all the definitions in +xref:reference/header_concurrent_node_map.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_node_set.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_node_set.adoc new file mode 100644 index 000000000..d8b2533c9 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_node_set.adoc @@ -0,0 +1,56 @@ +[#header_concurrent_node_set] +== `` Synopsis + +:idprefix: header_concurrent_node_set_ + +Defines `xref:reference/concurrent_node_set.adoc#concurrent_node_set[boost::concurrent_node_set]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/concurrent_node_set.adoc#concurrent_node_set[concurrent_node_set]; + + // Equality Comparisons + template + bool xref:reference/concurrent_node_set.adoc#concurrent_node_set_operator[operator++==++](const concurrent_node_set& x, + const concurrent_node_set& y); + + template + bool xref:reference/concurrent_node_set.adoc#concurrent_node_set_operator_2[operator!=](const concurrent_node_set& x, + const concurrent_node_set& y); + + // swap + template + void xref:reference/concurrent_node_set.adoc#concurrent_node_set_swap_2[swap](concurrent_node_set& x, + concurrent_node_set& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename concurrent_node_set::size_type + xref:reference/concurrent_node_set.adoc#concurrent_node_set_erase_if[erase_if](concurrent_node_set& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using concurrent_node_set = + boost::unordered::concurrent_node_set>; + } // namespace pmr + +} // namespace unordered + +using unordered::concurrent_node_set; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_concurrent_node_set_fwd.adoc b/doc/modules/ROOT/pages/reference/header_concurrent_node_set_fwd.adoc new file mode 100644 index 000000000..70b76de15 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_concurrent_node_set_fwd.adoc @@ -0,0 +1,7 @@ +[#header_concurrent_node_set_fwd] +== `` Synopsis + +:idprefix: header_concurrent_node_set_fwd_ + +Forward declares all the definitions in +xref:reference/header_concurrent_node_set.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_flat_map.adoc b/doc/modules/ROOT/pages/reference/header_unordered_flat_map.adoc new file mode 100644 index 000000000..f3623f3fb --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_flat_map.adoc @@ -0,0 +1,58 @@ +[#header_unordered_flat_map] +== `` Synopsis + +:idprefix: header_unordered_flat_map_ + +Defines `xref:reference/unordered_flat_map.adoc#unordered_flat_map[boost::unordered_flat_map]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/unordered_flat_map.adoc#unordered_flat_map[unordered_flat_map]; + + // Equality Comparisons + template + bool xref:reference/unordered_flat_map.adoc#unordered_flat_map_operator_2[operator++==++](const unordered_flat_map& x, + const unordered_flat_map& y); + + template + bool xref:reference/unordered_flat_map.adoc#unordered_flat_map_operator_3[operator!=](const unordered_flat_map& x, + const unordered_flat_map& y); + + // swap + template + void xref:reference/unordered_flat_map.adoc#unordered_flat_map_swap_2[swap](unordered_flat_map& x, + unordered_flat_map& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_flat_map::size_type + xref:reference/unordered_flat_map.adoc#unordered_flat_map_erase_if[erase_if](unordered_flat_map& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_flat_map = + boost::unordered::unordered_flat_map>>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_flat_map; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_flat_map_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_flat_map_fwd.adoc new file mode 100644 index 000000000..5c7fde732 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_flat_map_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_flat_map_fwd] +== `` Synopsis + +:idprefix: header_unordered_flat_map_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_flat_map.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_flat_set.adoc b/doc/modules/ROOT/pages/reference/header_unordered_flat_set.adoc new file mode 100644 index 000000000..ac12a782d --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_flat_set.adoc @@ -0,0 +1,56 @@ +[#header_unordered_flat_set] +== `` Synopsis + +:idprefix: header_unordered_flat_set_ + +Defines `xref:reference/unordered_flat_set.adoc#unordered_flat_set[boost::unordered_flat_set]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/unordered_flat_set.adoc#unordered_flat_set[unordered_flat_set]; + + // Equality Comparisons + template + bool xref:reference/unordered_flat_set.adoc#unordered_flat_set_operator[operator++==++](const unordered_flat_set& x, + const unordered_flat_set& y); + + template + bool xref:reference/unordered_flat_set.adoc#unordered_flat_set_operator_2[operator!=](const unordered_flat_set& x, + const unordered_flat_set& y); + + // swap + template + void xref:reference/unordered_flat_set.adoc#unordered_flat_set_swap_2[swap](unordered_flat_set& x, + unordered_flat_set& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_flat_set::size_type + xref:reference/unordered_flat_set.adoc#unordered_flat_set_erase_if[erase_if](unordered_flat_set& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_flat_set = + boost::unordered::unordered_flat_set>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_flat_set; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_flat_set_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_flat_set_fwd.adoc new file mode 100644 index 000000000..306b04cbd --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_flat_set_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_flat_set_fwd] +== `` Synopsis + +:idprefix: header_unordered_flat_set_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_flat_set.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_map.adoc b/doc/modules/ROOT/pages/reference/header_unordered_map.adoc new file mode 100644 index 000000000..be2bfafc5 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_map.adoc @@ -0,0 +1,95 @@ +[#header_unordered_map] +== `` Synopsis + +:idprefix: header_unordered_map_ + +Defines `xref:reference/unordered_map.adoc#unordered_map[boost::unordered_map]`, +`xref:reference/unordered_multimap.adoc#unordered_multimap[boost::unordered_multimap]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/unordered_map.adoc#unordered_map[unordered_map]; + + // Equality Comparisons + template + bool xref:reference/unordered_map.adoc#unordered_map_operator_2[operator++==++](const unordered_map& x, + const unordered_map& y); + + template + bool xref:reference/unordered_map.adoc#unordered_map_operator_3[operator!=](const unordered_map& x, + const unordered_map& y); + + // swap + template + void xref:reference/unordered_map.adoc#unordered_map_swap_2[swap](unordered_map& x, + unordered_map& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_map::size_type + xref:reference/unordered_map.adoc#unordered_map_erase_if[erase_if](unordered_map& c, Predicate pred); + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/unordered_multimap.adoc#unordered_multimap[unordered_multimap]; + + // Equality Comparisons + template + bool xref:reference/unordered_multimap.adoc#unordered_multimap_operator[operator++==++](const unordered_multimap& x, + const unordered_multimap& y); + + template + bool xref:reference/unordered_multimap.adoc#unordered_multimap_operator_2[operator!=](const unordered_multimap& x, + const unordered_multimap& y); + + // swap + template + void xref:reference/unordered_multimap.adoc#unordered_multimap_swap_2[swap](unordered_multimap& x, + unordered_multimap& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_multimap::size_type + xref:reference/unordered_multimap.adoc#unordered_multimap_erase_if[erase_if](unordered_multimap& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_map = + boost::unordered::unordered_map>>; + + template, + class Pred = std::equal_to> + using unordered_multimap = + boost::unordered::unordered_multimap>>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_map; +using unordered::unordered_multimap; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_map_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_map_fwd.adoc new file mode 100644 index 000000000..53b8bd748 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_map_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_map_fwd] +== `` Synopsis + +:idprefix: header_unordered_map_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_map.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_map_top.adoc b/doc/modules/ROOT/pages/reference/header_unordered_map_top.adoc new file mode 100644 index 000000000..129b0fc69 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_map_top.adoc @@ -0,0 +1,9 @@ +[#header_unordered_map_fwd_top] +== `` Synopsis + +:idprefix: header_unordered_map_top_ + +[listing,subs="+macros,+quotes"] +----- +#include xref:reference/header_unordered_map.adoc[] +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_node_map.adoc b/doc/modules/ROOT/pages/reference/header_unordered_node_map.adoc new file mode 100644 index 000000000..187a7019b --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_node_map.adoc @@ -0,0 +1,58 @@ +[#header_unordered_node_map] +== `` Synopsis + +:idprefix: header_unordered_node_map_ + +Defines `xref:reference/unordered_node_map.adoc#unordered_node_map[boost::unordered_node_map]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator>> + class xref:reference/unordered_node_map.adoc#unordered_node_map[unordered_node_map]; + + // Equality Comparisons + template + bool xref:reference/unordered_node_map.adoc#unordered_node_map_operator_2[operator++==++](const unordered_node_map& x, + const unordered_node_map& y); + + template + bool xref:reference/unordered_node_map.adoc#unordered_node_map_operator_3[operator!=](const unordered_node_map& x, + const unordered_node_map& y); + + // swap + template + void xref:reference/unordered_node_map.adoc#unordered_node_map_swap_2[swap](unordered_node_map& x, + unordered_node_map& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_node_map::size_type + xref:reference/unordered_node_map.adoc#unordered_node_map_erase_if[erase_if](unordered_node_map& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_node_map = + boost::unordered::unordered_node_map>>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_node_map; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_node_map_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_node_map_fwd.adoc new file mode 100644 index 000000000..7467a8bf4 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_node_map_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_node_map_fwd] +== `` Synopsis + +:idprefix: header_unordered_node_map_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_node_map.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_node_set.adoc b/doc/modules/ROOT/pages/reference/header_unordered_node_set.adoc new file mode 100644 index 000000000..099083296 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_node_set.adoc @@ -0,0 +1,56 @@ +[#header_unordered_node_set] +== `` Synopsis + +:idprefix: header_unordered_node_set_ + +Defines `xref:reference/unordered_node_set.adoc#unordered_node_set[boost::unordered_node_set]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/unordered_node_set.adoc#unordered_node_set[unordered_node_set]; + + // Equality Comparisons + template + bool xref:reference/unordered_node_set.adoc#unordered_node_set_operator[operator++==++](const unordered_node_set& x, + const unordered_node_set& y); + + template + bool xref:reference/unordered_node_set.adoc#unordered_node_set_operator_2[operator!=](const unordered_node_set& x, + const unordered_node_set& y); + + // swap + template + void xref:reference/unordered_node_set.adoc#unordered_node_set_swap_2[swap](unordered_node_set& x, + unordered_node_set& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_node_set::size_type + xref:reference/unordered_node_set.adoc#unordered_node_set_erase_if[erase_if](unordered_node_set& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_node_set = + boost::unordered::unordered_node_set>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_node_set; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_node_set_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_node_set_fwd.adoc new file mode 100644 index 000000000..502dd8a23 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_node_set_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_node_set_fwd] +== `` Synopsis + +:idprefix: header_unordered_node_set_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_node_set.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_set.adoc b/doc/modules/ROOT/pages/reference/header_unordered_set.adoc new file mode 100644 index 000000000..b61dd5a6d --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_set.adoc @@ -0,0 +1,91 @@ +[#header_unordered_set] +== `` Synopsis + +:idprefix: header_unordered_set_ + +Defines `xref:reference/unordered_set.adoc#unordered_set[boost::unordered_set]`, +`xref:reference/unordered_multiset.adoc#unordered_multiset[boost::unordered_multiset]` +and associated functions and alias templates. + +[listing,subs="+macros,+quotes"] +----- + +namespace boost { +namespace unordered { + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/unordered_set.adoc#unordered_set[unordered_set]; + + // Equality Comparisons + template + bool xref:reference/unordered_set.adoc#unordered_set_operator[operator++==++](const unordered_set& x, + const unordered_set& y); + + template + bool xref:reference/unordered_set.adoc#unordered_set_operator_2[operator!=](const unordered_set& x, + const unordered_set& y); + + // swap + template + void xref:reference/unordered_set.adoc#unordered_set_swap_2[swap](unordered_set& x, + unordered_set& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_set::size_type + xref:reference/unordered_set.adoc#unordered_set_erase_if[erase_if](unordered_set& c, Predicate pred); + + template, + class Pred = std::equal_to, + class Allocator = std::allocator> + class xref:reference/unordered_multiset.adoc#unordered_multiset[unordered_multiset]; + + // Equality Comparisons + template + bool xref:reference/unordered_multiset.adoc#unordered_multiset_operator[operator++==++](const unordered_multiset& x, + const unordered_multiset& y); + + template + bool xref:reference/unordered_multiset.adoc#unordered_multiset_operator_2[operator!=](const unordered_multiset& x, + const unordered_multiset& y); + + // swap + template + void xref:reference/unordered_multiset.adoc#unordered_multiset_swap_2[swap](unordered_multiset& x, + unordered_multiset& y) + noexcept(noexcept(x.swap(y))); + + // Erasure + template + typename unordered_multiset::size_type + xref:reference/unordered_multiset.adoc#unordered_multiset_erase_if[erase_if](unordered_multiset& c, Predicate pred); + + // Pmr aliases (C++17 and up) + namespace pmr { + template, + class Pred = std::equal_to> + using unordered_set = + boost::unordered::unordered_set>; + + template, + class Pred = std::equal_to> + using unordered_multiset = + boost::unordered::unordered_multiset>; + } // namespace pmr + +} // namespace unordered + +using unordered::unordered_set; +using unordered::unordered_multiset; + +} // namespace boost +----- diff --git a/doc/modules/ROOT/pages/reference/header_unordered_set_fwd.adoc b/doc/modules/ROOT/pages/reference/header_unordered_set_fwd.adoc new file mode 100644 index 000000000..3bc3c7394 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_set_fwd.adoc @@ -0,0 +1,7 @@ +[#header_unordered_set_fwd] +== `` Synopsis + +:idprefix: header_unordered_set_fwd_ + +Forward declares all the definitions in +xref:reference/header_unordered_set.adoc[``]. diff --git a/doc/modules/ROOT/pages/reference/header_unordered_set_top.adoc b/doc/modules/ROOT/pages/reference/header_unordered_set_top.adoc new file mode 100644 index 000000000..78728a4f2 --- /dev/null +++ b/doc/modules/ROOT/pages/reference/header_unordered_set_top.adoc @@ -0,0 +1,9 @@ +[#header_unordered_set_fwd_top] +== `` Synopsis + +:idprefix: header_unordered_set_top_ + +[listing,subs="+macros,+quotes"] +----- +#include xref:reference/header_unordered_set.adoc[] +----- diff --git a/doc/modules/ROOT/pages/reference/unordered_flat_map.adoc b/doc/modules/ROOT/pages/reference/unordered_flat_map.adoc index 99e8746f8..f8db071bb 100644 --- a/doc/modules/ROOT/pages/reference/unordered_flat_map.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_flat_map.adoc @@ -27,9 +27,11 @@ unordered associative containers. [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_flat_map.adoc[``] namespace boost { +namespace unordered { + template, @@ -272,37 +274,8 @@ namespace boost { Hash, Allocator) -> unordered_flat_map, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_flat_map_operator_2[operator==](const unordered_flat_map& x, - const unordered_flat_map& y); - - template - bool xref:#unordered_flat_map_operator_3[operator!=](const unordered_flat_map& x, - const unordered_flat_map& y); - - // swap - template - void xref:#unordered_flat_map_swap_2[swap](unordered_flat_map& x, - unordered_flat_map& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_flat_map::size_type - xref:#unordered_flat_map_erase_if[erase_if](unordered_flat_map& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_flat_map = - boost::unordered_flat_map>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_flat_set.adoc b/doc/modules/ROOT/pages/reference/unordered_flat_set.adoc index b4a1ec35f..784da4627 100644 --- a/doc/modules/ROOT/pages/reference/unordered_flat_set.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_flat_set.adoc @@ -27,9 +27,11 @@ unordered associative containers. [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_flat_set.adoc[``] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -225,36 +227,8 @@ namespace boost { unordered_flat_set(std::initializer_list, typename xref:#unordered_flat_set_deduction_guides[__see below__]::size_type, Hash, Allocator) -> unordered_flat_set, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_flat_set_operator_2[operator==](const unordered_flat_set& x, - const unordered_flat_set& y); - - template - bool xref:#unordered_flat_set_operator_3[operator!=](const unordered_flat_set& x, - const unordered_flat_set& y); - - // swap - template - void xref:#unordered_flat_set_swap_2[swap](unordered_flat_set& x, - unordered_flat_set& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_flat_set::size_type - xref:#unordered_flat_set_erase_if[erase_if](unordered_flat_set& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_flat_set = - boost::unordered_flat_set>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_map.adoc b/doc/modules/ROOT/pages/reference/unordered_map.adoc index b165eb4a1..f8c67777a 100644 --- a/doc/modules/ROOT/pages/reference/unordered_map.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_map.adoc @@ -9,9 +9,11 @@ [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_map.adoc[] namespace boost { +namespace unordered { + template, @@ -271,37 +273,8 @@ namespace boost { Allocator) -> unordered_map, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_map_operator_2[operator==](const unordered_map& x, - const unordered_map& y); - - template - bool xref:#unordered_map_operator_3[operator!=](const unordered_map& x, - const unordered_map& y); - - // swap - template - void xref:#unordered_map_swap_2[swap](unordered_map& x, - unordered_map& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_map::size_type - xref:#unordered_map_erase_if[erase_if](unordered_map& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_map = - boost::unordered_map>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_multimap.adoc b/doc/modules/ROOT/pages/reference/unordered_multimap.adoc index 81af13e5c..a01cc99fb 100644 --- a/doc/modules/ROOT/pages/reference/unordered_multimap.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_multimap.adoc @@ -9,9 +9,11 @@ [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_map.adoc[] namespace boost { +namespace unordered { + template, @@ -238,37 +240,8 @@ namespace boost { Hash, Allocator) -> unordered_multimap, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_multimap_operator[operator++==++](const unordered_multimap& x, - const unordered_multimap& y); - - template - bool xref:#unordered_multimap_operator_2[operator!=](const unordered_multimap& x, - const unordered_multimap& y); - - // swap - template - void xref:#unordered_multimap_swap_2[swap](unordered_multimap& x, - unordered_multimap& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_multimap::size_type - xref:#unordered_multimap_erase_if[erase_if](unordered_multimap& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_multimap = - boost::unordered_multimap>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_multiset.adoc b/doc/modules/ROOT/pages/reference/unordered_multiset.adoc index 510d4fdf5..9effb34a1 100644 --- a/doc/modules/ROOT/pages/reference/unordered_multiset.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_multiset.adoc @@ -9,9 +9,11 @@ [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_set.adoc[] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -228,37 +230,9 @@ namespace boost { template unordered_multiset(std::initializer_list, typename xref:#unordered_multiset_deduction_guides[__see below__]::size_type, Hash, Allocator) -> unordered_multiset, Allocator>; - - // Equality Comparisons - template - bool xref:#unordered_multiset_operator[operator++==++](const unordered_multiset& x, - const unordered_multiset& y); - - template - bool xref:#unordered_multiset_operator_2[operator!=](const unordered_multiset& x, - const unordered_multiset& y); - - // swap - template - void xref:#unordered_multiset_swap_2[swap](unordered_multiset& x, - unordered_multiset& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_multiset::size_type - xref:#unordered_multiset_erase_if[erase_if](unordered_multiset& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_multiset = - boost::unordered_multiset>; - } -} + +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_node_map.adoc b/doc/modules/ROOT/pages/reference/unordered_node_map.adoc index 7ed35b2c5..1bec0b91d 100644 --- a/doc/modules/ROOT/pages/reference/unordered_node_map.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_node_map.adoc @@ -23,9 +23,11 @@ unordered associative containers. [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_node_map.adoc[``] namespace boost { +namespace unordered { + template, @@ -276,37 +278,8 @@ namespace boost { Hash, Allocator) -> unordered_node_map, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_node_map_operator_2[operator==](const unordered_node_map& x, - const unordered_node_map& y); - - template - bool xref:#unordered_node_map_operator_3[operator!=](const unordered_node_map& x, - const unordered_node_map& y); - - // swap - template - void xref:#unordered_node_map_swap_2[swap](unordered_node_map& x, - unordered_node_map& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_node_map::size_type - xref:#unordered_node_map_erase_if[erase_if](unordered_node_map& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_node_map = - boost::unordered_node_map>>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_node_set.adoc b/doc/modules/ROOT/pages/reference/unordered_node_set.adoc index e5e33120f..1229120fb 100644 --- a/doc/modules/ROOT/pages/reference/unordered_node_set.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_node_set.adoc @@ -17,15 +17,17 @@ a number of aspects from that of `boost::unordered_set`/`std::unordered_set`: - The maximum load factor of the container is managed internally and can't be set by the user. Other than this, `boost::unordered_node_set` is mostly a drop-in replacement of standard -unordered associative containers. +unordered associative containers. === Synopsis [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_node_set.adoc[``] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -230,36 +232,8 @@ namespace boost { unordered_node_set(std::initializer_list, typename xref:#unordered_node_set_deduction_guides[__see below__]::size_type, Hash, Allocator) -> unordered_node_set, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_node_set_operator_2[operator==](const unordered_node_set& x, - const unordered_node_set& y); - - template - bool xref:#unordered_node_set_operator_3[operator!=](const unordered_node_set& x, - const unordered_node_set& y); - - // swap - template - void xref:#unordered_node_set_swap_2[swap](unordered_node_set& x, - unordered_node_set& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_node_set::size_type - xref:#unordered_node_set_erase_if[erase_if](unordered_node_set& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_node_set = - boost::unordered_node_set>; - } -} +} // namespace unordered +} // namespace boost ----- --- diff --git a/doc/modules/ROOT/pages/reference/unordered_set.adoc b/doc/modules/ROOT/pages/reference/unordered_set.adoc index 2a3f52178..a32855766 100644 --- a/doc/modules/ROOT/pages/reference/unordered_set.adoc +++ b/doc/modules/ROOT/pages/reference/unordered_set.adoc @@ -9,9 +9,11 @@ [listing,subs="+macros,+quotes"] ----- -// #include +// #include xref:reference/header_unordered_set.adoc[] namespace boost { +namespace unordered { + template, class Pred = std::equal_to, @@ -230,36 +232,8 @@ namespace boost { unordered_set(std::initializer_list, typename xref:#unordered_set_deduction_guides[__see below__]::size_type, Hash, Allocator) -> unordered_set, Allocator>; - // Equality Comparisons - template - bool xref:#unordered_set_operator[operator++==++](const unordered_set& x, - const unordered_set& y); - - template - bool xref:#unordered_set_operator_2[operator!=](const unordered_set& x, - const unordered_set& y); - - // swap - template - void xref:#unordered_set_swap_2[swap](unordered_set& x, - unordered_set& y) - noexcept(noexcept(x.swap(y))); - - // Erasure - template - typename unordered_set::size_type - xref:#unordered_set_erase_if[erase_if](unordered_set& c, Predicate pred); - - // Pmr aliases (C++17 and up) - namespace unordered::pmr { - template, - class Pred = std::equal_to> - using unordered_set = - boost::unordered_set>; - } -} +} // namespace unordered +} // namespace boost ----- --- From 191adf4a3028b88010e9c4e735380fc79bddaffe Mon Sep 17 00:00:00 2001 From: joaquintides Date: Thu, 23 Jan 2025 09:23:44 +0100 Subject: [PATCH 2/3] disabled font color override for in-link code portions --- doc/modules/ROOT/pages/ref.adoc | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/modules/ROOT/pages/ref.adoc b/doc/modules/ROOT/pages/ref.adoc index ad3a8f3cf..36976a22b 100644 --- a/doc/modules/ROOT/pages/ref.adoc +++ b/doc/modules/ROOT/pages/ref.adoc @@ -1,39 +1,39 @@ [#reference] = Reference -* xref:reference/header_unordered_map_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_map_top.adoc[`` Synopsis] -* xref:reference/header_unordered_map.adoc[`` Synopsis] -* xref:reference/unordered_map.adoc[Class Template `unordered_map`] -* xref:reference/unordered_multimap.adoc[Class Template `unordered_multimap`] -* xref:reference/header_unordered_set_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_set_top.adoc[`` Synopsis] -* xref:reference/header_unordered_set.adoc[`` Synopsis] -* xref:reference/unordered_set.adoc[Class Template `unordered_set`] -* xref:reference/unordered_multiset.adoc[Class Template `unordered_multiset`] +* xref:reference/header_unordered_map_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_map_top.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_map.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_map.adoc[Class Template ++++++unordered_map++++++] +* xref:reference/unordered_multimap.adoc[Class Template ++++++unordered_multimap++++++] +* xref:reference/header_unordered_set_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_set_top.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_set.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_set.adoc[Class Template ++++++unordered_set++++++] +* xref:reference/unordered_multiset.adoc[Class Template ++++++unordered_multiset++++++] * xref:reference/hash_traits.adoc[Hash Traits] * xref:reference/stats.adoc[Statistics] -* xref:reference/header_unordered_flat_map_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_flat_map.adoc[`` Synopsis] -* xref:reference/unordered_flat_map.adoc[Class Template `unordered_flat_map`] -* xref:reference/header_unordered_flat_set_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_flat_set.adoc[`` Synopsis] -* xref:reference/unordered_flat_set.adoc[Class Template `unordered_flat_set`] -* xref:reference/header_unordered_node_map_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_node_map.adoc[`` Synopsis] -* xref:reference/unordered_node_map.adoc[Class Template `unordered_node_map`] -* xref:reference/header_unordered_node_set_fwd.adoc[`` Synopsis] -* xref:reference/header_unordered_node_set.adoc[`` Synopsis] -* xref:reference/unordered_node_set.adoc[Class Template `unordered_node_set`] -* xref:reference/header_concurrent_flat_map_fwd.adoc[`` Synopsis] -* xref:reference/header_concurrent_flat_map.adoc[`` Synopsis] -* xref:reference/concurrent_flat_map.adoc[Class Template `concurrent_flat_map`] -* xref:reference/header_concurrent_flat_set_fwd.adoc[`` Synopsis] -* xref:reference/header_concurrent_flat_set.adoc[`` Synopsis] -* xref:reference/concurrent_flat_set.adoc[Class Template `concurrent_flat_set`] -* xref:reference/header_concurrent_node_map_fwd.adoc[`` Synopsis] -* xref:reference/header_concurrent_node_map.adoc[`` Synopsis] -* xref:reference/concurrent_node_map.adoc[Class Template `concurrent_node_map`] -* xref:reference/header_concurrent_node_set_fwd.adoc[`` Synopsis] -* xref:reference/header_concurrent_node_set.adoc[`` Synopsis] -* xref:reference/concurrent_node_set.adoc[Class Template `concurrent_node_set`] +* xref:reference/header_unordered_flat_map_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_flat_map.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_flat_map.adoc[Class Template ++++++unordered_flat_map++++++] +* xref:reference/header_unordered_flat_set_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_flat_set.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_flat_set.adoc[Class Template ++++++unordered_flat_set++++++] +* xref:reference/header_unordered_node_map_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_node_map.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_node_map.adoc[Class Template ++++++unordered_node_map++++++] +* xref:reference/header_unordered_node_set_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_unordered_node_set.adoc[++++++++++++ Synopsis] +* xref:reference/unordered_node_set.adoc[Class Template ++++++unordered_node_set++++++] +* xref:reference/header_concurrent_flat_map_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_concurrent_flat_map.adoc[++++++++++++ Synopsis] +* xref:reference/concurrent_flat_map.adoc[Class Template ++++++concurrent_flat_map++++++] +* xref:reference/header_concurrent_flat_set_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_concurrent_flat_set.adoc[++++++++++++ Synopsis] +* xref:reference/concurrent_flat_set.adoc[Class Template ++++++concurrent_flat_set++++++] +* xref:reference/header_concurrent_node_map_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_concurrent_node_map.adoc[++++++++++++ Synopsis] +* xref:reference/concurrent_node_map.adoc[Class Template ++++++concurrent_node_map++++++] +* xref:reference/header_concurrent_node_set_fwd.adoc[++++++++++++ Synopsis] +* xref:reference/header_concurrent_node_set.adoc[++++++++++++ Synopsis] +* xref:reference/concurrent_node_set.adoc[Class Template ++++++concurrent_node_set++++++] From 1eca210c82efc7cdafc241ae77597058c77cb195 Mon Sep 17 00:00:00 2001 From: joaquintides Date: Thu, 23 Jan 2025 09:25:58 +0100 Subject: [PATCH 3/3] relinked bundle --- doc/unordered-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/unordered-playbook.yml b/doc/unordered-playbook.yml index 94cbb1ef2..dcd2c3065 100644 --- a/doc/unordered-playbook.yml +++ b/doc/unordered-playbook.yml @@ -10,5 +10,5 @@ output: dir: html ui: bundle: - url: https://github.com/cmazakas/unordered-ui-bundle/raw/450505aa457796028a36e9d712e5d52f9f394c1a/ui-bundle.zip + url: https://github.com/boostorg/unordered-ui-bundle/raw/c80db72a7ba804256beb36e3a46d9c7df265d8d7/ui-bundle.zip output_dir: unordered/_