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