l4/pkg/libstdc++-v3/contrib/libstdc++-v3-4.3.3/doc/doxygen/doxygroups.cc

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