1 1.1 mrg /* 2 1.1.1.12 mrg Copyright (C) 2001-2024 Free Software Foundation, Inc. 3 1.1 mrg See license.html for license. 4 1.1 mrg 5 1.1 mrg This just provides documentation for stuff that doesn't need to be in the 6 1.1 mrg source headers themselves. It is a ".cc" file for the sole cheesy reason 7 1.1 mrg that it triggers many different text editors into doing Nice Things when 8 1.1 mrg typing comments. However, it is mentioned nowhere except the *cfg.in files. 9 1.1 mrg 10 1.1 mrg Some actual code (declarations) is exposed here, but no compiler ever 11 1.1 mrg sees it. The decls must be visible to doxygen, and sometimes their real 12 1.1 mrg declarations are not visible, or not visible in a way we want. 13 1.1 mrg 14 1.1 mrg Pieces separated by '// //' lines will usually not be presented to the 15 1.1 mrg user on the same page. 16 1.1 mrg */ 17 1.1 mrg 18 1.1 mrg // // // // // // // // // // // // // // // // // // // // // // // // 19 1.1 mrg /** @namespace std 20 1.1 mrg * @brief ISO C++ entities toplevel namespace is std. 21 1.1 mrg */ 22 1.1.1.11 mrg /** @namespace std::literals 23 1.1.1.10 mrg * @brief ISO C++ inline namespace for literal suffixes. 24 1.1.1.10 mrg */ 25 1.1 mrg /** @namespace std::__detail 26 1.1 mrg * @brief Implementation details not part of the namespace std interface. 27 1.1 mrg */ 28 1.1 mrg /** @namespace std::tr1 29 1.1 mrg * @brief ISO C++ TR1 entities toplevel namespace is std::tr1. 30 1.1 mrg */ 31 1.1 mrg /** @namespace std::tr1::__detail 32 1.1 mrg * @brief Implementation details not part of the namespace std::tr1 interface. 33 1.1 mrg */ 34 1.1.1.2 mrg /** @namespace std::tr2 35 1.1.1.10 mrg * @brief Namespace for non-standard "TR2" extensions. 36 1.1.1.10 mrg * @ingroup extensions 37 1.1.1.2 mrg */ 38 1.1.1.2 mrg /** @namespace std::tr2::__detail 39 1.1.1.2 mrg * @brief Implementation details not part of the namespace std::tr2 interface. 40 1.1.1.2 mrg */ 41 1.1 mrg /** @namespace __gnu_cxx 42 1.1 mrg * @brief GNU extensions for public use. 43 1.1.1.10 mrg * @ingroup extensions 44 1.1 mrg */ 45 1.1 mrg /** @namespace __gnu_cxx::__detail 46 1.1.1.11 mrg * @brief Implementation details not part of the namespace __gnu_cxx 47 1.1 mrg * interface. 48 1.1 mrg */ 49 1.1 mrg /** @namespace __gnu_internal 50 1.1 mrg * @brief GNU implemenation details, not for public use or 51 1.1 mrg * export. Used only when anonymous namespaces cannot be substituted. 52 1.1 mrg */ 53 1.1.1.10 mrg /** @namespace std::experimental 54 1.1.1.10 mrg * @brief Namespace for features defined in ISO Technical Specifications. 55 1.1.1.10 mrg */ 56 1.1 mrg // // // // // // // // // // // // // // // // // // // // // // // // 57 1.1 mrg 58 1.1 mrg /** 59 1.1 mrg * @defgroup extensions Extensions 60 1.1 mrg * 61 1.1 mrg * Components generally useful that are not part of any standard. 62 1.1 mrg */ 63 1.1 mrg 64 1.1 mrg /** @defgroup SGIextensions SGI 65 1.1 mrg * @ingroup extensions 66 1.1 mrg Because libstdc++ based its implementation of the STL subsections of 67 1.1 mrg the library on the SGI 3.3 implementation, we inherited their extensions 68 1.1 mrg as well. 69 1.1 mrg 70 1.1 mrg They are additionally documented in the 71 1.1 mrg <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html"> 72 1.1 mrg online documentation</a>, a copy of which is also shipped with the 73 1.1 mrg library source code (in .../docs/html/documentation.html). You can also 74 1.1 mrg read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's 75 1.1 mrg site</a>, which is still running even though the code is not maintained. 76 1.1 mrg 77 1.1 mrg <strong>NB</strong> that the following notes are pulled from various 78 1.1 mrg comments all over the place, so they may seem stilted. 79 1.1 mrg <hr> 80 1.1 mrg */ 81 1.1 mrg 82 1.1 mrg /** @defgroup containers Containers 83 1.1 mrg Containers are collections of objects. 84 1.1 mrg 85 1.1 mrg A container may hold any type which meets certain requirements, but the type 86 1.1 mrg of contained object is chosen at compile time, and all objects in a given 87 1.1 mrg container must be of the same type. (Polymorphism is possible by declaring a 88 1.1 mrg container of pointers to a base class and then populating it with pointers to 89 1.1 mrg instances of derived classes. Variant value types such as the @c any class 90 1.1 mrg from <a href="http://www.boost.org/">Boost</a> can also be used. 91 1.1 mrg 92 1.1 mrg All contained types must be @c Assignable and @c CopyConstructible. 93 1.1 mrg Specific containers may place additional requirements on the types of 94 1.1 mrg their contained objects. 95 1.1 mrg 96 1.1 mrg Containers manage memory allocation and deallocation themselves when 97 1.1 mrg storing your objects. The objects are destroyed when the container is 98 1.1 mrg itself destroyed. Note that if you are storing pointers in a container, 99 1.1 mrg @c delete is @e not automatically called on the pointers before destroying them. 100 1.1 mrg 101 1.1 mrg All containers must meet certain requirements, summarized in 102 1.1 mrg <a href="tables.html">tables</a>. 103 1.1 mrg 104 1.1 mrg The standard containers are further refined into 105 1.1 mrg @link sequences Sequences@endlink and 106 1.1 mrg @link associative_containers Associative Containers@endlink. 107 1.1 mrg @link unordered_associative_containers Unordered Associative Containers@endlink. 108 1.1 mrg */ 109 1.1 mrg 110 1.1 mrg /** @defgroup sequences Sequences 111 1.1 mrg * @ingroup containers 112 1.1 mrg Sequences arrange a collection of objects into a strictly linear order. 113 1.1 mrg 114 1.1 mrg The differences between sequences are usually due to one or both of the 115 1.1 mrg following: 116 1.1 mrg - memory management 117 1.1 mrg - algorithmic complexity 118 1.1 mrg 119 1.1 mrg As an example of the first case, @c vector is required to use a contiguous 120 1.1 mrg memory layout, while other sequences such as @c deque are not. 121 1.1 mrg 122 1.1 mrg The prime reason for choosing one sequence over another should be based on 123 1.1 mrg the second category of differences, algorithmic complexity. For example, if 124 1.1 mrg you need to perform many inserts and removals from the middle of a sequence, 125 1.1 mrg @c list would be ideal. But if you need to perform constant-time access to 126 1.1 mrg random elements of the sequence, then @c list should not be used. 127 1.1 mrg 128 1.1 mrg All sequences must meet certain requirements, summarized in 129 1.1 mrg <a href="tables.html">tables</a>. 130 1.1 mrg */ 131 1.1 mrg 132 1.1 mrg /** @defgroup associative_containers Associative 133 1.1 mrg * @ingroup containers 134 1.1 mrg Associative containers allow fast retrieval of data based on keys. 135 1.1 mrg 136 1.1 mrg Each container type is parameterized on a @c Key type, and an ordering 137 1.1 mrg relation used to sort the elements of the container. 138 1.1 mrg 139 1.1 mrg All associative containers must meet certain requirements, summarized in 140 1.1 mrg <a href="tables.html">tables</a>. 141 1.1 mrg */ 142 1.1 mrg 143 1.1 mrg /** @defgroup unordered_associative_containers Unordered Associative 144 1.1 mrg * @ingroup containers 145 1.1 mrg Unordered associative containers allow fast retrieval of data based on keys. 146 1.1 mrg 147 1.1 mrg Each container type is parameterized on a @c Key type, a @c Hash type 148 1.1 mrg providing a hashing functor, and an ordering relation used to sort the 149 1.1 mrg elements of the container. 150 1.1 mrg 151 1.1 mrg All unordered associative containers must meet certain requirements, 152 1.1 mrg summarized in <a href="tables.html">tables</a>. */ 153 1.1 mrg 154 1.1 mrg /** 155 1.1 mrg * @defgroup diagnostics Diagnostics 156 1.1 mrg * 157 1.1 mrg * Components for error handling, reporting, and diagnostic operations. 158 1.1 mrg */ 159 1.1 mrg 160 1.1 mrg /** 161 1.1 mrg * @defgroup concurrency Concurrency 162 1.1 mrg * 163 1.1 mrg * Components for concurrent operations, including threads, mutexes, 164 1.1 mrg * and condition variables. 165 1.1 mrg */ 166 1.1.1.10 mrg 167 1.1.1.10 mrg /** 168 1.1.1.10 mrg * @defgroup experimental Technical Specifications 169 1.1.1.10 mrg * 170 1.1.1.10 mrg * Components specified by various Technical Specifications. 171 1.1.1.10 mrg * 172 1.1.1.10 mrg * As indicated by the std::experimental namespace and the header paths, 173 1.1.1.10 mrg * the contents of these Technical Specifications are experimental and not 174 1.1.1.10 mrg * part of the C++ standard. As such the interfaces and implementations may 175 1.1.1.10 mrg * change in the future, and there is <STRONG> no guarantee of compatibility 176 1.1.1.10 mrg * between different GCC releases </STRONG> for these features. 177 1.1.1.10 mrg */ 178
Indexes created Mon Jun 01 00:24:59 UTC 2026