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