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

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