# doxygroups.cc

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