+2010-02-04 Benjamin Kosnik <bkoz@redhat.com>
+
+ PR libstdc++/42460
+ * doc/doxygen/user.cfg.in: Update file list.
+ * include/debug/safe_sequence.h: Doxygen markup fixes for '' and "".
+ * include/debug/safe_base.h: Same.
+ * include/debug/macros.h: Same.
+ * include/tr1_impl/regex: Same.
+ * include/std/iostream: Same.
+ * include/std/streambuf: Same.
+ * include/std/bitset: Same.
+ * include/std/iosfwd: Same.
+ * include/std/limits: Same.
+ * include/std/fstream: Same.
+ * include/std/istream: Same.
+ * include/std/ostream: Same.
+ * include/std/sstream: Same.
+ * include/parallel/multiway_merge.h: Same.
+ * include/parallel/for_each.h: Same.
+ * include/parallel/workstealing.h: Same.
+ * include/parallel/omp_loop_static.h: Same.
+ * include/parallel/omp_loop.h: Same.
+ * include/c_std/csignal: Same.
+ * include/c_std/cstdlib: Same.
+ * include/c_std/cstdio: Same.
+ * include/c_std/cstdarg: Same.
+ * include/c_std/cctype: Same.
+ * include/c_std/cerrno: Same.
+ * include/c_std/cmath: Same.
+ * include/c_std/ciso646: Same.
+ * include/c_std/ctime: Same.
+ * include/c_std/clocale: Same.
+ * include/c_std/climits: Same.
+ * include/c_std/cassert: Same.
+ * include/c_std/csetjmp: Same.
+ * include/c_std/cwchar: Same.
+ * include/c_std/cfloat: Same.
+ * include/c_std/cstring: Same.
+ * include/c_std/cstddef: Same.
+ * include/c_std/cwctype: Same.
+ * include/profile/iterator_tracker.h: Same.
+ * include/profile/impl/profiler_trace.h: Same.
+ * include/ext/vstring.h: Same.
+ * include/ext/algorithm: Same.
+ * include/ext/pb_ds/detail/pat_trie_/pat_trie_.h.pp: Same.
+ * include/ext/pb_ds/detail/bin_search_tree_/bin_search_tree_.h.pp: Same.
+ * include/ext/pb_ds/detail/type_utils.hpp: Same.
+ * include/ext/pb_ds/detail/splay_tree_/splay_tree_.hpp: Same
+ * include/ext/pb_ds/detail/rb_tree_map_/rb_tree_.hpp: Same.
+ * include/ext/rc_string_base.h: Same.
+ * include/ext/stdio_sync_filebuf.h: Same.
+ * include/ext/functional: Same.
+ * include/ext/mt_allocator.h: Same.
+ * include/bits/basic_ios.h: Same.
+ * include/bits/stl_map.h: Same.
+ * include/bits/stl_algobase.h: Same.
+ * include/bits/stl_queue.h: Same.
+ * include/bits/locale_classes.h: Same.
+ * include/bits/stl_set.h: Same.
+ * include/bits/locale_facets.h: Same.
+ * include/bits/stl_stack.h: Same.
+ * include/bits/stl_iterator_base_types.h: Same.
+ * include/bits/basic_string.h: Same.
+ * include/bits/stl_multimap.h: Same.
+ * include/bits/ios_base.h: Same.
+ * include/bits/stl_deque.h: Same.
+ * include/bits/stl_multiset.h: Same.
+ * include/bits/stl_iterator_base_funcs.h: Same.
+ * include/bits/char_traits.h: Same.
+ * include/bits/stl_algo.h: Same.
+ * include/bits/stl_iterator.h: Same.
+ * include/bits/stl_tempbuf.h: Same.
+ * include/bits/random.tcc: Same.
+ * include/bits/stl_function.h: Same.
+ * include/bits/cpp_type_traits.h: Same.
+ * include/bits/random.h: Same.
+ * include/bits/allocator.h: Same.
+ * include/bits/locale_facets_nonio.h: Same.
+ * include/c_global/csignal: Same.
+ * include/c_global/cstdlib: Same.
+ * include/c_global/cstdio: Same.
+ * include/c_global/cstdarg: Same.
+ * include/c_global/cctype: Same.
+ * include/c_global/cerrno: Same.
+ * include/c_global/cmath: Same.
+ * include/c_global/ciso646: Same.
+ * include/c_global/ctime: Same.
+ * include/c_global/clocale: Same.
+ * include/c_global/climits: Same.
+ * include/c_global/cassert: Same.
+ * include/c_global/csetjmp: Same.
+ * include/c_global/cwchar: Same.
+ * include/c_global/cfloat: Same.
+ * include/c_global/cstring: Same.
+ * include/c_global/cstddef: Same.
+ * include/c_global/cwctype: Same.
+ * include/tr1/hypergeometric.tcc: Same.
+ * include/tr1/random.tcc: Same.
+ * include/tr1/functional: Same.
+ * include/tr1/random.h: Same.
+ * include/backward/auto_ptr.h: Same.
+ * include/backward/binders.h: Same.
+ * testsuite/23_containers/deque/requirements/dr438/assign_neg.cc:
+ Adjust line numbers.
+ * testsuite/23_containers/deque/requirements/dr438/insert_neg.cc: Same.
+ * testsuite/23_containers/deque/requirements/dr438/constructor_1_neg.cc:
+ Same.
+ * testsuite/23_containers/deque/requirements/dr438/constructor_2_neg.cc:
+ Same.
+
2010-02-03 Jonathan Wakely <jwakely.gcc@gmail.com>
* include/std/condition_variable (condition_variable_any): Provide
include/tr1_impl/cstdlib \
include/tr1_impl/cwchar \
include/tr1_impl/cwctype \
- include/tr1_impl/functional \
include/tr1_impl/hashtable \
include/tr1_impl/regex \
include/tr1_impl/type_traits \
// auto_ptr implementation -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* @brief Smart pointer dereferencing.
*
* If this %auto_ptr no longer owns anything, then this
- * operation will crash. (For a smart pointer, "no longer owns
- * anything" is the same as being a null pointer, and you know
+ * operation will crash. (For a smart pointer, <em>no longer owns
+ * anything</em> is the same as being a null pointer, and you know
* what happens when you dereference one of those...)
*/
element_type&
// Functor implementations -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @defgroup binders Binder Classes
* @ingroup functors
*
- * Binders turn functions/functors with two arguments into functors with
- * a single argument, storing an argument to be applied later. For
- * example, a variable @c B of type @c binder1st is constructed from a
- * functor @c f and an argument @c x. Later, B's @c operator() is called
- * with a single argument @c y. The return value is the value of @c f(x,y).
- * @c B can be "called" with various arguments (y1, y2, ...) and will in
- * turn call @c f(x,y1), @c f(x,y2), ...
+ * Binders turn functions/functors with two arguments into functors
+ * with a single argument, storing an argument to be applied later.
+ * For example, a variable @c B of type @c binder1st is constructed
+ * from a functor @c f and an argument @c x. Later, B's @c
+ * operator() is called with a single argument @c y. The return
+ * value is the value of @c f(x,y). @c B can be @a called with
+ * various arguments (y1, y2, ...) and will in turn call @c
+ * f(x,y1), @c f(x,y2), ...
*
- * The function @c bind1st is provided to save some typing. It takes the
+ * The function @c bind1st is provided to save some typing. It takes the
* function and an argument as parameters, and returns an instance of
* @c binder1st.
*
* thing, but the stored argument is passed as the second parameter instead
* of the first, e.g., @c bind2nd(std::minus<float>,1.3) will create a
* functor whose @c operator() accepts a floating-point number, subtracts
- * 1.3 from it, and returns the result. (If @c bind1st had been used,
- * the functor would perform "1.3 - x" instead.
+ * 1.3 from it, and returns the result. (If @c bind1st had been used,
+ * the functor would perform <em>1.3 - x</em> instead.
*
* Creator-wrapper functions like @c bind1st are intended to be used in
- * calling algorithms. Their return values will be temporary objects.
+ * calling algorithms. Their return values will be temporary objects.
* (The goal is to not require you to type names like
* @c std::binder1st<std::plus<int>> for declaring a variable to hold the
* return value from @c bind1st(std::plus<int>,5).
};
/**
- * @brief The "standard" allocator, as per [20.4].
+ * @brief The @a standard allocator, as per [20.4].
* @ingroup allocators
*
* Further details:
// Iostreams base classes -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @brief The quick-and-easy status check.
*
* This allows you to write constructs such as
- * "if (!a_stream) ..." and "while (a_stream) ..."
+ * <code>if (!a_stream) ...</code> and <code>while (a_stream) ...</code>
*/
operator void*() const
{ return this->fail() ? 0 : const_cast<basic_ios*>(this); }
copyfmt(const basic_ios& __rhs);
/**
- * @brief Retrieves the "empty" character.
+ * @brief Retrieves the @a empty character.
* @return The current fill character.
*
* It defaults to a space (' ') in the current locale.
}
/**
- * @brief Sets a new "empty" character.
+ * @brief Sets a new @a empty character.
* @param ch The new character.
* @return The previous fill character.
*
* This approach has the enormous advantage that a string object
* requires only one allocation. All the ugliness is confined
* within a single pair of inline functions, which each compile to
- * a single "add" instruction: _Rep::_M_data(), and
+ * a single @a add instruction: _Rep::_M_data(), and
* string::_M_rep(); and the allocation function which gets a
* block of raw bytes and with room enough and constructs a _Rep
* object at the front.
* string length.)
*
* Note that the _Rep object is a POD so that you can have a
- * static "empty string" _Rep object already "constructed" before
+ * static <em>empty string</em> _Rep object already @a constructed before
* static constructors have run. The reference-count encoding is
* chosen so that a 0 indicates one reference, so you never try to
* destroy the empty-string _Rep object.
* @param n Number of characters to copy.
* @param a Allocator to use (default is default allocator).
*
- * NB: @a s must have at least @a n characters, '\\0' has no special
- * meaning.
+ * NB: @a s must have at least @a n characters, '\\0'
+ * has no special meaning.
*/
basic_string(const _CharT* __s, size_type __n,
const _Alloc& __a = _Alloc());
{ _M_mutate(0, this->size(), 0); }
/**
- * Returns true if the %string is empty. Equivalent to *this == "".
+ * Returns true if the %string is empty. Equivalent to
+ * <code>*this == ""</code>.
*/
bool
empty() const
* result of the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
- * NB: s must have at least n2 characters, '\\0' has no special
- * meaning.
+ * NB: s must have at least n2 characters, '\\0' has
+ * no special meaning.
*/
int
compare(size_type __pos, size_type __n1, const _CharT* __s,
* @param str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from is into @a str until '\n' is found, the end of
- * the stream is encountered, or str.max_size() is reached. If is.width()
- * is non-zero, that is the limit on the number of characters stored into
- * @a str. Any previous contents of @a str are erased. If end of line was
- * encountered, it is extracted but not stored into @a str.
+ * Stores characters from is into @a str until '\n' is
+ * found, the end of the stream is encountered, or str.max_size()
+ * is reached. If is.width() is non-zero, that is the limit on the
+ * number of characters stored into @a str. Any previous contents
+ * of @a str are erased. If end of line was encountered, it is
+ * extracted but not stored into @a str.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_istream<_CharT, _Traits>&
// Character Traits for use by standard string and iostream -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* namespace __gnu_cxx may be.
*
* See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt05ch13s03.html
- * for advice on how to make use of this class for "unusual" character
+ * for advice on how to make use of this class for @a unusual character
* types. Also, check out include/ext/pod_char_traits.h.
*/
template<typename _CharT>
* appropriate definition by specializing __gnu_cxx::char_traits.
*
* See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt05ch13s03.html
- * for advice on how to make use of this class for "unusual" character
+ * for advice on how to make use of this class for @a unusual character
* types. Also, check out include/ext/pod_char_traits.h.
*/
template<class _CharT>
// The -*- C++ -*- type traits classes for internal use in libstdc++
-// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009
+// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
};
// Thirteen specializations (yes there are eleven standard integer
- // types; 'long long' and 'unsigned long long' are supported as
- // extensions)
+ // types; <em>long long</em> and <em>unsigned long long</em> are
+ // supported as extensions)
template<>
struct __is_integer<bool>
{
// Iostreams base classes -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/**
* @brief This is a bitmask type.
*
- * @c "_Ios_Fmtflags" is implementation-defined, but it is valid to
+ * @c @a _Ios_Fmtflags is implementation-defined, but it is valid to
* perform bitwise operations on these values and expect the Right
* Thing to happen. Defined objects of type fmtflags are:
* - boolalpha
/**
* @brief This is a bitmask type.
*
- * @c "_Ios_Iostate" is implementation-defined, but it is valid to
+ * @c @a _Ios_Iostate is implementation-defined, but it is valid to
* perform bitwise operations on these values and expect the Right
* Thing to happen. Defined objects of type iostate are:
* - badbit
/**
* @brief This is a bitmask type.
*
- * @c "_Ios_Openmode" is implementation-defined, but it is valid to
+ * @c @a _Ios_Openmode is implementation-defined, but it is valid to
* perform bitwise operations on these values and expect the Right
* Thing to happen. Defined objects of type openmode are:
* - app
/**
* @brief This is an enumerated type.
*
- * @c "_Ios_Seekdir" is implementation-defined. Defined values
+ * @c @a _Ios_Seekdir is implementation-defined. Defined values
* of type seekdir are:
* - beg
* - cur, equivalent to @c SEEK_CUR in the C standard library.
* @brief Flags access.
* @return The precision to generate on certain output operations.
*
- * Be careful if you try to give a definition of "precision" here; see
+ * Be careful if you try to give a definition of @a precision here; see
* DR 189.
*/
streamsize
* @brief Flags access.
* @return The minimum field width to generate on output operations.
*
- * "Minimum field width" refers to the number of characters.
+ * <em>Minimum field width</em> refers to the number of characters.
*/
streamsize
width() const
// Locale support -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @brief Default constructor.
*
* Constructs a copy of the global locale. If no locale has been
- * explicitly set, this is the "C" locale.
+ * explicitly set, this is the C locale.
*/
locale() throw();
global(const locale&);
/**
- * @brief Return reference to the "C" locale.
+ * @brief Return reference to the C locale.
*/
static const locale&
classic();
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The "C" locale.
+ * @param cloc The C locale.
* @param refs Passed to the base facet class.
*/
explicit
*
* This function is a wrapper for strxfrm functionality. It takes the
* input string and returns a modified string that can be directly
- * compared to other transformed strings. In the "C" locale, this
+ * compared to other transformed strings. In the C locale, this
* function just returns a copy of the input string. In some other
* locales, it may replace two chars with one, change a char for
* another, etc. It does so by returning collate::do_transform().
// Locale support -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The "C" locale.
+ * @param cloc The C locale.
* @param refs Refcount to pass to the base class.
*/
explicit
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The "C" locale.
+ * @param cloc The C locale.
* @param s The name of a locale.
* @param refs Passed to the base facet class.
*/
* @brief Return preferred order of month, day, and year.
*
* This function returns an enum from timebase::dateorder giving the
- * preferred ordering if the format "x" given to time_put::put() only
- * uses month, day, and year. If the format "x" for the associated
+ * preferred ordering if the format @a x given to time_put::put() only
+ * uses month, day, and year. If the format @a x for the associated
* locale uses other fields, this function returns
* timebase::dateorder::noorder.
*
/**
* @brief Parse input time string.
*
- * This function parses a time according to the format "x" and puts the
+ * This function parses a time according to the format @a x and puts the
* results into a user-supplied struct tm. The result is returned by
* calling time_get::do_get_time().
*
- * If there is a valid time string according to format "x", @a tm will
+ * If there is a valid time string according to format @a x, @a tm will
* be filled in accordingly and the returned iterator will point to the
* first character beyond the time string. If an error occurs before
* the end, err |= ios_base::failbit. If parsing reads all the
/**
* @brief Parse input date string.
*
- * This function parses a date according to the format "X" and puts the
+ * This function parses a date according to the format @a X and puts the
* results into a user-supplied struct tm. The result is returned by
* calling time_get::do_get_date().
*
- * If there is a valid date string according to format "X", @a tm will
+ * If there is a valid date string according to format @a X, @a tm will
* be filled in accordingly and the returned iterator will point to the
* first character beyond the date string. If an error occurs before
* the end, err |= ios_base::failbit. If parsing reads all the
* @brief Return preferred order of month, day, and year.
*
* This function returns an enum from timebase::dateorder giving the
- * preferred ordering if the format "x" given to time_put::put() only
+ * preferred ordering if the format @a x given to time_put::put() only
* uses month, day, and year. This function is a hook for derived
* classes to change the value returned.
*
/**
* @brief Parse input time string.
*
- * This function parses a time according to the format "x" and puts the
+ * This function parses a time according to the format @a x and puts the
* results into a user-supplied struct tm. This function is a hook for
* derived classes to change the value returned. @see get_time() for
* details.
/**
* @brief Parse input date string.
*
- * This function parses a date according to the format "X" and puts the
+ * This function parses a date according to the format @a X and puts the
* results into a user-supplied struct tm. This function is a hook for
* derived classes to change the value returned. @see get_date() for
* details.
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The "C" locale.
+ * @param cloc The C locale.
* @param s The name of a locale.
* @param refs Passed to the base facet class.
*/
* string are required to group a number, the last char is used
* repeatedly.
*
- * For example, if the grouping() returns "\003\002" and is applied to
- * the number 123456789, this corresponds to 12,34,56,789. Note that
- * if the string was "32", this would put more than 50 digits into the
- * least significant group if the character set is ASCII.
+ * For example, if the grouping() returns <code>\003\002</code>
+ * and is applied to the number 123456789, this corresponds to
+ * 12,34,56,789. Note that if the string was <code>32</code>, this would
+ * put more than 50 digits into the least significant group if
+ * the character set is ASCII.
*
* The string is returned by calling
* moneypunct<char_type>::do_grouping().
* present.
*
* For example, for the US locale and pos_format() pattern
- * {symbol,sign,value,none}, curr_symbol() == '$' positive_sign() ==
- * '+', and value 10.01, and options set to force the symbol, the
- * corresponding string is "$+10.01".
+ * {symbol,sign,value,none}, curr_symbol() == '$'
+ * positive_sign() == '+', and value 10.01, and
+ * options set to force the symbol, the corresponding string is
+ * <code>$+10.01</code>.
*
* @return Pattern for money values.
*/
/**
* @brief Read and parse a monetary value.
*
- * This function reads characters from @a s, interprets them as a
- * monetary value according to moneypunct and ctype facets retrieved
- * from io.getloc(), and returns the result in @a digits. For example,
- * the string $10.01 in a US locale would store "1001" in @a digits.
+ * This function reads characters from @a s, interprets them as
+ * a monetary value according to moneypunct and ctype facets
+ * retrieved from io.getloc(), and returns the result in @a
+ * digits. For example, the string $10.01 in a US locale would
+ * store <code>1001</code> in @a digits.
*
* Any characters not part of a valid money amount are not consumed.
*
* This function formats @a units as a monetary value according to
* moneypunct and ctype facets retrieved from io.getloc(), and writes
* the resulting characters to @a s. For example, the value 1001 in a
- * US locale would write "$10.01" to @a s.
+ * US locale would write <code>$10.01</code> to @a s.
*
* This function works by returning the result of do_put().
*
/**
* @brief Format and output a monetary value.
*
- * This function formats @a digits as a monetary value according to
- * moneypunct and ctype facets retrieved from io.getloc(), and writes
- * the resulting characters to @a s. For example, the string "1001" in
- * a US locale would write "$10.01" to @a s.
+ * This function formats @a digits as a monetary value
+ * according to moneypunct and ctype facets retrieved from
+ * io.getloc(), and writes the resulting characters to @a s.
+ * For example, the string <code>1001</code> in a US locale
+ * would write <code>$10.01</code> to @a s.
*
* This function works by returning the result of do_put().
*
* This function formats @a units as a monetary value according to
* moneypunct and ctype facets retrieved from io.getloc(), and writes
* the resulting characters to @a s. For example, the value 1001 in a
- * US locale would write "$10.01" to @a s.
+ * US locale would write <code>$10.01</code> to @a s.
*
* This function is a hook for derived classes to change the value
* returned. @see put().
/**
* @brief Format and output a monetary value.
*
- * This function formats @a digits as a monetary value according to
- * moneypunct and ctype facets retrieved from io.getloc(), and writes
- * the resulting characters to @a s. For example, the string "1001" in
- * a US locale would write "$10.01" to @a s.
+ * This function formats @a digits as a monetary value
+ * according to moneypunct and ctype facets retrieved from
+ * io.getloc(), and writes the resulting characters to @a s.
+ * For example, the string <code>1001</code> in a US locale
+ * would write <code>$10.01</code> to @a s.
*
* This function is a hook for derived classes to change the value
* returned. @see put().
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The "C" locale.
+ * @param cloc The C locale.
* @param s The name of a locale.
* @param refs Refcount to pass to the base class.
*/
* The classic Mersenne Twister.
*
* Reference:
- * M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-Dimensionally
- * Equidistributed Uniform Pseudo-Random Number Generator", ACM Transactions
+ * M. Matsumoto and T. Nishimura, Mersenne Twister: A 623-Dimensionally
+ * Equidistributed Uniform Pseudo-Random Number Generator, ACM Transactions
* on Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3-30.
*/
typedef mersenne_twister_engine<
* is defined.
*
* Reference:
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. X, Sects. 3.3 & 3.4 (+ Errata!).
*/
template<typename _IntType>
* is defined.
*
* Reference:
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. X, Sect. 4 (+ Errata!).
*/
template<typename _IntType>
/**
* Polar method due to Marsaglia.
*
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. V, Sect. 4.4.
*/
template<typename _RealType>
// Algorithm implementation -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @param first An iterator.
* @param last Another iterator.
* @param val The search term.
- * @return An iterator pointing to the first element "not less
- * than" @a val, or end() if every element is less than
+ * @return An iterator pointing to the first element <em>not less
+ * than</em> @a val, or end() if every element is less than
* @a val.
* @ingroup binary_search_algorithms
*/
* @param last Another iterator.
* @param val The search term.
* @param comp A functor to use for comparisons.
- * @return An iterator pointing to the first element "not less than" @a val,
- * or end() if every element is less than @a val.
+ * @return An iterator pointing to the first element <em>not less
+ * than</em> @a val, or end() if every element is less
+ * than @a val.
* @ingroup binary_search_algorithms
*
* The comparison function should have the same effects on ordering as
// max_element
/**
- * @brief Permute range into the next "dictionary" ordering.
+ * @brief Permute range into the next @a dictionary ordering.
* @ingroup sorting_algorithms
* @param first Start of range.
* @param last End of range.
* @return False if wrapped to first permutation, true otherwise.
*
- * Treats all permutations of the range as a set of "dictionary" sorted
+ * Treats all permutations of the range as a set of @a dictionary sorted
* sequences. Permutes the current sequence into the next one of this set.
* Returns true if there are more sequences to generate. If the sequence
* is the largest of the set, the smallest is generated and false returned.
}
/**
- * @brief Permute range into the next "dictionary" ordering using
+ * @brief Permute range into the next @a dictionary ordering using
* comparison functor.
* @ingroup sorting_algorithms
* @param first Start of range.
* @return False if wrapped to first permutation, true otherwise.
*
* Treats all permutations of the range [first,last) as a set of
- * "dictionary" sorted sequences ordered by @a comp. Permutes the current
+ * @a dictionary sorted sequences ordered by @a comp. Permutes the current
* sequence into the next one of this set. Returns true if there are more
* sequences to generate. If the sequence is the largest of the set, the
* smallest is generated and false returned.
}
/**
- * @brief Permute range into the previous "dictionary" ordering.
+ * @brief Permute range into the previous @a dictionary ordering.
* @ingroup sorting_algorithms
* @param first Start of range.
* @param last End of range.
* @return False if wrapped to last permutation, true otherwise.
*
- * Treats all permutations of the range as a set of "dictionary" sorted
+ * Treats all permutations of the range as a set of @a dictionary sorted
* sequences. Permutes the current sequence into the previous one of this
* set. Returns true if there are more sequences to generate. If the
* sequence is the smallest of the set, the largest is generated and false
}
/**
- * @brief Permute range into the previous "dictionary" ordering using
+ * @brief Permute range into the previous @a dictionary ordering using
* comparison functor.
* @ingroup sorting_algorithms
* @param first Start of range.
* @return False if wrapped to last permutation, true otherwise.
*
* Treats all permutations of the range [first,last) as a set of
- * "dictionary" sorted sequences ordered by @a comp. Permutes the current
+ * @a dictionary sorted sequences ordered by @a comp. Permutes the current
* sequence into the previous one of this set. Returns true if there are
* more sequences to generate. If the sequence is the smallest of the set,
* the largest is generated and false returned.
* @param last1 Another iterator.
* @param last2 Another iterator.
* @param result An iterator pointing to the end of the merged range.
- * @return An iterator pointing to the first element "not less
- * than" @a val.
+ * @return An iterator pointing to the first element <em>not less
+ * than</em> @a val.
*
* Merges the ranges [first1,last1) and [first2,last2) into the sorted range
* [result, result + (last1-first1) + (last2-first2)). Both input ranges
}
/**
- * @brief Performs 'dictionary' comparison on ranges.
+ * @brief Performs @b dictionary comparison on ranges.
* @ingroup sorting_algorithms
* @param first1 An input iterator.
* @param last1 An input iterator.
* @param last2 An input iterator.
* @return A boolean true or false.
*
- * 'Returns true if the sequence of elements defined by the range
+ * <em>Returns true if the sequence of elements defined by the range
* [first1,last1) is lexicographically less than the sequence of elements
- * defined by the range [first2,last2). Returns false otherwise.'
+ * defined by the range [first2,last2). Returns false otherwise.</em>
* (Quoted from [25.3.8]/1.) If the iterators are all character pointers,
* then this is an inline call to @c memcmp.
*/
}
/**
- * @brief Performs "dictionary" comparison on ranges.
+ * @brief Performs @b dictionary comparison on ranges.
* @ingroup sorting_algorithms
* @param first1 An input iterator.
* @param last1 An input iterator.
* @param size The size of an element.
* @return The number (not byte size) of elements per node.
*
- * This function started off as a compiler kludge from SGI, but seems to
- * be a useful wrapper around a repeated constant expression. The '512' is
- * tunable (and no other code needs to change), but no investigation has
- * been done since inheriting the SGI code. Touch _GLIBCXX_DEQUE_BUF_SIZE
- * only if you know what you are doing, however: changing it breaks the
- * binary compatibility!!
+ * This function started off as a compiler kludge from SGI, but
+ * seems to be a useful wrapper around a repeated constant
+ * expression. The @b 512 is tunable (and no other code needs to
+ * change), but no investigation has been done since inheriting the
+ * SGI code. Touch _GLIBCXX_DEQUE_BUF_SIZE only if you know what
+ * you are doing, however: changing it breaks the binary
+ * compatibility!!
*/
#ifndef _GLIBCXX_DEQUE_BUF_SIZE
* - iterator _M_start, _M_finish
*
* map_size is at least 8. %map is an array of map_size
- * pointers-to-"nodes". (The name %map has nothing to do with the
- * std::map class, and "nodes" should not be confused with
- * std::list's usage of "node".)
+ * pointers-to-@anodes. (The name %map has nothing to do with the
+ * std::map class, and @b nodes should not be confused with
+ * std::list's usage of @a node.)
*
- * A "node" has no specific type name as such, but it is referred
- * to as "node" in this file. It is a simple array-of-Tp. If Tp
+ * A @a node has no specific type name as such, but it is referred
+ * to as @a node in this file. It is a simple array-of-Tp. If Tp
* is very large, there will be one Tp element per node (i.e., an
- * "array" of one). For non-huge Tp's, node size is inversely
+ * @a array of one). For non-huge Tp's, node size is inversely
* related to Tp size: the larger the Tp, the fewer Tp's will fit
* in a node. The goal here is to keep the total size of a node
* relatively small and constant over different Tp's, to improve
* will be unused. This same situation will arise as the %map
* grows: available %map pointers, if any, will be on the ends. As
* new nodes are created, only a subset of the %map's pointers need
- * to be copied "outward".
+ * to be copied @a outward.
*
* Class invariants:
* - For any nonsingular iterator i:
* node if and only if the pointer is in the range
* [start.node, finish.node].
*
- * Here's the magic: nothing in deque is "aware" of the discontiguous
+ * Here's the magic: nothing in deque is @b aware of the discontiguous
* storage!
*
* The memory setup and layout occurs in the parent, _Base, and the iterator
- * class is entirely responsible for "leaping" from one node to the next.
+ * class is entirely responsible for @a leaping from one node to the next.
* All the implementation routines for deque itself work only through the
* start and finish iterators. This keeps the routines simple and sane,
* and we can use other standard algorithms as well.
*
* This function will insert copies of the data in the
* initializer_list @a l into the %deque before the location
- * specified by @a p. This is known as "list insert."
+ * specified by @a p. This is known as <em>list insert</em>.
*/
void
insert(iterator __p, initializer_list<value_type> __l)
*
* This function will insert copies of the data in the range
* [first,last) into the %deque before the location specified
- * by @a pos. This is known as "range insert."
+ * by @a pos. This is known as <em>range insert</em>.
*/
template<typename _InputIterator>
void
// Functor implementations -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* templates and used in place of a function pointer. Not only is the
* resulting expressiveness of the library increased, but the generated
* code can be more efficient than what you might write by hand. When we
- * refer to "functors," then, generally we include function pointers in
+ * refer to @a functors, then, generally we include function pointers in
* the description as well.
*
* Often, functors are only created as temporaries passed to algorithm
* std::find_if (v.begin(), v.end(), not1(IntGreaterThanThree()));
* \endcode
* The call to @c find_if will locate the first index (i) of @c v for which
- * "!(v[i] > 3)" is true.
+ * <code>!(v[i] > 3)</code> is true.
*
* The not1/unary_negate combination works on predicates taking a single
* argument. The not2/binary_negate combination works on predicates which
// Iterators -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* &*(reverse_iterator(i)) == &*(i - 1)
* @endcode
*
- * This mapping is dictated by the fact that while there is always a
+ * <em>This mapping is dictated by the fact that while there is always a
* pointer past the end of an array, there might not be a valid pointer
- * before the beginning of an array.' [24.4.1]/1,2
+ * before the beginning of an array.</em> [24.4.1]/1,2
*
* Reverse iterators can be tricky and surprising at first. Their
* semantics make sense, however, and the trickiness is a side effect of
* reference-to-const T for container<T>.
* @return This %iterator, for chained operations.
*
- * This kind of %iterator doesn't really have a "position" in the
+ * This kind of %iterator doesn't really have a @a position in the
* container (you can think of the position as being permanently at
* the end, if you like). Assigning a value to the %iterator will
* always append the value to the end of the container.
operator*()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
back_insert_iterator&
operator++()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
back_insert_iterator
operator++(int)
{ return *this; }
* reference-to-const T for container<T>.
* @return This %iterator, for chained operations.
*
- * This kind of %iterator doesn't really have a "position" in the
+ * This kind of %iterator doesn't really have a @a position in the
* container (you can think of the position as being permanently at
* the front, if you like). Assigning a value to the %iterator will
* always prepend the value to the front of the container.
operator*()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
front_insert_iterator&
operator++()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
front_insert_iterator
operator++(int)
{ return *this; }
operator*()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
insert_iterator&
operator++()
{ return *this; }
- /// Simply returns *this. (This %iterator does not "move".)
+ /// Simply returns *this. (This %iterator does not @a move.)
insert_iterator&
operator++(int)
{ return *this; }
_GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
- // This iterator adapter is 'normal' in the sense that it does not
+ // This iterator adapter is @a normal in the sense that it does not
// change the semantics of any of the operators of its iterator
// parameter. Its primary purpose is to convert an iterator that is
// not a class, e.g. a pointer, into an iterator that is a class.
// Functions used by iterators -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/**
* @brief A generalization of pointer arithmetic.
* @param i An input iterator.
- * @param n The "delta" by which to change @p i.
+ * @param n The @a delta by which to change @p i.
* @return Nothing.
*
* This increments @p i by @p n. For bidirectional and random access
// Types used in iterator implementation -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @brief Traits class for iterators.
*
* This class does nothing but define nested typedefs. The general
- * version simply "forwards" the nested typedefs from the Iterator
+ * version simply @a forwards the nested typedefs from the Iterator
* argument. Specialized versions for pointers and pointers-to-const
* provide tighter, more correct semantics.
*/
*
* See
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
- * for more on "hinting".
+ * for more on @a hinting.
*
* Insertion requires logarithmic time (if the hint is not taken).
*/
* improve the performance of the insertion process. A bad hint would
* cause no gains in efficiency.
*
- * For more on "hinting," see:
+ * For more on @a hinting, see:
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
*
* Insertion requires logarithmic time (if the hint is not taken).
* cause no gains in efficiency.
*
* See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
- * for more on "hinting".
+ * for more on @a hinting.
*
* Insertion requires logarithmic time (if the hint is not taken).
*/
{ return _M_t._M_insert_equal_(__position, __x); }
/**
- * @brief A template function that attempts to insert a range of elements.
+ * @brief A template function that tries to insert a range of elements.
* @param first Iterator pointing to the start of the range to be
* inserted.
* @param last Iterator pointing to the end of the range.
* that supports @c front, @c back, @c push_back, and @c pop_front,
* such as std::list or an appropriate user-defined type.
*
- * Members not found in "normal" containers are @c container_type,
+ * Members not found in @a normal containers are @c container_type,
* which is a typedef for the second Sequence parameter, and @c push and
* @c pop, which are standard %queue/FIFO operations.
*/
* priority comparisons. It defaults to @c less<value_type> but
* can be anything defining a strict weak ordering.
*
- * Members not found in "normal" containers are @c container_type,
+ * Members not found in @a normal containers are @c container_type,
* which is a typedef for the second Sequence parameter, and @c
* push, @c pop, and @c top, which are standard %queue operations.
*
* potentially improve the performance of the insertion process. A bad
* hint would cause no gains in efficiency.
*
- * For more on "hinting", see:
+ * For more on @a hinting, see:
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt07ch17.html
*
* Insertion requires logarithmic time (if the hint is not taken).
// Stack implementation -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* such as std::list, std::vector, or an appropriate user-defined
* type.
*
- * Members not found in "normal" containers are @c container_type,
+ * Members not found in @a normal containers are @c container_type,
* which is a typedef for the second Sequence parameter, and @c
* push, @c pop, and @c top, which are standard %stack/FILO
* operations.
// Temporary buffer implementation -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
*
* This function tries to obtain storage for @c len adjacent Tp
* objects. The objects themselves are not constructed, of course.
- * A pair<> is returned containing 'the buffer s address and
+ * A pair<> is returned containing <em>the buffer s address and
* capacity (in the units of sizeof(Tp)), or a pair of 0 values if
- * no storage can be obtained.' Note that the capacity obtained
+ * no storage can be obtained.</em> Note that the capacity obtained
* may be less than that requested if the memory is unavailable;
* you should compare len with the .second return value.
*
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file cassert
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c assert.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cctype
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c ctype.h,
* and its contents are (mostly) the same as that header, but are all
// The -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file cerrno
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c errno.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cfloat
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c float.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2009, 2010
+// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file ciso646
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c iso646.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/climits
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c limits.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file clocale
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c locale.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- C forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cmath
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c math.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file csetjmp
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c setjmp.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file csignal
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c signal.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cstdarg
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdarg.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file cstddef
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stddef.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cstdio
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdio.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cstdlib
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdlib.h,
* and its contents are (mostly) the same as that header, but are all
/** @file cstring
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c string.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/ctime
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c time.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cwchar
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c wchar.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cwctype
* This is a Standard C++ Library file. You should @c \#include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c wctype.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file cassert
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c assert.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cctype
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c ctype.h,
* and its contents are (mostly) the same as that header, but are all
// The -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file cerrno
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c errno.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cfloat
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c float.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2009, 2010
+// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file ciso646
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c iso646.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/climits
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c limits.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file clocale
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c locale.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- C forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cmath
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c math.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file csetjmp
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c setjmp.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file csignal
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c signal.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cstdarg
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdarg.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file cstddef
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stddef.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cstdio
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdio.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cstdlib
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c stdlib.h,
* and its contents are (mostly) the same as that header, but are all
/** @file cstring
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c string.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/ctime
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c time.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2009
+// 2006, 2007, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/** @file include/cwchar
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c wchar.h,
* and its contents are (mostly) the same as that header, but are all
// -*- C++ -*- forwarding header.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2009 Free Software Foundation, Inc.
+// 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** @file include/cwctype
* This is a Standard C++ Library file. You should @c #include this file
- * in your programs, rather than any of the "*.h" implementation files.
+ * in your programs, rather than any of the @a *.h implementation files.
*
* This is the C++ version of the Standard C Library header @c wctype.h,
* and its contents are (mostly) the same as that header, but are all
// Debugging support implementation -*- C++ -*-
-// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* Macros used by the implementation to verify certain
* properties. These macros may only be used directly by the debug
* wrappers. Note that these are macros (instead of the more obviously
- * "correct" choice of making them functions) because we need line and
+ * @a correct choice of making them functions) because we need line and
* file information at the call site, to minimize the distance between
* the user error and where the error is reported.
*
// Safe sequence/iterator base implementation -*- C++ -*-
-// Copyright (C) 2003, 2004, 2005, 2006, 2009
+// Copyright (C) 2003, 2004, 2005, 2006, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
{
class _Safe_sequence_base;
- /** \brief Basic functionality for a "safe" iterator.
+ /** \brief Basic functionality for a @a safe iterator.
*
* The %_Safe_iterator_base base class implements the functionality
* of a safe iterator that is not specific to a particular iterator
* invalidation of all iterators that reference the container.
*
* This class must ensure that no operation on it may throw an
- * exception, otherwise "safe" sequences may fail to provide the
+ * exception, otherwise @a safe sequences may fail to provide the
* exception-safety guarantees required by the C++ standard.
*/
class _Safe_sequence_base
// Safe sequence implementation -*- C++ -*-
-// Copyright (C) 2003, 2004, 2005, 2006, 2009
+// Copyright (C) 2003, 2004, 2005, 2006, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
};
/**
- * @brief Base class for constructing a "safe" sequence type that
+ * @brief Base class for constructing a @a safe sequence type that
* tracks iterators that reference it.
*
* The class template %_Safe_sequence simplifies the construction of
- * "safe" sequences that track the iterators that reference the
+ * @a safe sequences that track the iterators that reference the
* sequence, so that the iterators are notified of changes in the
* sequence that may affect their operation, e.g., if the container
* invalidates its iterators or is destructed. This class template
// Algorithm extensions -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @return An int, as with @c memcmp.
*
* The return value will be less than zero if the first range is
- * "lexigraphically less than" the second, greater than zero if the second
- * range is "lexigraphically less than" the first, and zero otherwise.
+ * <em>lexigraphically less than</em> the second, greater than zero
+ * if the second range is <em>lexigraphically less than</em> the
+ * first, and zero otherwise.
* This is an SGI extension.
* @ingroup SGIextensions
*/
* @c operator()s
* take a @c std::pair as an argument, and return either the first member
* or the second member, respectively. They can be used (especially with
- * the composition functors) to "strip" data from a sequence before
+ * the composition functors) to @a strip data from a sequence before
* performing the remainder of an algorithm.
*
* @addtogroup SGIextensions
* - @c constant_binary_fun's @c operator() takes two arguments (ignored)
*
* The helper creator functions @c constant0, @c constant1, and
- * @c constant2 each take a "result" argument and construct variables of
+ * @c constant2 each take a @a result argument and construct variables of
* the appropriate functor type.
*
* @addtogroup SGIextensions
// MT-optimized allocator -*- C++ -*-
-// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
/**
* @brief This is a fixed size (power of 2) allocator which - when
* compiled with thread support - will maintain one freelist per
- * size per thread plus a "global" one. Steps are taken to limit
+ * size per thread plus a @a global one. Steps are taken to limit
* the per thread freelist sizes (by returning excess back to
- * the "global" list).
+ * the @a global list).
* @ingroup allocators
*
* Further details:
* Contains an implementation class for bin_search_tree_.
*/
/*
- * This implementation uses an idea from the SGI STL (using a "header" node
+ * This implementation uses an idea from the SGI STL (using a @a header node
* which is needed for efficient iteration).
*/
/**
* This implementation loosely borrows ideas from:
- * 1) "Fast Mergeable Integer Maps", Okasaki, Gill 1998
- * 2) "Ptset: Sets of integers implemented as Patricia trees",
+ * 1) Fast Mergeable Integer Maps, Okasaki, Gill 1998
+ * 2) Ptset: Sets of integers implemented as Patricia trees,
* Jean-Christophe Filliatr, 2000
**/
* Contains an implementation for rb_tree_.
*/
/*
- * This implementation uses an idea from the SGI STL (using a "header" node
+ * This implementation uses an idea from the SGI STL (using a @a header node
* which is needed for efficient iteration).
*/
* Contains an implementation class for splay_tree_.
*/
/*
- * This implementation uses an idea from the SGI STL (using a "header" node
+ * This implementation uses an idea from the SGI STL (using a @a header node
* which is needed for efficient iteration). Following is the SGI STL
* copyright.
*
/**
* @file type_utils.hpp
* Contains utilities for handnling types. All of these classes are based on
- * "Modern C++" by Andrei Alxandrescu.
+ * Modern C++ by Andrei Alxandrescu.
*/
#ifndef PB_DS_TYPE_UTILS_HPP
* This approach has the enormous advantage that a string object
* requires only one allocation. All the ugliness is confined
* within a single pair of inline functions, which each compile to
- * a single "add" instruction: _Rep::_M_refdata(), and
+ * a single @a add instruction: _Rep::_M_refdata(), and
* __rc_string_base::_M_rep(); and the allocation function which gets a
* block of raw bytes and with room enough and constructs a _Rep
* object at the front.
* string length.)
*
* Note that the _Rep object is a POD so that you can have a
- * static "empty string" _Rep object already "constructed" before
+ * static <em>empty string</em> _Rep object already @a constructed before
* static constructors have run. The reference-count encoding is
* chosen so that a 0 indicates one reference, so you never try to
* destroy the empty-string _Rep object.
// Iostreams wrapper for stdio FILE* -*- C++ -*-
-// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010
+// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/**
* @return The underlying FILE*.
*
- * This function can be used to access the underlying "C" file pointer.
+ * This function can be used to access the underlying C file pointer.
* Note that there is no way for the library to track what you do
* with the file, so be careful.
*/
{ this->_M_clear(); }
/**
- * Returns true if the %string is empty. Equivalent to *this == "".
+ * Returns true if the %string is empty. Equivalent to
+ * <code>*this == ""</code>.
*/
bool
empty() const
* the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
- * NB: s must have at least n2 characters, '\\0' has no special
+ * NB: s must have at least n2 characters, <em>\\0</em> has no special
* meaning.
*/
int
* @param __str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from is into @a __str until '\n' is found, the
- * end of the stream is encountered, or str.max_size() is reached.
- * If is.width() is non-zero, that is the limit on the number of
- * characters stored into @a __str. Any previous contents of @a
- * __str are erased. If end of line was encountered, it is
- * extracted but not stored into @a __str.
+ * Stores characters from is into @a __str until '\n' is
+ * found, the end of the stream is encountered, or str.max_size()
+ * is reached. If is.width() is non-zero, that is the limit on the
+ * number of characters stored into @a __str. Any previous
+ * contents of @a __str are erased. If end of line was
+ * encountered, it is extracted but not stored into @a __str.
*/
template<typename _CharT, typename _Traits, typename _Alloc,
template <typename, typename, typename> class _Base>
// -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
* @param __end End iterator of input sequence.
* @param __user_op A user-specified functor (comparator, predicate,
* associative operator,...)
- * @param __functionality functor to "process" an element with
+ * @param __functionality functor to @a process an element with
* __user_op (depends on desired functionality, e. g. accumulate,
* for_each,...
* @param __reduction Reduction functor.
// -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
*
* This works well for merging up to 4 sequences.
*
- * Note that making the merging stable does <em>not</em> come at a
+ * Note that making the merging stable does @a not come at a
* performance hit.
*
* Whether the merging is done guarded or unguarded is selected by the
*
* This works well for merging up to 4 sequences.
*
- * Note that making the merging stable does <em>not</em> come at a
+ * Note that making the merging stable does @a not come at a
* performance hit.
*
* Whether the merging is done guarded or unguarded is selected by the
// -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
* @param __end End iterator of element sequence.
* @param __o User-supplied functor (comparator, predicate, adding
* functor, etc.).
- * @param __f Functor to "process" an element with __op (depends on
+ * @param __f Functor to @a process an element with __op (depends on
* desired functionality, e. g. for std::for_each(), ...).
- * @param __r Functor to "add" a single __result to the already
+ * @param __r Functor to @a add a single __result to the already
* processed elements (depends on functionality).
* @param __base Base value for reduction.
* @param __output Pointer to position where final result is written to
// -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
* @param __end End iterator of element sequence.
* @param __o User-supplied functor (comparator, predicate, adding
* functor, ...).
- * @param __f Functor to "process" an element with __op (depends on
+ * @param __f Functor to @a process an element with __op (depends on
* desired functionality, e. g. for std::for_each(), ...).
- * @param __r Functor to "add" a single __result to the already processed
+ * @param __r Functor to @a add a single __result to the already processed
* __elements (depends on functionality).
* @param __base Base value for reduction.
* @param __output Pointer to position where final result is written to
// -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
* @param __end End iterator of element sequence.
* @param __op User-supplied functor (comparator, predicate, adding
* functor, ...).
- * @param __f Functor to "process" an element with __op (depends on
+ * @param __f Functor to @a process an element with __op (depends on
* desired functionality, e. g. for std::for_each(), ...).
- * @param __r Functor to "add" a single __result to the already
+ * @param __r Functor to @a add a single __result to the already
* processed elements (depends on functionality).
* @param __base Base value for reduction.
* @param __output Pointer to position where final result is written to
// -*- C++ -*-
//
-// Copyright (C) 2009 Free Software Foundation, Inc.
+// Copyright (C) 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
}
}
-/** @brief Final report method, registered with "atexit".
+/** @brief Final report method, registered with @b atexit.
*
* This can also be called directly by user code, including signal handlers.
* It is protected against deadlocks by the reentrance guard in profiler.h.
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
-/** @file profile/literator_tracker.h
+/** @file profile/iterator_tracker.h
* This file is a GNU profile extension to the Standard C++ Library.
*/
// <bitset> -*- C++ -*-
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* the high-order bits in the highest word.) It is a class invariant
* that those unused bits are always zero.
*
- * If you think of %bitset as "a simple array of bits," be aware that
- * your mental picture is reversed: a %bitset behaves the same way as
- * bits in integers do, with the bit at index 0 in the "least significant
- * / right-hand" position, and the bit at index Nb-1 in the "most
- * significant / left-hand" position. Thus, unlike other containers, a
- * %bitset's index "counts from right to left," to put it very loosely.
+ * If you think of %bitset as <em>a simple array of bits</em>, be
+ * aware that your mental picture is reversed: a %bitset behaves
+ * the same way as bits in integers do, with the bit at index 0 in
+ * the <em>least significant / right-hand</em> position, and the bit at
+ * index Nb-1 in the <em>most significant / left-hand</em> position.
+ * Thus, unlike other containers, a %bitset's index <em>counts from
+ * right to left</em>, to put it very loosely.
*
* This behavior is preserved when translating to and from strings. For
* example, the first line of the following program probably prints
- * "b('a') is 0001100001" on a modern ASCII system.
+ * <em>b('a') is 0001100001</em> on a modern ASCII system.
*
* @code
* #include <bitset>
* to and from bool are automatic and should be transparent. Overloaded
* operators help to preserve the illusion.
*
- * (On a typical system, this "bit %reference" is 64 times the size of
- * an actual bit. Ha.)
+ * (On a typical system, this <em>bit %reference</em> is 64
+ * times the size of an actual bit. Ha.)
*/
class reference
{
/**
* @brief Use a subset of a string.
- * @param s A string of '0' and '1' characters.
+ * @param s A string of @a 0 and @a 1 characters.
* @param position Index of the first character in @a s to use;
* defaults to zero.
* @throw std::out_of_range If @a pos is bigger the size of @a s.
* @throw std::invalid_argument If a character appears in the string
- * which is neither '0' nor '1'.
+ * which is neither @a 0 nor @a 1.
*/
template<class _CharT, class _Traits, class _Alloc>
explicit
/**
* @brief Use a subset of a string.
- * @param s A string of '0' and '1' characters.
+ * @param s A string of @a 0 and @a 1 characters.
* @param position Index of the first character in @a s to use.
* @param n The number of characters to copy.
* @throw std::out_of_range If @a pos is bigger the size of @a s.
* @throw std::invalid_argument If a character appears in the string
- * which is neither '0' nor '1'.
+ * which is neither @a 0 nor @a 1.
*/
template<class _CharT, class _Traits, class _Alloc>
bitset(const std::basic_string<_CharT, _Traits, _Alloc>& __s,
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Construct from a string.
- * @param str A string of '0' and '1' characters.
+ * @param str A string of @a 0 and @a 1 characters.
* @throw std::invalid_argument If a character appears in the string
- * which is neither '0' nor '1'.
+ * which is neither @a 0 nor @a 1.
*/
explicit
bitset(const char* __str)
/**
* @brief Array-indexing support.
* @param position Index into the %bitset.
- * @return A bool for a 'const %bitset'. For non-const bitsets, an
+ * @return A bool for a <em>const %bitset</em>. For non-const bitsets, an
* instance of the reference proxy class.
* @note These operators do no range checking and throw no exceptions,
* as required by DR 11 to the standard.
* @brief Global I/O operators for bitsets.
*
* Direct I/O between streams and bitsets is supported. Output is
- * straightforward. Input will skip whitespace, only accept '0' and '1'
+ * straightforward. Input will skip whitespace, only accept @a 0 and @a 1
* characters, and will only extract as many digits as the %bitset will
* hold.
*/
// File based streams -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
bool _M_buf_allocated;
/**
- * _M_reading == false && _M_writing == false for 'uncommitted' mode;
- * _M_reading == true for 'read' mode;
- * _M_writing == true for 'write' mode;
+ * _M_reading == false && _M_writing == false for @b uncommitted mode;
+ * _M_reading == true for @b read mode;
+ * _M_writing == true for @b write mode;
*
* NB: _M_reading == true && _M_writing == true is unused.
*/
* | ios_base Flag combination stdio equivalent |
* |binary in out trunc app |
* +---------------------------------------------------------+
- * | + "w" |
- * | + + "a" |
- * | + "a" |
- * | + + "w" |
- * | + "r" |
- * | + + "r+" |
- * | + + + "w+" |
- * | + + + "a+" |
- * | + + "a+" |
+ * | + w |
+ * | + + a |
+ * | + a |
+ * | + + w |
+ * | + r |
+ * | + + r+ |
+ * | + + + w+ |
+ * | + + + a+ |
+ * | + + a+ |
* +---------------------------------------------------------+
- * | + + "wb" |
- * | + + + "ab" |
- * | + + "ab" |
- * | + + + "wb" |
- * | + + "rb" |
- * | + + + "r+b" |
- * | + + + + "w+b" |
- * | + + + + "a+b" |
- * | + + + "a+b" |
+ * | + + wb |
+ * | + + + ab |
+ * | + + ab |
+ * | + + + wb |
+ * | + + rb |
+ * | + + + r+b |
+ * | + + + + w+b |
+ * | + + + + a+b |
+ * | + + + a+b |
* +---------------------------------------------------------+
*/
__filebuf_type*
*
* If no file is currently open, this function immediately fails.
*
- * If a "put buffer area" exists, @c overflow(eof) is called to flush
- * all the characters. The file is then closed.
+ * If a <em>put buffer area</em> exists, @c overflow(eof) is
+ * called to flush all the characters. The file is then
+ * closed.
*
* If any operations fail, this function also fails.
*/
* This function sets the pointers of the internal buffer, both get
* and put areas. Typically:
*
- * __off == egptr() - eback() upon underflow/uflow ('read' mode);
- * __off == 0 upon overflow ('write' mode);
- * __off == -1 upon open, setbuf, seekoff/pos ('uncommitted' mode).
+ * __off == egptr() - eback() upon underflow/uflow (@b read mode);
+ * __off == 0 upon overflow (@b write mode);
+ * __off == -1 upon open, setbuf, seekoff/pos (@b uncommitted mode).
*
* NB: epptr() - pbase() == _M_buf_size - 1, since _M_buf_size
* reflects the actual allocated memory and the last cell is reserved
// Forwarding declarations -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2009
+// 2006, 2007, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* should not do it yourself. Instead, include the <iosfwd>
* header, which contains only declarations of all the I/O classes as
* well as the typedefs. Trying to forward-declare the typedefs
- * themselves (e.g., "class ostream;") is not valid ISO C++.
+ * themselves (e.g., <code>class ostream;</code>) is not valid ISO C++.
*
* For more specific declarations, see
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch24.html
// Standard iostream objects -*- C++ -*-
-// Copyright (C) 1997, 1998, 1999, 2001, 2002, 2005, 2008, 2009
+// Copyright (C) 1997, 1998, 1999, 2001, 2002, 2005, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch24.html
* and the @link iosfwd I/O forward declarations @endlink
*
- * They are required by default to cooperate with the global C library's
- * @c FILE streams, and to be available during program startup and
- * termination. For more information, see the HOWTO linked to above.
+ * They are required by default to cooperate with the global C
+ * library's @c FILE streams, and to be available during program
+ * startup and termination. For more information, see the HOWTO
+ * linked to above.
*/
//@{
extern istream cin; ///< Linked to standard input
// Input streams -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @brief Interface for manipulators.
*
* Manipulators such as @c std::ws and @c std::dec use these
- * functions in constructs like "std::cin >> std::ws". For more
- * information, see the iomanip header.
+ * functions in constructs like
+ * <code>std::cin >> std::ws</code>.
+ * For more information, see the iomanip header.
*/
__istream_type&
operator>>(__istream_type& (*__pf)(__istream_type&))
* @param n Maximum number of characters to store in @a s.
* @return *this
*
- * Returns @c get(s,n,widen('\n')).
+ * Returns @c get(s,n,widen('\n')).
*/
__istream_type&
get(char_type* __s, streamsize __n)
* @param sb A streambuf in which to store data.
* @return *this
*
- * Returns @c get(sb,widen('\n')).
+ * Returns @c get(sb,widen('\n')).
*/
__istream_type&
get(__streambuf_type& __sb)
* @param n Maximum number of characters to extract.
* @return *this
*
- * Returns @c getline(s,n,widen('\n')).
+ * Returns @c getline(s,n,widen('\n')).
*/
__istream_type&
getline(char_type* __s, streamsize __n)
* @brief Performs setup work for input streams.
*
* Objects of this class are created before all of the standard
- * extractors are run. It is responsible for "exception-safe prefix and
- * suffix operations," although only prefix actions are currently required
- * by the standard.
+ * extractors are run. It is responsible for <em>exception-safe
+ * prefix and suffix operations,</em> although only prefix actions
+ * are currently required by the standard.
*/
template<typename _CharT, typename _Traits>
class basic_istream<_CharT, _Traits>::sentry
* @param noskipws Whether to consume whitespace or not.
*
* If the stream state is good (@a is.good() is true), then the
- * following actions are performed, otherwise the sentry state is
- * false ("not okay") and failbit is set in the stream state.
+ * following actions are performed, otherwise the sentry state
+ * is false (<em>not okay</em>) and failbit is set in the
+ * stream state.
*
* The sentry's preparatory actions are:
*
* used to determine whether each character is whitespace.
*
* If the stream state is still good, then the sentry state becomes
- * true ("okay").
+ * true (@a okay).
*/
explicit
sentry(basic_istream<_CharT, _Traits>& __is, bool __noskipws = false);
* status, this function extracts up to @c n characters and stores them
* into the array starting at @a s. @c n is defined as:
*
- * - if @c width() is greater than zero, @c n is width()
- * - otherwise @c n is "the number of elements of the largest array of
- * @c char_type that can store a terminating @c eos." [27.6.1.2.3]/6
+ * - if @c width() is greater than zero, @c n is width() otherwise
+ * - @c n is <em>the number of elements of the largest array of *
+ * - @c char_type that can store a terminating @c eos.</em>
+ * - [27.6.1.2.3]/6
*
* Characters are extracted and stored until one of the following happens:
* - @c n-1 characters are stored
// The template and inlines for the numeric_limits classes. -*- C++ -*-
// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-// 2008, 2009 Free Software Foundation, Inc.
+// 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
/** True if the type is signed. */
static const bool is_signed = false;
/** True if the type is integer.
- * Is this supposed to be "if the type is integral"?
+ * Is this supposed to be <em>if the type is integral?</em>
*/
static const bool is_integer = false;
- /** True if the type uses an exact representation. 'All integer types are
+ /** True if the type uses an exact representation. <em>All integer types are
exact, but not all exact types are integer. For example, rational and
- fixed-exponent representations are exact but not integer.'
+ fixed-exponent representations are exact but not integer.</em>
[18.2.1.2]/15 */
static const bool is_exact = false;
/** For integer types, specifies the base of the representation. For
/** True if the type has a representation for positive infinity. */
static const bool has_infinity = false;
/** True if the type has a representation for a quiet (non-signaling)
- 'Not a Number.' */
+ <em>Not a Number</em>. */
static const bool has_quiet_NaN = false;
/** True if the type has a representation for a signaling
- 'Not a Number.' */
+ <em>Not a Number</em>. */
static const bool has_signaling_NaN = false;
/** See std::float_denorm_style for more information. */
static const float_denorm_style has_denorm = denorm_absent;
- /** 'True if loss of accuracy is detected as a denormalization loss,
- rather than as an inexact result.' [18.2.1.2]/42 */
+ /** <em>True if loss of accuracy is detected as a denormalization loss,
+ rather than as an inexact result.</em> [18.2.1.2]/42 */
static const bool has_denorm_loss = false;
/** True if-and-only-if the type adheres to the IEC 559 standard, also
known as IEEE 754. (Only makes sense for floating point types.) */
static const bool is_iec559 = false;
- /** 'True if the set of values representable by the type is finite. All
- built-in types are bounded, this member would be false for arbitrary
- precision types.' [18.2.1.2]/54 */
+ /** <em>True if the set of values representable by the type is
+ finite. All built-in types are bounded, this member would be
+ false for arbitrary precision types.</em> [18.2.1.2]/54 */
static const bool is_bounded = false;
/** True if the type is @e modulo, that is, if it is possible to add two
positive numbers and have a result that wraps around to a third number
static _Tp round_error() throw() { return static_cast<_Tp>(0); }
/** The representation of positive infinity, if @c has_infinity. */
static _Tp infinity() throw() { return static_cast<_Tp>(0); }
- /** The representation of a quiet "Not a Number," if @c has_quiet_NaN. */
+
+ /** The representation of a quiet <em>Not a Number</em>,
+ if @c has_quiet_NaN. */
static _Tp quiet_NaN() throw() { return static_cast<_Tp>(0); }
- /** The representation of a signaling "Not a Number," if
+ /** The representation of a signaling <em>Not a Number</em>, if
@c has_signaling_NaN. */
static _Tp signaling_NaN() throw() { return static_cast<_Tp>(0); }
/** The minimum positive denormalized value. For types where
// Output streams -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009
+// 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* @brief Performs setup work for output streams.
*
* Objects of this class are created before all of the standard
- * inserters are run. It is responsible for "exception-safe prefix and
- * suffix operations."
+ * inserters are run. It is responsible for <em>exception-safe prefix and
+ * suffix operations</em>.
*/
template <typename _CharT, typename _Traits>
class basic_ostream<_CharT, _Traits>::sentry
* is called to synchronize the output sequences.
*
* If the stream state is still good, then the sentry state becomes
- * true ("okay").
+ * true (@a okay).
*/
explicit
sentry(basic_ostream<_CharT, _Traits>& __os);
/**
* @brief Write a null character into the output sequence.
*
- * "Null character" is @c CharT() by definition. For CharT of @c char,
+ * <em>Null character</em> is @c CharT() by definition. For CharT of @c char,
* this correctly writes the ASCII @c NUL character string terminator.
*/
template<typename _CharT, typename _Traits>
// String based streams -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2008, 2009 Free Software Foundation, Inc.
+// 2006, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* @brief Copying out the string buffer.
* @return A copy of one of the underlying sequences.
*
- * 'If the buffer is only created in input mode, the underlying
+ * <em>If the buffer is only created in input mode, the underlying
* character sequence is equal to the input sequence; otherwise, it
- * is equal to the output sequence.' [27.7.1.2]/1
+ * is equal to the output sequence.</em> [27.7.1.2]/1
*/
__string_type
str() const
// Stream buffer classes -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+// 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* represents, at any moment, a (sub)sequence of characters from the
* sequence. Operations performed on a sequence alter the values
* stored in these pointers, perform reads and writes directly to or
- * from associated sequences, and alter "the stream position" and
+ * from associated sequences, and alter <em>the stream position</em> and
* conversion state as needed to maintain this subsequence relationship.
* The three pointers are:
* - the <em>beginning pointer</em>, or lowest element address in the
* @param c The character to push back.
* @return The previous character, if possible.
*
- * Similar to sungetc(), but @a c is pushed onto the stream instead
- * of 'the previous character.' If successful, the next character
- * fetched from the input stream will be @a c.
+ * Similar to sungetc(), but @a c is pushed onto the stream
+ * instead of <em>the previous character.</em> If successful,
+ * the next character fetched from the input stream will be @a
+ * c.
*/
int_type
sputbackc(char_type __c)
* @brief Moving backwards in the input stream.
* @return The previous character, if possible.
*
- * If a putback position is available, this function decrements the
- * input pointer and returns that character. Otherwise, calls and
- * returns pbackfail(). The effect is to 'unget' the last character
- * 'gotten.'
+ * If a putback position is available, this function decrements
+ * the input pointer and returns that character. Otherwise,
+ * calls and returns pbackfail(). The effect is to @a unget
+ * the last character @a gotten.
*/
int_type
sungetc()
* @brief Changes translations.
* @param loc A new locale.
*
- * Translations done during I/O which depend on the current locale
- * are changed by this call. The standard adds, 'Between invocations
- * of this function a class derived from streambuf can safely cache
- * results of calls to locale functions and to members of facets
- * so obtained.'
+ * Translations done during I/O which depend on the current
+ * locale are changed by this call. The standard adds,
+ * <em>Between invocations of this function a class derived
+ * from streambuf can safely cache results of calls to locale
+ * functions and to members of facets so obtained.</em>
*
* @note Base class version does nothing.
*/
* @return -1 on failure.
*
* Each derived class provides its own appropriate behavior,
- * including the definition of "failure".
+ * including the definition of @a failure.
* @note Base class version does nothing, returns zero.
*/
virtual int
* @return An estimate of the number of characters available in the
* input sequence, or -1.
*
- * 'If it returns a positive value, then successive calls to
- * @c underflow() will not return @c traits::eof() until at least that
- * number of characters have been supplied. If @c showmanyc()
- * returns -1, then calls to @c underflow() or @c uflow() will fail.'
- * [27.5.2.4.3]/1
+ * <em>If it returns a positive value, then successive calls to
+ * @c underflow() will not return @c traits::eof() until at
+ * least that number of characters have been supplied. If @c
+ * showmanyc() returns -1, then calls to @c underflow() or @c
+ * uflow() will fail.</em> [27.5.2.4.3]/1
*
* @note Base class version does nothing, returns zero.
- * @note The standard adds that 'the intention is not only that the
+ * @note The standard adds that <em>the intention is not only that the
* calls [to underflow or uflow] will not return @c eof() but
- * that they will return immediately.'
- * @note The standard adds that 'the morphemes of @c showmanyc are
- * 'es-how-many-see', not 'show-manic'.'
+ * that they will return immediately.</em>
+ * @note The standard adds that <em>the morphemes of @c showmanyc are
+ * @b es-how-many-see, not @b show-manic.</em>
*/
virtual streamsize
showmanyc() { return 0; }
*
* Informally, this function is called when the input buffer is
* exhausted (or does not exist, as buffering need not actually be
- * done). If a buffer exists, it is 'refilled'. In either case, the
+ * done). If a buffer exists, it is @a refilled. In either case, the
* next available character is returned, or @c traits::eof() to
* indicate a null pending sequence.
*
/**
* @brief Tries to back up the input sequence.
* @param c The character to be inserted back into the sequence.
- * @return eof() on failure, 'some other value' on success
+ * @return eof() on failure, <em>some other value</em> on success
* @post The constraints of @c gptr(), @c eback(), and @c pptr()
* are the same as for @c underflow().
*
* @return eof() to indicate failure, something else (usually
* @a c, or not_eof())
*
- * Informally, this function is called when the output buffer is full
- * (or does not exist, as buffering need not actually be done). If a
- * buffer exists, it is 'consumed', with 'some effect' on the
- * controlled sequence. (Typically, the buffer is written out to the
- * sequence verbatim.) In either case, the character @a c is also
+ * Informally, this function is called when the output buffer
+ * is full (or does not exist, as buffering need not actually
+ * be done). If a buffer exists, it is @a consumed, with
+ * <em>some effect</em> on the controlled sequence.
+ * (Typically, the buffer is written out to the sequence
+ * verbatim.) In either case, the character @a c is also
* written out, if @a c is not @c eof().
*
* For a formal definition of this function, see a good text
// TR1 functional header -*- C++ -*-
-// Copyright (C) 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010
+// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
struct _M_clear_type;
/**
- * Trait identifying "location-invariant" types, meaning that the
+ * Trait identifying @a location-invariant types, meaning that the
* address of the object (or any of its members) will not escape.
* Also implies a trivial copy constructor and assignment operator.
*/
// Special functions -*- C++ -*-
-// Copyright (C) 2006, 2007, 2008, 2009
+// Copyright (C) 2006, 2007, 2008, 2009, 2010
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
* \frac{x^n}{n!}
* @f]
*
- * If a and b are integers and a < 0 and either b > 0 or b < a then the
- * series is a polynomial with a finite number of terms. If b is an integer
- * and b <= 0 the confluent hypergeometric function is undefined.
+ * If a and b are integers and a < 0 and either b > 0 or b < a
+ * then the series is a polynomial with a finite number of
+ * terms. If b is an integer and b <= 0 the confluent
+ * hypergeometric function is undefined.
*
* @param __a The "numerator" parameter.
* @param __c The "denominator" parameter.
*
* @todo Handle b == nonpositive integer blowup - return NaN.
*
- * @param __a The "numerator" parameter.
- * @param __c The "denominator" parameter.
+ * @param __a The @a numerator parameter.
+ * @param __c The @a denominator parameter.
* @param __x The argument of the confluent hypergeometric function.
* @return The confluent hypergeometric function.
*/
*
* This works and it's pretty fast.
*
- * @param __a The first "numerator" parameter.
- * @param __a The second "numerator" parameter.
- * @param __c The "denominator" parameter.
+ * @param __a The first @a numerator parameter.
+ * @param __a The second @a numerator parameter.
+ * @param __c The @a denominator parameter.
* @param __x The argument of the confluent hypergeometric function.
* @return The confluent hypergeometric function.
*/
/**
- * @brief Return the hypogeometric function @f$ _2F_1(a,b;c;x) @f$ by the reflection
- * formulae in Abramowitz & Stegun formula 15.3.6 for d = c - a - b not integral
- * and formula 15.3.11 for d = c - a - b integral.
- * This assumes a, b, c != negative integer.
+ * @brief Return the hypogeometric function @f$ _2F_1(a,b;c;x) @f$
+ * by the reflection formulae in Abramowitz & Stegun formula
+ * 15.3.6 for d = c - a - b not integral and formula 15.3.11 for
+ * d = c - a - b integral. This assumes a, b, c != negative
+ * integer.
*
* The hypogeometric function is defined by
* @f[
}
if (__ln_pre1 > __log_max)
- std::__throw_runtime_error(__N("Overflow of gamma functions "
- "in __hyperg_luke."));
+ std::__throw_runtime_error(__N("Overflow of gamma functions"
+ " in __hyperg_luke."));
else
__F1 = std::exp(__ln_pre1) * __sum1;
}
int __j;
for (__j = 1; __j < __maxiter; ++__j)
{
- // Values for psi functions use recurrence; Abramowitz & Stegun 6.3.5
+ // Values for psi functions use recurrence;
+ // Abramowitz & Stegun 6.3.5
const _Tp __term1 = _Tp(1) / _Tp(__j)
+ _Tp(1) / (__ad + __j);
const _Tp __term2 = _Tp(1) / (__a + __d1 + _Tp(__j - 1))
* \frac{x^n}{n!}
* @f]
*
- * @param __a The first "numerator" parameter.
- * @param __a The second "numerator" parameter.
- * @param __c The "denominator" parameter.
+ * @param __a The first @a numerator parameter.
+ * @param __a The second @a numerator parameter.
+ * @param __c The @a denominator parameter.
* @param __x The argument of the confluent hypergeometric function.
* @return The confluent hypergeometric function.
*/
return __hyperg_series(__a, __b, __c, __x);
else if (std::abs(__a) < _Tp(10) && std::abs(__b) < _Tp(10))
{
- // For integer a and b the hypergeometric function is a finite polynomial.
+ // For integer a and b the hypergeometric function is a
+ // finite polynomial.
if (__a < _Tp(0) && std::abs(__a - __a_nint) < __toler)
return __hyperg_series(__a_nint, __b, __c, __x);
else if (__b < _Tp(0) && std::abs(__b - __b_nint) < __toler)
// random number generation -*- C++ -*-
-// Copyright (C) 2009 Free Software Foundation, Inc.
+// Copyright (C) 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* The classic Mersenne Twister.
*
* Reference:
- * M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-Dimensionally
- * Equidistributed Uniform Pseudo-Random Number Generator", ACM Transactions
+ * M. Matsumoto and T. Nishimura, Mersenne Twister: A 623-Dimensionally
+ * Equidistributed Uniform Pseudo-Random Number Generator, ACM Transactions
* on Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3-30.
*/
typedef mersenne_twister<
* The size of the state is @f$ r @f$
* and the maximum period of the generator is @f$ m^r - m^s -1 @f$.
*
- * N1688[4.13] says "the template parameter _IntType shall denote an integral
- * type large enough to store values up to m."
+ * N1688[4.13] says <em>the template parameter _IntType shall denote
+ * an integral type large enough to store values up to m</em>.
*
* @var _M_x The state of the generator. This is a ring buffer.
* @var _M_carry The carry.
// random number generation (out of line) -*- C++ -*-
-// Copyright (C) 2009 Free Software Foundation, Inc.
+// Copyright (C) 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* is defined.
*
* Reference:
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. X, Sects. 3.3 & 3.4 (+ Errata!).
*/
template<typename _IntType, typename _RealType>
* is defined.
*
* Reference:
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. X, Sect. 4 (+ Errata!).
*/
template<typename _IntType, typename _RealType>
/**
* Polar method due to Marsaglia.
*
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. V, Sect. 4.4.
*/
template<typename _RealType>
* alpha < 1.
*
* References:
- * Cheng, R. C. "The Generation of Gamma Random Variables with Non-integral
- * Shape Parameter." Applied Statistics, 26, 71-75, 1977.
+ * Cheng, R. C. The Generation of Gamma Random Variables with Non-integral
+ * Shape Parameter. Applied Statistics, 26, 71-75, 1977.
*
- * Vaduva, I. "Computer Generation of Gamma Gandom Variables by Rejection
- * and Composition Procedures." Math. Operationsforschung and Statistik,
+ * Vaduva, I. Computer Generation of Gamma Gandom Variables by Rejection
+ * and Composition Procedures. Math. Operationsforschung and Statistik,
* Series in Statistics, 8, 545-576, 1977.
*
- * Devroye, L. "Non-Uniform Random Variates Generation." Springer-Verlag,
+ * Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag,
* New York, 1986, Ch. IX, Sect. 3.4 (+ Errata!).
*/
template<typename _RealType>
// class template regex -*- C++ -*-
-// Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
* Format strings (from ECMA-262 [15.5.4.11]):
* @li $$ The dollar-sign itself ($)
* @li $& The matched substring.
- * @li $` The portion of <em>string</em> that precedes the matched substring.
+ * @li $` The portion of @a string that precedes the matched substring.
* This would be match_results::prefix().
- * @li $' The portion of <em>string</em> that follows the matched substring.
+ * @li $' The portion of @a string that follows the matched substring.
* This would be match_results::suffix().
* @li $n The nth capture, where n is in [1,9] and $n is not followed by a
* decimal digit. If n <= match_results::size() and the nth capture
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1576 }
+// { dg-error "no matching" "" { target *-*-* } 1577 }
// { dg-excess-errors "" }
#include <deque>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1515 }
+// { dg-error "no matching" "" { target *-*-* } 1516 }
// { dg-excess-errors "" }
#include <deque>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1515 }
+// { dg-error "no matching" "" { target *-*-* } 1516 }
// { dg-excess-errors "" }
#include <deque>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1660 }
+// { dg-error "no matching" "" { target *-*-* } 1661 }
// { dg-excess-errors "" }
#include <deque>
projects / thirdparty / gcc.git / commitdiff
