00001 /* 00002 Copyright (C) 2001, 2002, 2005 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 Everything defined by the ISO C++ Standard is within namespace std. 00021 */ 00022 /** @namespace std::tr1 00023 * @brief Everything defined by the TR1 is within namespace std::tr1. 00024 */ 00025 /** @namespace __gnu_cxx 00026 * @brief GNU extensions for public use. 00027 */ 00028 /** @namespace __gnu_cxx::balloc 00029 * @brief Related to __gnu_cxx::bitmap_allocator. 00030 */ 00031 /** @namespace __gnu_internal 00032 * @brief GNU implemenation details, not for public use. 00033 */ 00034 /** @namespace __gnu_debug 00035 * @brief GNU debug mode implemenation details. 00036 */ 00037 // // // // // // // // // // // // // // // // // // // // // // // // 00038 /** @addtogroup SGIextensions STL extensions from SGI 00039 Because libstdc++-v3 based its implementation of the STL subsections of 00040 the library on the SGI 3.3 implementation, we inherited their extensions 00041 as well. 00042 00043 They are additionally documented in the 00044 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html"> 00045 online documentation</a>, a copy of which is also shipped with the 00046 library source code (in .../docs/html/documentation.html). You can also 00047 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's 00048 site</a>, which is still running even though the code is not maintained. 00049 00050 <strong>NB</strong> that the following notes are pulled from various 00051 comments all over the place, so they may seem stilted. 00052 <hr> 00053 */ 00054 00055 // // // // // // // // // // // // // // // // // // // // // // // // 00056 // This is standalone because, unlike the functor introduction, there is no 00057 // single header file which serves as a base "all containers must include 00058 // this header". We do some quoting of 14882 here. 00059 /** @addtogroup Containers Containers 00060 Containers are collections of objects. 00061 00062 A container may hold any type which meets certain requirements, but the type 00063 of contained object is chosen at compile time, and all objects in a given 00064 container must be of the same type. (Polymorphism is possible by declaring a 00065 container of pointers to a base class and then populating it with pointers to 00066 instances of derived classes. Variant value types such as the @c any class 00067 from <a href="http://www.boost.org/">Boost</a> can also be used. 00068 00069 All contained types must be @c Assignable and @c CopyConstructible. 00070 Specific containers may place additional requirements on the types of 00071 their contained objects. 00072 00073 Containers manage memory allocation and deallocation themselves when 00074 storing your objects. The objects are destroyed when the container is 00075 itself destroyed. Note that if you are storing pointers in a container, 00076 @c delete is @e not automatically called on the pointers before destroying them. 00077 00078 All containers must meet certain requirements, summarized in 00079 <a href="tables.html">tables</a>. 00080 00081 The standard containers are further refined into 00082 @link Sequences Sequences@endlink and 00083 @link Assoc_containers Associative Containers@endlink. 00084 */ 00085 00086 /** @addtogroup Sequences Sequences 00087 Sequences arrange a collection of objects into a strictly linear order. 00088 00089 The differences between sequences are usually due to one or both of the 00090 following: 00091 - memory management 00092 - algorithmic complexity 00093 00094 As an example of the first case, @c vector is required to use a contiguous 00095 memory layout, while other sequences such as @c deque are not. 00096 00097 The prime reason for choosing one sequence over another should be based on 00098 the second category of differences, algorithmic complexity. For example, if 00099 you need to perform many inserts and removals from the middle of a sequence, 00100 @c list would be ideal. But if you need to perform constant-time access to 00101 random elements of the sequence, then @c list should not be used. 00102 00103 All sequences must meet certain requirements, summarized in 00104 <a href="tables.html">tables</a>. 00105 */ 00106 00107 /** @addtogroup Assoc_containers Associative Containers 00108 Associative containers allow fast retrieval of data based on keys. 00109 00110 Each container type is parameterized on a @c Key type, and an ordering 00111 relation used to sort the elements of the container. 00112 00113 There should be more text here. 00114 00115 All associative containers must meet certain requirements, summarized in 00116 <a href="tables.html">tables</a>. 00117 */ 00118 00119 // // // // // // // // // // // // // // // // // // // // // // // // 00120 /** @namespace abi 00121 * @brief The cross-vendor C++ Application Binary Interface. 00122 * 00123 * A brief overview of an ABI is given in the libstdc++-v3 FAQ, question 00124 * 5.8 (you may have a copy of the FAQ locally, or you can view the online 00125 * version at http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#5_8). 00126 * 00127 * GCC subscribes to a relatively-new cross-vendor ABI for C++, sometimes 00128 * called the IA64 ABI because it happens to be the native ABI for that 00129 * platform. It is summarized at http://www.codesourcery.com/cxx-abi/ 00130 * along with the current specification. 00131 * 00132 * For users of GCC greater than or equal to 3.x, entry points are 00133 * available in <cxxabi.h>, which notes, <em>"It is not normally 00134 * necessary for user programs to include this header, or use the 00135 * entry points directly. However, this header is available should 00136 * that be needed."</em> 00137 */ 00138 00139 namespace abi { 00140 /** 00141 @brief New ABI-mandated entry point in the C++ runtime library for demangling. 00142 00143 @param mangled_name A NUL-terminated character string containing the name 00144 to be demangled. 00145 00146 @param output_buffer A region of memory, allocated with malloc, of 00147 @a *length bytes, into which the demangled name 00148 is stored. If @a output_buffer is not long enough, 00149 it is expanded using realloc. @a output_buffer may 00150 instead be NULL; in that case, the demangled name is 00151 placed in a region of memory allocated with malloc. 00152 00153 @param length If @a length is non-NULL, the length of the buffer containing 00154 the demangled name is placed in @a *length. 00155 00156 @param status @a *status is set to one of the following values: 00157 - 0: The demangling operation succeeded. 00158 - -1: A memory allocation failiure occurred. 00159 - -2: @a mangled_name is not a valid name under the C++ ABI 00160 mangling rules. 00161 - -3: One of the arguments is invalid. 00162 00163 @return A pointer to the start of the NUL-terminated demangled name, or NULL 00164 if the demangling fails. The caller is responsible for deallocating 00165 this memory using @c free. 00166 00167 00168 The demagling is performed using the C++ ABI mangling rules, with 00169 GNU extensions. For example, this function is used 00170 in __gnu_cxx::__verbose_terminate_handler. See 00171 http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#5 for other 00172 examples of use. 00173 00174 @note The same demangling functionality is available via libiberty 00175 (@c <libiberty/demangle.h> and @c libiberty.a) in GCC 3.1 and later, but that 00176 requires explicit installation (@c --enable-install-libiberty) and uses a 00177 different API, although the ABI is unchanged. 00178 */ 00179 char* __cxa_demangle (const char* mangled_name, char* output_buffer, 00180 size_t* length, int* status); 00181 } // namespace abi 00182 00183 // // // // // // // // // // // // // // // // // // // // // // // // 00184 /** @addtogroup binarysearch Binary search algorithms 00185 These algorithms are variations of a classic binary search. They all assume 00186 that the sequence being searched is already sorted. 00187 00188 The number of comparisons will be logarithmic (and as few as possible). 00189 The number of steps through the sequence will be logarithmic for 00190 random-access iterators (e.g., pointers), and linear otherwise. 00191 00192 The LWG has passed Defect Report 270, which notes: <em>The proposed 00193 resolution reinterprets binary search. Instead of thinking about searching 00194 for a value in a sorted range, we view that as an important special 00195 case of a more general algorithm: searching for the partition point in a 00196 partitioned range. We also add a guarantee that the old wording did not: 00197 we ensure that the upper bound is no earlier than the lower bound, that 00198 the pair returned by equal_range is a valid range, and that the first part 00199 of that pair is the lower bound.</em> 00200 00201 The actual effect of the first sentence is that a comparison functor 00202 passed by the user doesn't necessarily need to induce a strict weak ordering 00203 relation. Rather, it partitions the range. 00204 */ 00205 00206 // // // // // // // // // // // // // // // // // // // // // // // // 00207 /** @addtogroup setoperations Set operation algorithms 00208 These algorithms are common set operations performed on sequences that are 00209 already sorted. 00210 00211 The number of comparisons will be linear. 00212 */ 00213 00214 // // // // // // // // // // // // // // // // // // // // // // // // 00215 00216 // // // // // // // // // // // // // // // // // // // // // // // // 00217 /* * @addtogroup groupname description of group 00218 placeholder text 00219 */ 00220 00221 // // // // // // // // // // // // // // // // // // // // // // // // 00222 00223 // vim:et:noai: 00224