doxygroups.cc

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

Generated on Fri Jan 23 20:12:11 2009 for libstdc++ by  doxygen 1.5.6