libstdc++-v3/docs/doxygen/doxygroups.cc

   1 /*
   2    Copyright (C) 2001, 2002, 2005 Free Software Foundation, Inc.
   3    See license.html for license.
   4
   5    This just provides documentation for stuff that doesn't need to be in the
   6    source headers themselves.  It is a ".cc" file for the sole cheesy reason
   7    that it triggers many different text editors into doing Nice Things when
   8    typing comments.  However, it is mentioned nowhere except the *cfg.in files.
   9
  10    Some actual code (declarations) is exposed here, but no compiler ever
  11    sees it.  The decls must be visible to doxygen, and sometimes their real
  12    declarations are not visible, or not visible in a way we want.
  13
  14    Pieces separated by '// //' lines will usually not be presented to the
  15    user on the same page.
  16 */
  17
  18 // // // // // // // // // // // // // // // // // // // // // // // //
  19 /** @namespace std
  20  *  @brief Everything defined by the ISO C++ Standard is within
  21  *  namespace <a class="el" href="namespacestd.html">std</a>.
  22 */
  23 /** @namespace std::__detail
  24  *  @brief Implementation details not part of the namespace <a class="el"
  25  *  href="namespacestd.html">std</a> interface.
  26 */
  27 /** @namespace std::tr1
  28  *  @brief Everything defined by the ISO C++ TR1 is within namespace std::tr1.
  29 */
  30 /** @namespace std::tr1::__detail
  31  *  @brief Implementation details not part of the namespace std::tr1 interface.
  32 */
  33 /** @namespace __gnu_cxx
  34  *  @brief GNU extensions for public use.
  35 */
  36 /** @namespace __gnu_cxx::__detail
  37  *  @brief Implementation details not part of the namespace __gnu_cxx
  38  *  interface.
  39 */
  40 /** @namespace __gnu_cxx::typelist
  41  *  @brief GNU typelist extensions for public compile-time use.
  42 */
  43 /** @namespace __gnu_internal
  44  *  @brief GNU implemenation details, not for public use or
  45  *  export. Used only when anonymous namespaces cannot be substituted.
  46 */
  47 /** @namespace __gnu_debug
  48  *  @brief GNU debug mode classes for public use.
  49 */
  50 // // // // // // // // // // // // // // // // // // // // // // // //
  51 /** @addtogroup SGIextensions STL extensions from SGI
  52 Because libstdc++ based its implementation of the STL subsections of
  53 the library on the SGI 3.3 implementation, we inherited their extensions
  54 as well.
  55
  56 They are additionally documented in the
  57 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
  58 online documentation</a>, a copy of which is also shipped with the
  59 library source code (in .../docs/html/documentation.html).  You can also
  60 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's
  61 site</a>, which is still running even though the code is not maintained.
  62
  63 <strong>NB</strong> that the following notes are pulled from various
  64 comments all over the place, so they may seem stilted.
  65 <hr>
  66 */
  67
  68 // // // // // // // // // // // // // // // // // // // // // // // //
  69 // This is standalone because, unlike the functor introduction, there is no
  70 // single header file which serves as a base "all containers must include
  71 // this header".  We do some quoting of 14882 here.
  72 /** @addtogroup Containers Containers
  73 Containers are collections of objects.
  74
  75 A container may hold any type which meets certain requirements, but the type
  76 of contained object is chosen at compile time, and all objects in a given
  77 container must be of the same type.  (Polymorphism is possible by declaring a
  78 container of pointers to a base class and then populating it with pointers to
  79 instances of derived classes.  Variant value types such as the @c any class
  80 from <a href="http://www.boost.org/">Boost</a> can also be used.
  81
  82 All contained types must be @c Assignable and @c CopyConstructible.
  83 Specific containers may place additional requirements on the types of
  84 their contained objects.
  85
  86 Containers manage memory allocation and deallocation themselves when
  87 storing your objects.  The objects are destroyed when the container is
  88 itself destroyed.  Note that if you are storing pointers in a container,
  89 @c delete is @e not automatically called on the pointers before destroying them.
  90
  91 All containers must meet certain requirements, summarized in
  92 <a href="tables.html">tables</a>.
  93
  94 The standard containers are further refined into
  95 @link Sequences Sequences@endlink and
  96 @link Assoc_containers Associative Containers@endlink.
  97 */
  98
  99 /** @addtogroup Sequences Sequences
 100 Sequences arrange a collection of objects into a strictly linear order.
 101
 102 The differences between sequences are usually due to one or both of the
 103 following:
 104   - memory management
 105   - algorithmic complexity
 106
 107 As an example of the first case, @c vector is required to use a contiguous
 108 memory layout, while other sequences such as @c deque are not.
 109
 110 The prime reason for choosing one sequence over another should be based on
 111 the second category of differences, algorithmic complexity.  For example, if
 112 you need to perform many inserts and removals from the middle of a sequence,
 113 @c list would be ideal.  But if you need to perform constant-time access to
 114 random elements of the sequence, then @c list should not be used.
 115
 116 All sequences must meet certain requirements, summarized in
 117 <a href="tables.html">tables</a>.
 118 */
 119
 120 /** @addtogroup Assoc_containers Associative Containers
 121 Associative containers allow fast retrieval of data based on keys.
 122
 123 Each container type is parameterized on a @c Key type, and an ordering
 124 relation used to sort the elements of the container.
 125
 126 There should be more text here.
 127
 128 All associative containers must meet certain requirements, summarized in
 129 <a href="tables.html">tables</a>.
 130 */
 131
 132 // // // // // // // // // // // // // // // // // // // // // // // //
 133 /** @namespace abi
 134  *  @brief The cross-vendor C++ Application Binary Interface. A
 135  *  namespace alias to __cxxabiv1.
 136  *
 137  *  A brief overview of an ABI is given in the libstdc++ FAQ, question
 138  *  5.8 (you may have a copy of the FAQ locally, or you can view the online
 139  *  version at http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#5_8).
 140  *
 141  *  GCC subscribes to a relatively-new cross-vendor ABI for C++, sometimes
 142  *  called the IA64 ABI because it happens to be the native ABI for that
 143  *  platform.  It is summarized at http://www.codesourcery.com/cxx-abi/
 144  *  along with the current specification.
 145  *
 146  *  For users of GCC greater than or equal to 3.x, entry points are
 147  *  available in <cxxabi.h>, which notes, <em>"It is not normally
 148  *  necessary for user programs to include this header, or use the
 149  *  entry points directly.  However, this header is available should
 150  *  that be needed."</em>
 151 */
 152
 153 namespace abi {
 154 /**
 155 @brief New ABI-mandated entry point in the C++ runtime library for demangling.
 156
 157 @param mangled_name A NUL-terminated character string containing the name
 158                     to be demangled.
 159
 160 @param output_buffer A region of memory, allocated with malloc, of
 161                      @a *length bytes, into which the demangled name
 162                      is stored.  If @a output_buffer is not long enough,
 163                      it is expanded using realloc.  @a output_buffer may
 164                      instead be NULL; in that case, the demangled name is
 165                      placed in a region of memory allocated with malloc.
 166
 167 @param length If @a length is non-NULL, the length of the buffer containing
 168               the demangled name is placed in @a *length.
 169
 170 @param status @a *status is set to one of the following values:
 171               -   0: The demangling operation succeeded.
 172               -  -1: A memory allocation failiure occurred.
 173               -  -2: @a mangled_name is not a valid name under the C++ ABI
 174                      mangling rules.
 175               -  -3: One of the arguments is invalid.
 176
 177 @return A pointer to the start of the NUL-terminated demangled name, or NULL
 178         if the demangling fails.  The caller is responsible for deallocating
 179         this memory using @c free.
 180
 181
 182 The demangling is performed using the C++ ABI mangling rules, with
 183 GNU extensions.  For example, this function is used
 184 in __gnu_cxx::__verbose_terminate_handler.  See
 185 http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#5 for other
 186 examples of use.
 187
 188 @note The same demangling functionality is available via libiberty
 189 (@c <libiberty/demangle.h> and @c libiberty.a) in GCC 3.1 and later, but that
 190 requires explicit installation (@c --enable-install-libiberty) and uses a
 191 different API, although the ABI is unchanged.
 192 */
 193 char* __cxa_demangle (const char* mangled_name, char* output_buffer,
 194                       size_t* length, int* status);
 195 } // namespace abi
 196
 197 // // // // // // // // // // // // // // // // // // // // // // // //
 198 /** @addtogroup binarysearch Binary search algorithms
 199 These algorithms are variations of a classic binary search.  They all assume
 200 that the sequence being searched is already sorted.
 201
 202 The number of comparisons will be logarithmic (and as few as possible).
 203 The number of steps through the sequence will be logarithmic for
 204 random-access iterators (e.g., pointers), and linear otherwise.
 205
 206 The LWG has passed Defect Report 270, which notes:  <em>The proposed
 207 resolution reinterprets binary search. Instead of thinking about searching
 208 for a value in a sorted range, we view that as an important special
 209 case of a more general algorithm: searching for the partition point in a
 210 partitioned range.  We also add a guarantee that the old wording did not:
 211 we ensure that the upper bound is no earlier than the lower bound, that
 212 the pair returned by equal_range is a valid range, and that the first part
 213 of that pair is the lower bound.</em>
 214
 215 The actual effect of the first sentence is that a comparison functor
 216 passed by the user doesn't necessarily need to induce a strict weak ordering
 217 relation.  Rather, it partitions the range.
 218 */
 219
 220 // // // // // // // // // // // // // // // // // // // // // // // //
 221 /** @addtogroup setoperations Set operation algorithms
 222 These algorithms are common set operations performed on sequences that are
 223 already sorted.
 224
 225 The number of comparisons will be linear.
 226 */
 227
 228 // // // // // // // // // // // // // // // // // // // // // // // //
 229
 230 // // // // // // // // // // // // // // // // // // // // // // // //
 231 /* * @addtogroup groupname description of group
 232 placeholder text
 233 */
 234
 235 // // // // // // // // // // // // // // // // // // // // // // // //
 236
 237 // vim:et:noai:
 238