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