libstdc++
|
00001 /* 00002 Copyright (C) 2001-2013 Free Software Foundation, Inc. 00003 See license.html for license. 00004 00005 This just provides documentation for stuff that doesn't need to be in the 00006 source headers themselves. It is a ".cc" file for the sole cheesy reason 00007 that it triggers many different text editors into doing Nice Things when 00008 typing comments. However, it is mentioned nowhere except the *cfg.in files. 00009 00010 Some actual code (declarations) is exposed here, but no compiler ever 00011 sees it. The decls must be visible to doxygen, and sometimes their real 00012 declarations are not visible, or not visible in a way we want. 00013 00014 Pieces separated by '// //' lines will usually not be presented to the 00015 user on the same page. 00016 */ 00017 00018 // // // // // // // // // // // // // // // // // // // // // // // // 00019 /** @namespace std 00020 * @brief ISO C++ entities toplevel namespace is std. 00021 */ 00022 /** @namespace std::__detail 00023 * @brief Implementation details not part of the namespace std interface. 00024 */ 00025 /** @namespace std::tr1 00026 * @brief ISO C++ TR1 entities toplevel namespace is std::tr1. 00027 */ 00028 /** @namespace std::tr1::__detail 00029 * @brief Implementation details not part of the namespace std::tr1 interface. 00030 */ 00031 /** @namespace std::tr2 00032 * @brief ISO C++ TR2 entities toplevel namespace is std::tr2. 00033 */ 00034 /** @namespace std::tr2::__detail 00035 * @brief Implementation details not part of the namespace std::tr2 interface. 00036 */ 00037 /** @namespace __gnu_cxx 00038 * @brief GNU extensions for public use. 00039 */ 00040 /** @namespace __gnu_cxx::__detail 00041 * @brief Implementation details not part of the namespace __gnu_cxx 00042 * interface. 00043 */ 00044 /** @namespace __gnu_internal 00045 * @brief GNU implemenation details, not for public use or 00046 * export. Used only when anonymous namespaces cannot be substituted. 00047 */ 00048 // // // // // // // // // // // // // // // // // // // // // // // // 00049 00050 /** 00051 * @defgroup extensions Extensions 00052 * 00053 * Components generally useful that are not part of any standard. 00054 */ 00055 00056 /** @defgroup SGIextensions SGI 00057 * @ingroup extensions 00058 Because libstdc++ based its implementation of the STL subsections of 00059 the library on the SGI 3.3 implementation, we inherited their extensions 00060 as well. 00061 00062 They are additionally documented in the 00063 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html"> 00064 online documentation</a>, a copy of which is also shipped with the 00065 library source code (in .../docs/html/documentation.html). You can also 00066 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's 00067 site</a>, which is still running even though the code is not maintained. 00068 00069 <strong>NB</strong> that the following notes are pulled from various 00070 comments all over the place, so they may seem stilted. 00071 <hr> 00072 */ 00073 00074 /** @defgroup containers Containers 00075 Containers are collections of objects. 00076 00077 A container may hold any type which meets certain requirements, but the type 00078 of contained object is chosen at compile time, and all objects in a given 00079 container must be of the same type. (Polymorphism is possible by declaring a 00080 container of pointers to a base class and then populating it with pointers to 00081 instances of derived classes. Variant value types such as the @c any class 00082 from <a href="http://www.boost.org/">Boost</a> can also be used. 00083 00084 All contained types must be @c Assignable and @c CopyConstructible. 00085 Specific containers may place additional requirements on the types of 00086 their contained objects. 00087 00088 Containers manage memory allocation and deallocation themselves when 00089 storing your objects. The objects are destroyed when the container is 00090 itself destroyed. Note that if you are storing pointers in a container, 00091 @c delete is @e not automatically called on the pointers before destroying them. 00092 00093 All containers must meet certain requirements, summarized in 00094 <a href="tables.html">tables</a>. 00095 00096 The standard containers are further refined into 00097 @link sequences Sequences@endlink and 00098 @link associative_containers Associative Containers@endlink. 00099 @link unordered_associative_containers Unordered Associative Containers@endlink. 00100 */ 00101 00102 /** @defgroup sequences Sequences 00103 * @ingroup containers 00104 Sequences arrange a collection of objects into a strictly linear order. 00105 00106 The differences between sequences are usually due to one or both of the 00107 following: 00108 - memory management 00109 - algorithmic complexity 00110 00111 As an example of the first case, @c vector is required to use a contiguous 00112 memory layout, while other sequences such as @c deque are not. 00113 00114 The prime reason for choosing one sequence over another should be based on 00115 the second category of differences, algorithmic complexity. For example, if 00116 you need to perform many inserts and removals from the middle of a sequence, 00117 @c list would be ideal. But if you need to perform constant-time access to 00118 random elements of the sequence, then @c list should not be used. 00119 00120 All sequences must meet certain requirements, summarized in 00121 <a href="tables.html">tables</a>. 00122 */ 00123 00124 /** @defgroup associative_containers Associative 00125 * @ingroup containers 00126 Associative containers allow fast retrieval of data based on keys. 00127 00128 Each container type is parameterized on a @c Key type, and an ordering 00129 relation used to sort the elements of the container. 00130 00131 All associative containers must meet certain requirements, summarized in 00132 <a href="tables.html">tables</a>. 00133 */ 00134 00135 /** @defgroup unordered_associative_containers Unordered Associative 00136 * @ingroup containers 00137 Unordered associative containers allow fast retrieval of data based on keys. 00138 00139 Each container type is parameterized on a @c Key type, a @c Hash type 00140 providing a hashing functor, and an ordering relation used to sort the 00141 elements of the container. 00142 00143 All unordered associative containers must meet certain requirements, 00144 summarized in <a href="tables.html">tables</a>. */ 00145 00146 /** 00147 * @defgroup diagnostics Diagnostics 00148 * 00149 * Components for error handling, reporting, and diagnostic operations. 00150 */ 00151 00152 /** 00153 * @defgroup concurrency Concurrency 00154 * 00155 * Components for concurrent operations, including threads, mutexes, 00156 * and condition variables. 00157 */