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