+2011-08-06 Benjamin Kosnik <bkoz@redhat.com>
+
+ * doc/doxygen/user.cfg.in (PDF_HYPERLINKS): To NO.
+
+2011-08-06 Benjamin Kosnik <bkoz@redhat.com>
+
+ * doc/doxygen/user.cfg.in: Add scoped_allocator.
+
+ * include/debug/safe_sequence.h: Fix doxygen markup.
+ * include/debug/safe_unordered_base.h: Same.
+ * include/debug/safe_local_iterator.tcc: Same.
+ * include/debug/safe_unordered_container.h: Same.
+ * include/std/valarray: Same.
+ * include/std/iomanip: Same.
+ * include/std/streambuf: Same.
+ * include/std/bitset: Same.
+ * include/std/fstream: Same.
+ * include/std/functional: Same.
+ * include/std/istream: Same.
+ * include/std/ostream: Same.
+ * include/std/scoped_allocator: Same.
+ * include/std/sstream: Same.
+ * include/parallel/multiway_merge.h: Same.
+ * include/parallel/base.h: Same.
+ * include/parallel/for_each_selectors.h: Same.
+ * include/parallel/multiway_mergesort.h: Same.
+ * include/parallel/search.h: Same.
+ * include/parallel/partial_sum.h: Same.
+ * include/parallel/queue.h: Same.
+ * include/parallel/sort.h: Same.
+ * include/parallel/random_number.h: Same.
+ * include/ext/vstring.h: Same.
+ * include/ext/algorithm: Same.
+ * include/ext/pb_ds/assoc_container.h: Same.
+ * include/ext/bitmap_allocator.h: Same.
+ * include/ext/stdio_filebuf.h: Same.
+ * include/ext/memory: Same.
+ * include/ext/functional: Same.
+ * include/bits/basic_ios.h: Same.
+ * include/bits/stl_list.h: Same.
+ * include/bits/stl_map.h: Same.
+ * include/bits/stl_algobase.h: Same.
+ * include/bits/stl_queue.h: Same.
+ * include/bits/gslice.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_heap.h: Same.
+ * include/bits/forward_list.h: Same.
+ * include/bits/stream_iterator.h: Same.
+ * include/bits/basic_string.h: Same.
+ * include/bits/stl_multimap.h: Same.
+ * include/bits/stl_pair.h: Same.
+ * include/bits/ios_base.h: Same.
+ * include/bits/stl_numeric.h: Same.
+ * include/bits/stl_vector.h: Same.
+ * include/bits/stl_deque.h: Same.
+ * include/bits/codecvt.h: Same.
+ * include/bits/stl_multiset.h: Same.
+ * include/bits/stl_uninitialized.h: Same.
+ * include/bits/ptr_traits.h: Same.
+ * include/bits/slice_array.h: Same.
+ * include/bits/stl_iterator_base_funcs.h: Same.
+ * include/bits/stl_algo.h: Same.
+ * include/bits/stl_iterator.h: Same.
+ * include/bits/stl_tempbuf.h: Same.
+ * include/bits/regex.h: Same.
+ * include/bits/range_access.h: Same.
+ * include/bits/random.h: Same.
+ * include/bits/alloc_traits.h: Same.
+ * include/bits/regex_error.h: Same.
+ * include/bits/locale_facets_nonio.h: Same.
+ * include/bits/stl_relops.h: Same.
+ * include/backward/auto_ptr.h: Same.
+ * libsupc++/initializer_list: Same.
+
+ * testsuite/23_containers/list/requirements/dr438/assign_neg.cc:
+ Adjust line numbers.
+ * testsuite/23_containers/list/requirements/dr438/insert_neg.cc: Same.
+ * testsuite/23_containers/list/requirements/dr438/constructor_1_neg.cc:
+ Same.
+ * testsuite/23_containers/list/requirements/dr438/constructor_2_neg.cc:
+ Same.
+
2011-08-05 Rainer Orth <ro@CeBiTec.Uni-Bielefeld.DE>
* acinclude.m4 (GLIBCXX_EXPORT_INCLUDES): Point TOPLEVEL_INCLUDES
include/random \
include/ratio \
include/regex \
+ include/scoped_allocator \
include/set \
include/sstream \
include/stack \
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
-PDF_HYPERLINKS = YES
+PDF_HYPERLINKS = NO
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
/**
* @brief An %auto_ptr is usually constructed from a raw pointer.
- * @param p A pointer (defaults to NULL).
+ * @param __p A pointer (defaults to NULL).
*
- * This object now @e owns the object pointed to by @a p.
+ * This object now @e owns the object pointed to by @a __p.
*/
explicit
auto_ptr(element_type* __p = 0) throw() : _M_ptr(__p) { }
/**
* @brief An %auto_ptr can be constructed from another %auto_ptr.
- * @param a Another %auto_ptr of the same type.
+ * @param __a Another %auto_ptr of the same type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership.
*/
auto_ptr(auto_ptr& __a) throw() : _M_ptr(__a.release()) { }
/**
* @brief An %auto_ptr can be constructed from another %auto_ptr.
- * @param a Another %auto_ptr of a different but related type.
+ * @param __a Another %auto_ptr of a different but related type.
*
* A pointer-to-Tp1 must be convertible to a
* pointer-to-Tp/element_type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership.
*/
template<typename _Tp1>
/**
* @brief %auto_ptr assignment operator.
- * @param a Another %auto_ptr of the same type.
+ * @param __a Another %auto_ptr of the same type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership. The object that this one @e
* used to own and track has been deleted.
*/
/**
* @brief %auto_ptr assignment operator.
- * @param a Another %auto_ptr of a different but related type.
+ * @param __a Another %auto_ptr of a different but related type.
*
* A pointer-to-Tp1 must be convertible to a pointer-to-Tp/element_type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership. The object that this one @e
* used to own and track has been deleted.
*/
/**
* @brief Forcibly deletes the managed object.
- * @param p A pointer (defaults to NULL).
+ * @param __p A pointer (defaults to NULL).
*
- * This object now @e owns the object pointed to by @a p. The
+ * This object now @e owns the object pointed to by @a __p. The
* previous object has been deleted.
*/
void
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
+/** @file bits/alloc_traits.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{scoped_allocator}
+ */
+
#ifndef _ALLOC_TRAITS_H
#define _ALLOC_TRAITS_H 1
/**
* @brief Allocate memory.
- * @param a An allocator.
- * @param n The number of objects to allocate space for.
+ * @param __a An allocator.
+ * @param __n The number of objects to allocate space for.
*
* Calls @c a.allocate(n)
*/
/**
* @brief Allocate memory.
- * @param a An allocator.
- * @param n The number of objects to allocate space for.
- * @param hint Aid to locality.
+ * @param __a An allocator.
+ * @param __n The number of objects to allocate space for.
+ * @param __hint Aid to locality.
* @return Memory of suitable size and alignment for @a n objects
* of type @c value_type
*
/**
* @brief Deallocate memory.
- * @param a An allocator.
- * @param p Pointer to the memory to deallocate.
- * @param n The number of objects space was allocated for.
+ * @param __a An allocator.
+ * @param __p Pointer to the memory to deallocate.
+ * @param __n The number of objects space was allocated for.
*
* Calls <tt> a.deallocate(p, n) </tt>
*/
{ __a.deallocate(__p, __n); }
/**
- * @brief Construct an object of type @a Tp
- * @param a An allocator.
- * @param p Pointer to memory of suitable size and alignment for Tp
- * @param args Constructor arguments.
+ * @brief Construct an object of type @a _Tp
+ * @param __a An allocator.
+ * @param __p Pointer to memory of suitable size and alignment for Tp
+ * @param __args Constructor arguments.
*
- * Calls <tt> a.construct(p, std::forward<Args>(args)...) </tt>
+ * Calls <tt> __a.construct(__p, std::forward<Args>(__args)...) </tt>
* if that expression is well-formed, otherwise uses placement-new
- * to construct an object of type @a Tp at location @a p from the
- * arguments @a args...
+ * to construct an object of type @a _Tp at location @a __p from the
+ * arguments @a __args...
*/
template<typename _Tp, typename... _Args>
static void construct(_Alloc& __a, _Tp* __p, _Args&&... __args)
{ _S_construct(__a, __p, std::forward<_Args>(__args)...); }
/**
- * @brief Destroy an object of type @a Tp
- * @param a An allocator.
- * @param p Pointer to the object to destroy
+ * @brief Destroy an object of type @a _Tp
+ * @param __a An allocator.
+ * @param __p Pointer to the object to destroy
*
- * Calls @c a.destroy(p) if that expression is well-formed,
- * otherwise calls @c p->~Tp()
+ * Calls @c __a.destroy(__p) if that expression is well-formed,
+ * otherwise calls @c __p->~_Tp()
*/
template <class _Tp>
static void destroy(_Alloc& __a, _Tp* __p)
/**
* @brief The maximum supported allocation size
- * @param a An allocator.
- * @return @c a.max_size() or @c numeric_limits<size_type>::max()
+ * @param __a An allocator.
+ * @return @c __a.max_size() or @c numeric_limits<size_type>::max()
*
- * Returns @c a.max_size() if that expression is well-formed,
+ * Returns @c __a.max_size() if that expression is well-formed,
* otherwise returns @c numeric_limits<size_type>::max()
*/
static size_type max_size(const _Alloc& __a)
/**
* @brief Obtain an allocator to use when copying a container.
- * @param rhs An allocator.
- * @return @c rhs.select_on_container_copy_construction() or @a rhs
+ * @param __rhs An allocator.
+ * @return @c __rhs.select_on_container_copy_construction() or @a __rhs
*
- * Returns @c rhs.select_on_container_copy_construction() if that
- * expression is well-formed, otherwise returns @a rhs
+ * Returns @c __rhs.select_on_container_copy_construction() if that
+ * expression is well-formed, otherwise returns @a __rhs
*/
static _Alloc
select_on_container_copy_construction(const _Alloc& __rhs)
/**
* @brief [Re]sets the error state.
- * @param state The new state flag(s) to set.
+ * @param __state The new state flag(s) to set.
*
* See std::ios_base::iostate for the possible bit values. Most
* users will not need to pass an argument.
/**
* @brief Sets additional flags in the error state.
- * @param state The additional state flag(s) to set.
+ * @param __state The additional state flag(s) to set.
*
* See std::ios_base::iostate for the possible bit values.
*/
/**
* @brief Throwing exceptions on errors.
- * @param except The new exceptions mask.
+ * @param __except The new exceptions mask.
*
* By default, error flags are set silently. You can set an
* exceptions mask for each stream; if a bit in the mask becomes set
/**
* @brief Ties this stream to an output stream.
- * @param tiestr The output stream.
+ * @param __tiestr The output stream.
* @return The previously tied output stream, or NULL if the stream
* was not tied.
*
/**
* @brief Changing the underlying buffer.
- * @param sb The new stream buffer.
+ * @param __sb The new stream buffer.
* @return The previous stream buffer.
*
* Associates a new buffer with the current stream, and clears the
/**
* @brief Sets a new @a empty character.
- * @param ch The new character.
+ * @param __ch The new character.
* @return The previous fill character.
*
* The fill character is used to fill out space when P+ characters
// Locales:
/**
* @brief Moves to a new locale.
- * @param loc The new locale.
+ * @param __loc The new locale.
* @return The previous locale.
*
* Calls @c ios_base::imbue(loc), and if a stream buffer is associated
/**
* @brief Squeezes characters.
- * @param c The character to narrow.
- * @param dfault The character to narrow.
+ * @param __c The character to narrow.
+ * @param __dfault The character to narrow.
* @return The narrowed character.
*
* Maps a character of @c char_type to a character of @c char,
/**
* @brief Widens characters.
- * @param c The character to widen.
+ * @param __c The character to widen.
* @return The widened character.
*
* Maps a character of @c char to a character of @c char_type.
// NB: per LWG issue 42, semantics different from IS:
/**
* @brief Construct string with copy of value of @a str.
- * @param str Source string.
+ * @param __str Source string.
*/
basic_string(const basic_string& __str);
/**
* @brief Construct string as copy of a substring.
- * @param str Source string.
- * @param pos Index of first character to copy from.
- * @param n Number of characters to copy (default remainder).
+ * @param __str Source string.
+ * @param __pos Index of first character to copy from.
+ * @param __n Number of characters to copy (default remainder).
*/
basic_string(const basic_string& __str, size_type __pos,
size_type __n = npos);
/**
* @brief Construct string as copy of a substring.
- * @param str Source string.
- * @param pos Index of first character to copy from.
- * @param n Number of characters to copy.
- * @param a Allocator to use.
+ * @param __str Source string.
+ * @param __pos Index of first character to copy from.
+ * @param __n Number of characters to copy.
+ * @param __a Allocator to use.
*/
basic_string(const basic_string& __str, size_type __pos,
size_type __n, const _Alloc& __a);
/**
* @brief Construct string initialized by a character %array.
- * @param s Source character %array.
- * @param n Number of characters to copy.
- * @param a Allocator to use (default is default allocator).
+ * @param __s Source character %array.
+ * @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'
+ * 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());
/**
* @brief Construct string as copy of a C string.
- * @param s Source C string.
- * @param a Allocator to use (default is default allocator).
+ * @param __s Source C string.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(const _CharT* __s, const _Alloc& __a = _Alloc());
/**
* @brief Construct string as multiple characters.
- * @param n Number of characters.
- * @param c Character to use.
- * @param a Allocator to use (default is default allocator).
+ * @param __n Number of characters.
+ * @param __c Character to use.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc());
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Move construct string.
- * @param str Source string.
+ * @param __str Source string.
*
- * The newly-created string contains the exact contents of @a str.
- * @a str is a valid, but unspecified string.
+ * The newly-created string contains the exact contents of @a __str.
+ * @a __str is a valid, but unspecified string.
**/
basic_string(basic_string&& __str) noexcept
: _M_dataplus(__str._M_dataplus)
/**
* @brief Construct string from an initializer %list.
- * @param l std::initializer_list of characters.
- * @param a Allocator to use (default is default allocator).
+ * @param __l std::initializer_list of characters.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(initializer_list<_CharT> __l, const _Alloc& __a = _Alloc());
#endif // __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Construct string as copy of a range.
- * @param beg Start of range.
- * @param end End of range.
- * @param a Allocator to use (default is default allocator).
+ * @param __beg Start of range.
+ * @param __end End of range.
+ * @param __a Allocator to use (default is default allocator).
*/
template<class _InputIterator>
basic_string(_InputIterator __beg, _InputIterator __end,
/**
* @brief Assign the value of @a str to this string.
- * @param str Source string.
+ * @param __str Source string.
*/
basic_string&
operator=(const basic_string& __str)
/**
* @brief Copy contents of @a s into this string.
- * @param s Source null-terminated string.
+ * @param __s Source null-terminated string.
*/
basic_string&
operator=(const _CharT* __s)
/**
* @brief Set value to string of length 1.
- * @param c Source character.
+ * @param __c Source character.
*
* Assigning to a character makes this string length 1 and
* (*this)[0] == @a c.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Move assign the value of @a str to this string.
- * @param str Source string.
+ * @param __str Source string.
*
* The contents of @a str are moved into this string (without copying).
* @a str is a valid, but unspecified string.
/**
* @brief Set value to string constructed from initializer %list.
- * @param l std::initializer_list.
+ * @param __l std::initializer_list.
*/
basic_string&
operator=(initializer_list<_CharT> __l)
/**
* @brief Resizes the %string to the specified number of characters.
- * @param n Number of characters the %string should contain.
- * @param c Character to fill any new elements.
+ * @param __n Number of characters the %string should contain.
+ * @param __c Character to fill any new elements.
*
* This function will %resize the %string to the specified
* number of characters. If the number is smaller than the
* %string's current size the %string is truncated, otherwise
- * the %string is extended and new elements are %set to @a c.
+ * the %string is extended and new elements are %set to @a __c.
*/
void
resize(size_type __n, _CharT __c);
/**
* @brief Resizes the %string to the specified number of characters.
- * @param n Number of characters the %string should contain.
+ * @param __n Number of characters the %string should contain.
*
* This function will resize the %string to the specified length. If
* the new size is smaller than the %string's current size the %string
/**
* @brief Attempt to preallocate enough memory for specified number of
* characters.
- * @param res_arg Number of characters required.
- * @throw std::length_error If @a res_arg exceeds @c max_size().
+ * @param __res_arg Number of characters required.
+ * @throw std::length_error If @a __res_arg exceeds @c max_size().
*
* This function attempts to reserve enough memory for the
* %string to hold the specified number of characters. If the
// Element access:
/**
* @brief Subscript access to the data contained in the %string.
- * @param pos The index of the character to access.
+ * @param __pos The index of the character to access.
* @return Read-only (constant) reference to the character.
*
* This operator allows for easy, array-style, data access.
/**
* @brief Subscript access to the data contained in the %string.
- * @param pos The index of the character to access.
+ * @param __pos The index of the character to access.
* @return Read/write reference to the character.
*
* This operator allows for easy, array-style, data access.
/**
* @brief Provides access to the data contained in the %string.
- * @param n The index of the character to access.
+ * @param __n The index of the character to access.
* @return Read-only (const) reference to the character.
* @throw std::out_of_range If @a n is an invalid index.
*
/**
* @brief Provides access to the data contained in the %string.
- * @param n The index of the character to access.
+ * @param __n The index of the character to access.
* @return Read/write reference to the character.
* @throw std::out_of_range If @a n is an invalid index.
*
// Modifiers:
/**
* @brief Append a string to this string.
- * @param str The string to append.
+ * @param __str The string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a C string.
- * @param s The C string to append.
+ * @param __s The C string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a character.
- * @param c The character to append.
+ * @param __c The character to append.
* @return Reference to this string.
*/
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Append an initializer_list of characters.
- * @param l The initializer_list of characters to be appended.
+ * @param __l The initializer_list of characters to be appended.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a string to this string.
- * @param str The string to append.
+ * @param __str The string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a substring.
- * @param str The string to append.
- * @param pos Index of the first character of str to append.
- * @param n The number of characters to append.
+ * @param __str The string to append.
+ * @param __pos Index of the first character of str to append.
+ * @param __n The number of characters to append.
* @return Reference to this string.
- * @throw std::out_of_range if @a pos is not a valid index.
+ * @throw std::out_of_range if @a __pos is not a valid index.
*
- * This function appends @a n characters from @a str starting at @a pos
- * to this string. If @a n is is larger than the number of available
- * characters in @a str, the remainder of @a str is appended.
+ * This function appends @a __n characters from @a __str
+ * starting at @a __pos to this string. If @a __n is is larger
+ * than the number of available characters in @a __str, the
+ * remainder of @a __str is appended.
*/
basic_string&
append(const basic_string& __str, size_type __pos, size_type __n);
/**
* @brief Append a C substring.
- * @param s The C string to append.
- * @param n The number of characters to append.
+ * @param __s The C string to append.
+ * @param __n The number of characters to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a C string.
- * @param s The C string to append.
+ * @param __s The C string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append multiple characters.
- * @param n The number of characters to append.
- * @param c The character to use.
+ * @param __n The number of characters to append.
+ * @param __c The character to use.
* @return Reference to this string.
*
- * Appends n copies of c to this string.
+ * Appends __n copies of __c to this string.
*/
basic_string&
append(size_type __n, _CharT __c);
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Append an initializer_list of characters.
- * @param l The initializer_list of characters to append.
+ * @param __l The initializer_list of characters to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a range of characters.
- * @param first Iterator referencing the first character to append.
- * @param last Iterator marking the end of the range.
+ * @param __first Iterator referencing the first character to append.
+ * @param __last Iterator marking the end of the range.
* @return Reference to this string.
*
- * Appends characters in the range [first,last) to this string.
+ * Appends characters in the range [__first,__last) to this string.
*/
template<class _InputIterator>
basic_string&
/**
* @brief Append a single character.
- * @param c Character to append.
+ * @param __c Character to append.
*/
void
push_back(_CharT __c)
/**
* @brief Set value to contents of another string.
- * @param str Source string to use.
+ * @param __str Source string to use.
* @return Reference to this string.
*/
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Set value to contents of another string.
- * @param str Source string to use.
+ * @param __str Source string to use.
* @return Reference to this string.
*
- * This function sets this string to the exact contents of @a str.
- * @a str is a valid, but unspecified string.
+ * This function sets this string to the exact contents of @a __str.
+ * @a __str is a valid, but unspecified string.
*/
basic_string&
assign(basic_string&& __str)
/**
* @brief Set value to a substring of a string.
- * @param str The string to use.
- * @param pos Index of the first character of str.
- * @param n Number of characters to use.
+ * @param __str The string to use.
+ * @param __pos Index of the first character of str.
+ * @param __n Number of characters to use.
* @return Reference to this string.
* @throw std::out_of_range if @a pos is not a valid index.
*
- * This function sets this string to the substring of @a str consisting
- * of @a n characters at @a pos. If @a n is is larger than the number
- * of available characters in @a str, the remainder of @a str is used.
+ * This function sets this string to the substring of @a __str
+ * consisting of @a __n characters at @a __pos. If @a __n is
+ * is larger than the number of available characters in @a
+ * __str, the remainder of @a __str is used.
*/
basic_string&
assign(const basic_string& __str, size_type __pos, size_type __n)
/**
* @brief Set value to a C substring.
- * @param s The C string to use.
- * @param n Number of characters to use.
+ * @param __s The C string to use.
+ * @param __n Number of characters to use.
* @return Reference to this string.
*
- * This function sets the value of this string to the first @a n
- * characters of @a s. If @a n is is larger than the number of
- * available characters in @a s, the remainder of @a s is used.
+ * This function sets the value of this string to the first @a __n
+ * characters of @a __s. If @a __n is is larger than the number of
+ * available characters in @a __s, the remainder of @a __s is used.
*/
basic_string&
assign(const _CharT* __s, size_type __n);
/**
* @brief Set value to contents of a C string.
- * @param s The C string to use.
+ * @param __s The C string to use.
* @return Reference to this string.
*
- * This function sets the value of this string to the value of @a s.
- * The data is copied, so there is no dependence on @a s once the
+ * This function sets the value of this string to the value of @a __s.
+ * The data is copied, so there is no dependence on @a __s once the
* function returns.
*/
basic_string&
/**
* @brief Set value to multiple characters.
- * @param n Length of the resulting string.
- * @param c The character to use.
+ * @param __n Length of the resulting string.
+ * @param __c The character to use.
* @return Reference to this string.
*
- * This function sets the value of this string to @a n copies of
- * character @a c.
+ * This function sets the value of this string to @a __n copies of
+ * character @a __c.
*/
basic_string&
assign(size_type __n, _CharT __c)
/**
* @brief Set value to a range of characters.
- * @param first Iterator referencing the first character to append.
- * @param last Iterator marking the end of the range.
+ * @param __first Iterator referencing the first character to append.
+ * @param __last Iterator marking the end of the range.
* @return Reference to this string.
*
- * Sets value of string to characters in the range [first,last).
+ * Sets value of string to characters in the range [__first,__last).
*/
template<class _InputIterator>
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Set value to an initializer_list of characters.
- * @param l The initializer_list of characters to assign.
+ * @param __l The initializer_list of characters to assign.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Insert multiple characters.
- * @param p Iterator referencing location in string to insert at.
- * @param n Number of characters to insert
- * @param c The character to insert.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __n Number of characters to insert
+ * @param __c The character to insert.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts @a n copies of character @a c starting at the position
- * referenced by iterator @a p. If adding characters causes the length
- * to exceed max_size(), length_error is thrown. The value of the
- * string doesn't change if an error is thrown.
+ * Inserts @a __n copies of character @a __c starting at the
+ * position referenced by iterator @a __p. If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
void
insert(iterator __p, size_type __n, _CharT __c)
/**
* @brief Insert a range of characters.
- * @param p Iterator referencing location in string to insert at.
- * @param beg Start of range.
- * @param end End of range.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __beg Start of range.
+ * @param __end End of range.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts characters in range [beg,end). If adding characters causes
- * the length to exceed max_size(), length_error is thrown. The value
- * of the string doesn't change if an error is thrown.
+ * Inserts characters in range [__beg,__end). If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
template<class _InputIterator>
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Insert an initializer_list of characters.
- * @param p Iterator referencing location in string to insert at.
- * @param l The initializer_list of characters to insert.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __l The initializer_list of characters to insert.
* @throw std::length_error If new length exceeds @c max_size().
*/
void
/**
* @brief Insert value of a string.
- * @param pos1 Iterator referencing location in string to insert at.
- * @param str The string to insert.
+ * @param __pos1 Iterator referencing location in string to insert at.
+ * @param __str The string to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts value of @a str starting at @a pos1. If adding characters
- * causes the length to exceed max_size(), length_error is thrown. The
- * value of the string doesn't change if an error is thrown.
+ * Inserts value of @a __str starting at @a __pos1. If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
insert(size_type __pos1, const basic_string& __str)
/**
* @brief Insert a substring.
- * @param pos1 Iterator referencing location in string to insert at.
- * @param str The string to insert.
- * @param pos2 Start of characters in str to insert.
- * @param n Number of characters to insert.
+ * @param __pos1 Iterator referencing location in string to insert at.
+ * @param __str The string to insert.
+ * @param __pos2 Start of characters in str to insert.
+ * @param __n Number of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
* @throw std::out_of_range If @a pos1 > size() or
- * @a pos2 > @a str.size().
+ * @a __pos2 > @a str.size().
*
- * Starting at @a pos1, insert @a n character of @a str beginning with
- * @a pos2. If adding characters causes the length to exceed
- * max_size(), length_error is thrown. If @a pos1 is beyond the end of
- * this string or @a pos2 is beyond the end of @a str, out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Starting at @a pos1, insert @a __n character of @a __str
+ * beginning with @a __pos2. If adding characters causes the
+ * length to exceed max_size(), length_error is thrown. If @a
+ * __pos1 is beyond the end of this string or @a __pos2 is
+ * beyond the end of @a __str, out_of_range is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
insert(size_type __pos1, const basic_string& __str,
/**
* @brief Insert a C substring.
- * @param pos Iterator referencing location in string to insert at.
- * @param s The C string to insert.
- * @param n The number of characters to insert.
+ * @param __pos Iterator referencing location in string to insert at.
+ * @param __s The C string to insert.
+ * @param __n The number of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
- * @throw std::out_of_range If @a pos is beyond the end of this
+ * @throw std::out_of_range If @a __pos is beyond the end of this
* string.
*
- * Inserts the first @a n characters of @a s starting at @a pos. If
- * adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos is beyond end(), out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Inserts the first @a __n characters of @a __s starting at @a
+ * __pos. If adding characters causes the length to exceed
+ * max_size(), length_error is thrown. If @a __pos is beyond
+ * end(), out_of_range is thrown. The value of the string
+ * doesn't change if an error is thrown.
*/
basic_string&
insert(size_type __pos, const _CharT* __s, size_type __n);
/**
* @brief Insert a C string.
- * @param pos Iterator referencing location in string to insert at.
- * @param s The C string to insert.
+ * @param __pos Iterator referencing location in string to insert at.
+ * @param __s The C string to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
*
- * Inserts the first @a n characters of @a s starting at @a pos. If
+ * Inserts the first @a n characters of @a __s starting at @a __pos. If
* adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos is beyond end(), out_of_range is
+ * length_error is thrown. If @a __pos is beyond end(), out_of_range is
* thrown. The value of the string doesn't change if an error is
* thrown.
*/
/**
* @brief Insert multiple characters.
- * @param pos Index in string to insert at.
- * @param n Number of characters to insert
- * @param c The character to insert.
+ * @param __pos Index in string to insert at.
+ * @param __n Number of characters to insert
+ * @param __c The character to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
- * @throw std::out_of_range If @a pos is beyond the end of this
+ * @throw std::out_of_range If @a __pos is beyond the end of this
* string.
*
- * Inserts @a n copies of character @a c starting at index @a pos. If
- * adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos > length(), out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Inserts @a __n copies of character @a __c starting at index
+ * @a __pos. If adding characters causes the length to exceed
+ * max_size(), length_error is thrown. If @a __pos > length(),
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
insert(size_type __pos, size_type __n, _CharT __c)
/**
* @brief Insert one character.
- * @param p Iterator referencing position in string to insert at.
- * @param c The character to insert.
+ * @param __p Iterator referencing position in string to insert at.
+ * @param __c The character to insert.
* @return Iterator referencing newly inserted char.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts character @a c at position referenced by @a p. If adding
- * character causes the length to exceed max_size(), length_error is
- * thrown. If @a p is beyond end of string, out_of_range is thrown.
- * The value of the string doesn't change if an error is thrown.
+ * Inserts character @a __c at position referenced by @a __p.
+ * If adding character causes the length to exceed max_size(),
+ * length_error is thrown. If @a __p is beyond end of string,
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
iterator
insert(iterator __p, _CharT __c)
/**
* @brief Remove characters.
- * @param pos Index of first character to remove (default 0).
- * @param n Number of characters to remove (default remainder).
+ * @param __pos Index of first character to remove (default 0).
+ * @param __n Number of characters to remove (default remainder).
* @return Reference to this string.
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
*
- * Removes @a n characters from this string starting at @a pos. The
- * length of the string is reduced by @a n. If there are < @a n
- * characters to remove, the remainder of the string is truncated. If
- * @a p is beyond end of string, out_of_range is thrown. The value of
- * the string doesn't change if an error is thrown.
+ * Removes @a __n characters from this string starting at @a
+ * __pos. The length of the string is reduced by @a __n. If
+ * there are < @a __n characters to remove, the remainder of
+ * the string is truncated. If @a __p is beyond end of string,
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
erase(size_type __pos = 0, size_type __n = npos)
/**
* @brief Remove one character.
- * @param position Iterator referencing the character to remove.
+ * @param __position Iterator referencing the character to remove.
* @return iterator referencing same location after removal.
*
- * Removes the character at @a position from this string. The value
+ * Removes the character at @a __position from this string. The value
* of the string doesn't change if an error is thrown.
*/
iterator
/**
* @brief Remove a range of characters.
- * @param first Iterator referencing the first character to remove.
- * @param last Iterator referencing the end of the range.
+ * @param __first Iterator referencing the first character to remove.
+ * @param __last Iterator referencing the end of the range.
* @return Iterator referencing location of first after removal.
*
* Removes the characters in the range [first,last) from this string.
/**
* @brief Replace characters with value from another string.
- * @param pos Index of first character to replace.
- * @param n Number of characters to be replaced.
- * @param str String to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n Number of characters to be replaced.
+ * @param __str String to insert.
* @return Reference to this string.
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos+n) from this string.
- * In place, the value of @a str is inserted. If @a pos is beyond end
- * of string, out_of_range is thrown. If the length of the result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [__pos,__pos+__n) from
+ * this string. In place, the value of @a __str is inserted.
+ * If @a __pos is beyond end of string, out_of_range is thrown.
+ * If the length of the result exceeds max_size(), length_error
+ * is thrown. The value of the string doesn't change if an
+ * error is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n, const basic_string& __str)
/**
* @brief Replace characters with value from another string.
- * @param pos1 Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param str String to insert.
- * @param pos2 Index of first character of str to use.
- * @param n2 Number of characters from str to use.
+ * @param __pos1 Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __str String to insert.
+ * @param __pos2 Index of first character of str to use.
+ * @param __n2 Number of characters from str to use.
* @return Reference to this string.
- * @throw std::out_of_range If @a pos1 > size() or @a pos2 >
- * str.size().
+ * @throw std::out_of_range If @a __pos1 > size() or @a __pos2 >
+ * __str.size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos1,pos1 + n) from this
- * string. In place, the value of @a str is inserted. If @a pos is
+ * Removes the characters in the range [__pos1,__pos1 + n) from this
+ * string. In place, the value of @a __str is inserted. If @a __pos is
* beyond end of string, out_of_range is thrown. If the length of the
* result exceeds max_size(), length_error is thrown. The value of the
* string doesn't change if an error is thrown.
/**
* @brief Replace characters with value of a C substring.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param s C string to insert.
- * @param n2 Number of characters from @a s to use.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __s C string to insert.
+ * @param __n2 Number of characters from @a s to use.
* @return Reference to this string.
* @throw std::out_of_range If @a pos1 > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, the first @a n2 characters of @a s are inserted, or all
- * of @a s if @a n2 is too large. If @a pos is beyond end of string,
- * out_of_range is thrown. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__pos,__pos + __n1)
+ * from this string. In place, the first @a __n2 characters of
+ * @a __s are inserted, or all of @a __s if @a __n2 is too large. If
+ * @a __pos is beyond end of string, out_of_range is thrown. If
+ * the length of result exceeds max_size(), length_error is
+ * thrown. The value of the string doesn't change if an error
+ * is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, const _CharT* __s,
/**
* @brief Replace characters with value of a C string.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param s C string to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __s C string to insert.
* @return Reference to this string.
* @throw std::out_of_range If @a pos > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, the characters of @a s are inserted. If @a pos is beyond
- * end of string, out_of_range is thrown. If the length of result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [__pos,__pos + __n1)
+ * from this string. In place, the characters of @a __s are
+ * inserted. If @a __pos is beyond end of string, out_of_range
+ * is thrown. If the length of result exceeds max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, const _CharT* __s)
/**
* @brief Replace characters with multiple characters.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param n2 Number of characters to insert.
- * @param c Character to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __n2 Number of characters to insert.
+ * @param __c Character to insert.
* @return Reference to this string.
- * @throw std::out_of_range If @a pos > size().
+ * @throw std::out_of_range If @a __pos > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, @a n2 copies of @a c are inserted. If @a pos is beyond
- * end of string, out_of_range is thrown. If the length of result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [pos,pos + n1) from this
+ * string. In place, @a __n2 copies of @a __c are inserted.
+ * If @a __pos is beyond end of string, out_of_range is thrown.
+ * If the length of result exceeds max_size(), length_error is
+ * thrown. The value of the string doesn't change if an error
+ * is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c)
/**
* @brief Replace range of characters with string.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param str String value to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __str String value to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the value of
- * @a str is inserted. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the value of @a __str is inserted. If the length of result
+ * exceeds max_size(), length_error is thrown. The value of
+ * the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const basic_string& __str)
/**
* @brief Replace range of characters with C substring.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param s C string value to insert.
- * @param n Number of characters from s to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __s C string value to insert.
+ * @param __n Number of characters from s to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the first @a
- * n characters of @a s are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the first @a __n characters of @a __s are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const _CharT* __s, size_type __n)
/**
* @brief Replace range of characters with C string.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param s C string value to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __s C string value to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the
- * characters of @a s are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the characters of @a __s are inserted. If the length of
+ * result exceeds max_size(), length_error is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const _CharT* __s)
/**
* @brief Replace range of characters with multiple characters
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param n Number of characters to insert.
- * @param c Character to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __n Number of characters to insert.
+ * @param __c Character to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, @a n copies
- * of @a c are inserted. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * @a __n copies of @a __c are inserted. If the length of
+ * result exceeds max_size(), length_error is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, size_type __n, _CharT __c)
/**
* @brief Replace range of characters with range.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param k1 Iterator referencing start of range to insert.
- * @param k2 Iterator referencing end of range to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __k1 Iterator referencing start of range to insert.
+ * @param __k2 Iterator referencing end of range to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, characters
- * in the range [k1,k2) are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * characters in the range [__k1,__k2) are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
template<class _InputIterator>
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Replace range of characters with initializer_list.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param l The initializer_list of characters to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __l The initializer_list of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, characters
- * in the range [k1,k2) are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * characters in the range [__k1,__k2) are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
basic_string& replace(iterator __i1, iterator __i2,
initializer_list<_CharT> __l)
/**
* @brief Copy substring into C string.
- * @param s C string to copy value into.
- * @param n Number of characters to copy.
- * @param pos Index of first character to copy.
+ * @param __s C string to copy value into.
+ * @param __n Number of characters to copy.
+ * @param __pos Index of first character to copy.
* @return Number of characters actually copied
- * @throw std::out_of_range If pos > size().
+ * @throw std::out_of_range If __pos > size().
*
- * Copies up to @a n characters starting at @a pos into the C string @a
- * s. If @a pos is %greater than size(), out_of_range is thrown.
+ * Copies up to @a __n characters starting at @a __pos into the
+ * C string @a __s. If @a __pos is %greater than size(),
+ * out_of_range is thrown.
*/
size_type
copy(_CharT* __s, size_type __n, size_type __pos = 0) const;
/**
* @brief Swap contents with another string.
- * @param s String to swap with.
+ * @param __s String to swap with.
*
- * Exchanges the contents of this string with that of @a s in constant
+ * Exchanges the contents of this string with that of @a __s in constant
* time.
*/
void
/**
* @brief Find position of a C substring.
- * @param s C string to locate.
- * @param pos Index of character to search from.
- * @param n Number of characters from @a s to search for.
+ * @param __s C string to locate.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from @a s to search for.
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for the first @a n characters
- * in @a s within this string. If found, returns the index where it
- * begins. If not found, returns npos.
+ * Starting from @a __pos, searches forward for the first @a
+ * __n characters in @a __s within this string. If found,
+ * returns the index where it begins. If not found, returns
+ * npos.
*/
size_type
find(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find position of a string.
- * @param str String to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __str String to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for value of @a str within
+ * Starting from @a __pos, searches forward for value of @a __str within
* this string. If found, returns the index where it begins. If not
* found, returns npos.
*/
/**
* @brief Find position of a C string.
- * @param s C string to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __s C string to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for the value of @a s within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches forward for the value of @a
+ * __s within this string. If found, returns the index where
+ * it begins. If not found, returns npos.
*/
size_type
find(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches forward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
find(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPT;
/**
* @brief Find last position of a string.
- * @param str String to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __str String to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for value of @a str within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches backward for value of @a
+ * __str within this string. If found, returns the index where
+ * it begins. If not found, returns npos.
*/
size_type
rfind(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a C substring.
- * @param s C string to locate.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to search for.
+ * @param __s C string to locate.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to search for.
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for the first @a n
- * characters in @a s within this string. If found, returns the index
- * where it begins. If not found, returns npos.
+ * Starting from @a __pos, searches backward for the first @a
+ * __n characters in @a __s within this string. If found,
+ * returns the index where it begins. If not found, returns
+ * npos.
*/
size_type
rfind(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find last position of a C string.
- * @param s C string to locate.
- * @param pos Index of character to start search at (default end).
+ * @param __s C string to locate.
+ * @param __pos Index of character to start search at (default end).
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for the value of @a s within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches backward for the value of
+ * @a __s within this string. If found, returns the index
+ * where it begins. If not found, returns npos.
*/
size_type
rfind(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches backward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
rfind(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPT;
/**
* @brief Find position of a character of string.
- * @param str String containing characters to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __str String containing characters to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the characters of
- * @a str within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * characters of @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_first_of(const basic_string& __str, size_type __pos = 0) const
/**
* @brief Find position of a character of C substring.
- * @param s String containing characters to locate.
- * @param pos Index of character to search from.
- * @param n Number of characters from s to search for.
+ * @param __s String containing characters to locate.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from s to search for.
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the first @a n
- * characters of @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * first @a __n characters of @a __s within this string. If
+ * found, returns the index where it was found. If not found,
+ * returns npos.
*/
size_type
find_first_of(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find position of a character of C string.
- * @param s String containing characters to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __s String containing characters to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the characters of
- * @a s within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * characters of @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_first_of(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for the character @a c within
- * this string. If found, returns the index where it was found. If
- * not found, returns npos.
+ * Starting from @a __pos, searches forward for the character
+ * @a __c within this string. If found, returns the index
+ * where it was found. If not found, returns npos.
*
- * Note: equivalent to find(c, pos).
+ * Note: equivalent to find(__c, __pos).
*/
size_type
find_first_of(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPT
/**
* @brief Find last position of a character of string.
- * @param str String containing characters to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __str String containing characters to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the characters of
- * @a str within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * characters of @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_of(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a character of C substring.
- * @param s C string containing characters to locate.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to search for.
+ * @param __s C string containing characters to locate.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to search for.
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the first @a n
- * characters of @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * first @a __n characters of @a __s within this string. If
+ * found, returns the index where it was found. If not found,
+ * returns npos.
*/
size_type
find_last_of(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find last position of a character of C string.
- * @param s C string containing characters to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __s C string containing characters to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the characters of
- * @a s within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * characters of @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_last_of(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches backward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*
- * Note: equivalent to rfind(c, pos).
+ * Note: equivalent to rfind(__c, __pos).
*/
size_type
find_last_of(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPT
/**
* @brief Find position of a character not in string.
- * @param str String containing characters to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __str String containing characters to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in @a str within this string. If found, returns the index where it
+ * Starting from @a __pos, searches forward for a character not contained
+ * in @a __str within this string. If found, returns the index where it
* was found. If not found, returns npos.
*/
size_type
/**
* @brief Find position of a character not in C substring.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search from.
- * @param n Number of characters from s to consider.
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from __s to consider.
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in the first @a n characters of @a s within this string. If found,
- * returns the index where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character not
+ * contained in the first @a __n characters of @a __s within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
find_first_not_of(const _CharT* __s, size_type __pos,
/**
* @brief Find position of a character not in C string.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in @a s within this string. If found, returns the index where it
- * was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character not
+ * contained in @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_first_not_of(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a different character.
- * @param c Character to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character other than @a c
- * within this string. If found, returns the index where it was found.
- * If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character
+ * other than @a __c within this string. If found, returns the
+ * index where it was found. If not found, returns npos.
*/
size_type
find_first_not_of(_CharT __c, size_type __pos = 0) const
/**
* @brief Find last position of a character not in string.
- * @param str String containing characters to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __str String containing characters to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in @a str within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for a character
+ * not contained in @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_not_of(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a character not in C substring.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to consider.
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to consider.
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in the first @a n characters of @a s within this string.
+ * Starting from @a __pos, searches backward for a character not
+ * contained in the first @a __n characters of @a __s within this string.
* If found, returns the index where it was found. If not found,
* returns npos.
*/
size_type __n) const;
/**
* @brief Find last position of a character not in C string.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for a character
+ * not contained in @a __s within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_not_of(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a different character.
- * @param c Character to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character other than
- * @a c within this string. If found, returns the index where it was
+ * Starting from @a __pos, searches backward for a character other than
+ * @a __c within this string. If found, returns the index where it was
* found. If not found, returns npos.
*/
size_type
/**
* @brief Get a substring.
- * @param pos Index of first character (default 0).
- * @param n Number of characters in substring (default remainder).
+ * @param __pos Index of first character (default 0).
+ * @param __n Number of characters in substring (default remainder).
* @return The new string.
- * @throw std::out_of_range If pos > size().
+ * @throw std::out_of_range If __pos > size().
*
- * Construct and return a new string using the @a n characters starting
- * at @a pos. If the string is too short, use the remainder of the
- * characters. If @a pos is beyond the end of the string, out_of_range
- * is thrown.
+ * Construct and return a new string using the @a __n
+ * characters starting at @a __pos. If the string is too
+ * short, use the remainder of the characters. If @a __pos is
+ * beyond the end of the string, out_of_range is thrown.
*/
basic_string
substr(size_type __pos = 0, size_type __n = npos) const
/**
* @brief Compare to a string.
- * @param str String to compare against.
+ * @param __str String to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Returns an integer < 0 if this string is ordered before @a str, 0 if
- * their values are equivalent, or > 0 if this string is ordered after
- * @a str. Determines the effective length rlen of the strings to
- * compare as the smallest of size() and str.size(). The function
- * then compares the two strings by calling traits::compare(data(),
- * str.data(),rlen). If the result of the comparison is nonzero returns
- * it, otherwise the shorter one is ordered first.
+ * Returns an integer < 0 if this string is ordered before @a
+ * __str, 0 if their values are equivalent, or > 0 if this
+ * string is ordered after @a __str. Determines the effective
+ * length rlen of the strings to compare as the smallest of
+ * size() and str.size(). The function then compares the two
+ * strings by calling traits::compare(data(), str.data(),rlen).
+ * If the result of the comparison is nonzero returns it,
+ * otherwise the shorter one is ordered first.
*/
int
compare(const basic_string& __str) const
/**
* @brief Compare substring to a string.
- * @param pos Index of first character of substring.
- * @param n Number of characters in substring.
- * @param str String to compare against.
+ * @param __pos Index of first character of substring.
+ * @param __n Number of characters in substring.
+ * @param __str String to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n characters starting
- * at @a pos. Returns an integer < 0 if the substring is ordered
- * before @a str, 0 if their values are equivalent, or > 0 if the
- * substring is ordered after @a str. Determines the effective length
- * rlen of the strings to compare as the smallest of the length of the
- * substring and @a str.size(). The function then compares the two
- * strings by calling traits::compare(substring.data(),str.data(),rlen).
- * If the result of the comparison is nonzero returns it, otherwise the
- * shorter one is ordered first.
+ * Form the substring of this string from the @a __n characters
+ * starting at @a __pos. Returns an integer < 0 if the
+ * substring is ordered before @a __str, 0 if their values are
+ * equivalent, or > 0 if the substring is ordered after @a
+ * __str. Determines the effective length rlen of the strings
+ * to compare as the smallest of the length of the substring
+ * and @a __str.size(). The function then compares the two
+ * strings by calling
+ * traits::compare(substring.data(),str.data(),rlen). If the
+ * result of the comparison is nonzero returns it, otherwise
+ * the shorter one is ordered first.
*/
int
compare(size_type __pos, size_type __n, const basic_string& __str) const;
/**
* @brief Compare substring to a substring.
- * @param pos1 Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param str String to compare against.
- * @param pos2 Index of first character of substring of str.
- * @param n2 Number of characters in substring of str.
+ * @param __pos1 Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __str String to compare against.
+ * @param __pos2 Index of first character of substring of str.
+ * @param __n2 Number of characters in substring of str.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos1. Form the substring of @a str from the @a n2 characters
- * starting at @a pos2. Returns an integer < 0 if this substring is
- * ordered before the substring of @a str, 0 if their values are
- * equivalent, or > 0 if this substring is ordered after the substring
- * of @a str. Determines the effective length rlen of the strings
- * to compare as the smallest of the lengths of the substrings. The
- * function then compares the two strings by calling
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a __pos1. Form the substring of @a
+ * __str from the @a __n2 characters starting at @a __pos2.
+ * Returns an integer < 0 if this substring is ordered before
+ * the substring of @a __str, 0 if their values are equivalent,
+ * or > 0 if this substring is ordered after the substring of
+ * @a __str. Determines the effective length rlen of the
+ * strings to compare as the smallest of the lengths of the
+ * substrings. The function then compares the two strings by
+ * calling
* traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen).
- * If the result of the comparison is nonzero returns it, otherwise the
- * shorter one is ordered first.
+ * If the result of the comparison is nonzero returns it,
+ * otherwise the shorter one is ordered first.
*/
int
compare(size_type __pos1, size_type __n1, const basic_string& __str,
/**
* @brief Compare to a C string.
- * @param s C string to compare against.
+ * @param __s C string to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Returns an integer < 0 if this string is ordered before @a s, 0 if
+ * Returns an integer < 0 if this string is ordered before @a __s, 0 if
* their values are equivalent, or > 0 if this string is ordered after
- * @a s. Determines the effective length rlen of the strings to
+ * @a __s. Determines the effective length rlen of the strings to
* compare as the smallest of size() and the length of a string
- * constructed from @a s. The function then compares the two strings
+ * constructed from @a __s. The function then compares the two strings
* by calling traits::compare(data(),s,rlen). If the result of the
* comparison is nonzero returns it, otherwise the shorter one is
* ordered first.
// 5 String::compare specification questionable
/**
* @brief Compare substring to a C string.
- * @param pos Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param s C string to compare against.
+ * @param __pos Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __s C string to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos. Returns an integer < 0 if the substring is ordered
- * before @a s, 0 if their values are equivalent, or > 0 if the
- * substring is ordered after @a s. Determines the effective length
- * rlen of the strings to compare as the smallest of the length of the
- * substring and the length of a string constructed from @a s. The
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a pos. Returns an integer < 0 if
+ * the substring is ordered before @a __s, 0 if their values
+ * are equivalent, or > 0 if the substring is ordered after @a
+ * __s. Determines the effective length rlen of the strings to
+ * compare as the smallest of the length of the substring and
+ * the length of a string constructed from @a __s. The
* function then compares the two string by calling
- * traits::compare(substring.data(),s,rlen). If the result of the
- * comparison is nonzero returns it, otherwise the shorter one is
- * ordered first.
+ * traits::compare(substring.data(),__s,rlen). If the result of
+ * the comparison is nonzero returns it, otherwise the shorter
+ * one is ordered first.
*/
int
compare(size_type __pos, size_type __n1, const _CharT* __s) const;
/**
* @brief Compare substring against a character %array.
- * @param pos1 Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param s character %array to compare against.
- * @param n2 Number of characters of s.
+ * @param __pos Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __s character %array to compare against.
+ * @param __n2 Number of characters of s.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos1. Form a string from the first @a n2 characters of @a s.
- * Returns an integer < 0 if this substring is ordered before the string
- * from @a s, 0 if their values are equivalent, or > 0 if this substring
- * is ordered after the string from @a s. Determines the effective
- * length rlen of the strings to compare as the smallest of the length
- * of the substring and @a n2. The function then compares the two
- * strings by calling traits::compare(substring.data(),s,rlen). If the
- * result of the comparison is nonzero returns it, otherwise the shorter
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a __pos. Form a string from the
+ * first @a __n2 characters of @a __s. Returns an integer < 0
+ * if this substring is ordered before the string from @a __s,
+ * 0 if their values are equivalent, or > 0 if this substring
+ * is ordered after the string from @a __s. Determines the
+ * effective length rlen of the strings to compare as the
+ * smallest of the length of the substring and @a __n2. The
+ * function then compares the two strings by calling
+ * traits::compare(substring.data(),s,rlen). If the 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
// operator+
/**
* @brief Concatenate two strings.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with value of @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with value of @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT, _Traits, _Alloc>
/**
* @brief Concatenate C string and string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with value of @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with value of @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT,_Traits,_Alloc>
/**
* @brief Concatenate character and string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT,_Traits,_Alloc>
/**
* @brief Concatenate string and C string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_string<_CharT, _Traits, _Alloc>
/**
* @brief Concatenate string and character.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_string<_CharT, _Traits, _Alloc>
// operator ==
/**
* @brief Test equivalence of two strings.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test equivalence of C string and string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a rhs.compare(@a lhs) == 0. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __rhs.compare(@a __lhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test equivalence of string and C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator !=
/**
* @brief Test difference of two strings.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test difference of C string and string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a rhs.compare(@a lhs) != 0. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __rhs.compare(@a __lhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test difference of string and C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator <
/**
* @brief Test if string precedes string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string precedes C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string precedes string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator >
/**
* @brief Test if string follows string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string follows C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string follows string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator <=
/**
* @brief Test if string doesn't follow string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string doesn't follow C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string doesn't follow string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator >=
/**
* @brief Test if string doesn't precede string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string doesn't precede C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string doesn't precede string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Swap contents of two strings.
- * @param lhs First string.
- * @param rhs Second string.
+ * @param __lhs First string.
+ * @param __rhs Second string.
*
- * Exchanges the contents of @a lhs and @a rhs in constant time.
+ * Exchanges the contents of @a __lhs and @a __rhs in constant time.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline void
/**
* @brief Read stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from @a is into @a str until whitespace 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.
+ * Stores characters from @a __is into @a __str until whitespace 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.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_istream<_CharT, _Traits>&
/**
* @brief Write string to a stream.
- * @param os Output stream.
- * @param str String to write out.
+ * @param __os Output stream.
+ * @param __str String to write out.
* @return Reference to the output stream.
*
- * Output characters of @a str into os following the same rules as for
+ * Output characters of @a __str into os following the same rules as for
* writing a C string.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
/**
* @brief Read a line from stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
- * @param delim Character marking end of line.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
+ * @param __delim Character marking end of line.
* @return Reference to the input stream.
*
- * Stores characters from @a is into @a str until @a delim 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 @a
- * delim was encountered, it is extracted but not stored into @a str.
+ * Stores characters from @a __is into @a __str until @a __delim 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 @a __delim was encountered,
+ * it is extracted but not stored into @a __str.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_istream<_CharT, _Traits>&
/**
* @brief Read a line from stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from is into @a str until '\n' is
+ * 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.
+ * 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>&
* output, returns codecvt_base::partial. Otherwise the
* conversion failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param from Start of input.
- * @param from_end End of input.
- * @param from_next Returns start of unconverted data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __from Start of input.
+ * @param __from_end End of input.
+ * @param __from_next Returns start of unconverted data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
* output has insufficient space, returns codecvt_base::partial.
* Otherwise the reset failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
* output, returns codecvt_base::partial. Otherwise the
* conversion failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param from Start of input.
- * @param from_end End of input.
- * @param from_next Returns start of unconverted data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __from Start of input.
+ * @param __from_end End of input.
+ * @param __from_next Returns start of unconverted data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
/**
* @brief Creates a %forward_list with no elements.
- * @param al An allocator object.
+ * @param __al An allocator object.
*/
explicit
forward_list(const _Alloc& __al = _Alloc())
/**
* @brief Copy constructor with allocator argument.
- * @param list Input list to copy.
- * @param al An allocator object.
+ * @param __list Input list to copy.
+ * @param __al An allocator object.
*/
forward_list(const forward_list& __list, const _Alloc& __al)
: _Base(__list, __al)
/**
* @brief Move constructor with allocator argument.
- * @param list Input list to move.
- * @param al An allocator object.
+ * @param __list Input list to move.
+ * @param __al An allocator object.
*/
forward_list(forward_list&& __list, const _Alloc& __al)
: _Base(std::move(__list), __al)
/**
* @brief Creates a %forward_list with default constructed elements.
- * @param n The number of elements to initially create.
+ * @param __n The number of elements to initially create.
*
- * This constructor creates the %forward_list with @a n default
+ * This constructor creates the %forward_list with @a __n default
* constructed elements.
*/
explicit
/**
* @brief Creates a %forward_list with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param al An allocator object.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __al An allocator object.
*
- * This constructor fills the %forward_list with @a n copies of @a
- * value.
+ * This constructor fills the %forward_list with @a __n copies of
+ * @a __value.
*/
forward_list(size_type __n, const _Tp& __value,
const _Alloc& __al = _Alloc())
/**
* @brief Builds a %forward_list from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param al An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __al An allocator object.
*
* Create a %forward_list consisting of copies of the elements from
- * [@a first,@a last). This is linear in N (where N is
- * distance(@a first,@a last)).
+ * [@a __first,@a __last). This is linear in N (where N is
+ * distance(@a __first,@a __last)).
*/
template<typename _InputIterator>
forward_list(_InputIterator __first, _InputIterator __last,
/**
* @brief The %forward_list copy constructor.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
* The newly-created %forward_list uses a copy of the allocation
- * object used by @a list.
+ * object used by @a __list.
*/
forward_list(const forward_list& __list)
: _Base(__list._M_get_Node_allocator())
/**
* @brief The %forward_list move constructor.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
* The newly-created %forward_list contains the exact contents of @a
- * forward_list. The contents of @a list are a valid, but unspecified
+ * forward_list. The contents of @a __list are a valid, but unspecified
* %forward_list.
*/
forward_list(forward_list&& __list) noexcept
/**
* @brief Builds a %forward_list from an initializer_list
- * @param il An initializer_list of value_type.
- * @param al An allocator object.
+ * @param __il An initializer_list of value_type.
+ * @param __al An allocator object.
*
* Create a %forward_list consisting of copies of the elements
- * in the initializer_list @a il. This is linear in il.size().
+ * in the initializer_list @a __il. This is linear in __il.size().
*/
forward_list(std::initializer_list<_Tp> __il,
const _Alloc& __al = _Alloc())
/**
* @brief The %forward_list assignment operator.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
- * All the elements of @a list are copied, but unlike the copy
+ * All the elements of @a __list are copied, but unlike the copy
* constructor, the allocator object is not copied.
*/
forward_list&
/**
* @brief The %forward_list move assignment operator.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
- * The contents of @a list are moved into this %forward_list
- * (without copying). @a list is a valid, but unspecified
+ * The contents of @a __list are moved into this %forward_list
+ * (without copying). @a __list is a valid, but unspecified
* %forward_list
*/
forward_list&
/**
* @brief The %forward_list initializer list assignment operator.
- * @param il An initializer_list of value_type.
+ * @param __il An initializer_list of value_type.
*
* Replace the contents of the %forward_list with copies of the
- * elements in the initializer_list @a il. This is linear in
- * il.size().
+ * elements in the initializer_list @a __il. This is linear in
+ * __il.size().
*/
forward_list&
operator=(std::initializer_list<_Tp> __il)
/**
* @brief Assigns a range to a %forward_list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function fills a %forward_list with copies of the elements
- * in the range [@a first,@a last).
+ * in the range [@a __first,@a __last).
*
* Note that the assignment completely changes the %forward_list and
* that the resulting %forward_list's size is the same as the number
/**
* @brief Assigns a given value to a %forward_list.
- * @param n Number of elements to be assigned.
- * @param val Value to be assigned.
+ * @param __n Number of elements to be assigned.
+ * @param __val Value to be assigned.
*
- * This function fills a %forward_list with @a n copies of the given
+ * This function fills a %forward_list with @a __n copies of the given
* value. Note that the assignment completely changes the
* %forward_list and that the resulting %forward_list's size is the
* same as the number of elements assigned. Old data may be lost.
/**
* @brief Assigns an initializer_list to a %forward_list.
- * @param il An initializer_list of value_type.
+ * @param __il An initializer_list of value_type.
*
* Replace the contents of the %forward_list with copies of the
- * elements in the initializer_list @a il. This is linear in
+ * elements in the initializer_list @a __il. This is linear in
* il.size().
*/
void
/**
* @brief Constructs object in %forward_list at the front of the
* list.
- * @param args Arguments.
+ * @param __args Arguments.
*
* This function will insert an object of type Tp constructed
* with Tp(std::forward<Args>(args)...) at the front of the list
/**
* @brief Add data to the front of the %forward_list.
- * @param val Data to be added.
+ * @param __val Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the front of the %forward_list and assigns the given
/**
* @brief Constructs object in %forward_list after the specified
* iterator.
- * @param pos A const_iterator into the %forward_list.
- * @param args Arguments.
+ * @param __pos A const_iterator into the %forward_list.
+ * @param __args Arguments.
* @return An iterator that points to the inserted data.
*
* This function will insert an object of type T constructed
/**
* @brief Inserts given value into %forward_list after specified
* iterator.
- * @param pos An iterator into the %forward_list.
- * @param val Data to be inserted.
+ * @param __pos An iterator into the %forward_list.
+ * @param __val Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given value after
/**
* @brief Inserts a number of copies of given data into the
* %forward_list.
- * @param pos An iterator into the %forward_list.
- * @param n Number of elements to be inserted.
- * @param val Data to be inserted.
+ * @param __pos An iterator into the %forward_list.
+ * @param __n Number of elements to be inserted.
+ * @param __val Data to be inserted.
* @return An iterator pointing to the last inserted copy of
* @a val or @a pos if @a n == 0.
*
/**
* @brief Inserts a range into the %forward_list.
- * @param position An iterator into the %forward_list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __pos An iterator into the %forward_list.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
* @return An iterator pointing to the last inserted element or
- * @a pos if @a first == @a last.
+ * @a __pos if @a __first == @a __last.
*
- * This function will insert copies of the data in the range [@a
- * first,@a last) into the %forward_list after the location specified
- * by @a pos.
+ * This function will insert copies of the data in the range
+ * [@a __first,@a __last) into the %forward_list after the
+ * location specified by @a __pos.
*
* This operation is linear in the number of elements inserted and
* does not invalidate iterators and references.
/**
* @brief Inserts the contents of an initializer_list into
* %forward_list after the specified iterator.
- * @param pos An iterator into the %forward_list.
- * @param il An initializer_list of value_type.
+ * @param __pos An iterator into the %forward_list.
+ * @param __il An initializer_list of value_type.
* @return An iterator pointing to the last inserted element
- * or @a pos if @a il is empty.
+ * or @a __pos if @a __il is empty.
*
* This function will insert copies of the data in the
- * initializer_list @a il into the %forward_list before the location
- * specified by @a pos.
+ * initializer_list @a __il into the %forward_list before the location
+ * specified by @a __pos.
*
* This operation is linear in the number of elements inserted and
* does not invalidate iterators and references.
/**
* @brief Removes the element pointed to by the iterator following
* @c pos.
- * @param pos Iterator pointing before element to be erased.
+ * @param __pos Iterator pointing before element to be erased.
* @return An iterator pointing to the element following the one
* that was erased, or end() if no such element exists.
*
/**
* @brief Remove a range of elements.
- * @param pos Iterator pointing before the first element to be
- * erased.
- * @param last Iterator pointing to one past the last element to be
- * erased.
- * @return @last.
+ * @param __pos Iterator pointing before the first element to be
+ * erased.
+ * @param __last Iterator pointing to one past the last element to be
+ * erased.
+ * @return @ __last.
*
- * This function will erase the elements in the range @a
- * (pos,last) and shorten the %forward_list accordingly.
+ * This function will erase the elements in the range
+ * @a (__pos,__last) and shorten the %forward_list accordingly.
*
* This operation is linear time in the size of the range and only
* invalidates iterators/references to the element being removed.
/**
* @brief Swaps data with another %forward_list.
- * @param list A %forward_list of the same element and allocator
- * types.
+ * @param __list A %forward_list of the same element and allocator
+ * types.
*
* This exchanges the elements between two lists in constant
* time. Note that the global std::swap() function is
/**
* @brief Resizes the %forward_list to the specified number of
* elements.
- * @param sz Number of elements the %forward_list should contain.
+ * @param __sz Number of elements the %forward_list should contain.
*
* This function will %resize the %forward_list to the specified
* number of elements. If the number is smaller than the
/**
* @brief Resizes the %forward_list to the specified number of
* elements.
- * @param sz Number of elements the %forward_list should contain.
- * @param val Data with which new elements should be populated.
+ * @param __sz Number of elements the %forward_list should contain.
+ * @param __val Data with which new elements should be populated.
*
* This function will %resize the %forward_list to the specified
* number of elements. If the number is smaller than the
/**
* @brief Insert contents of another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
*
* The elements of @a list are inserted in constant time after
* the element referenced by @a pos. @a list becomes an empty
/**
* @brief Insert element from another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
- * @param i Iterator referencing the element before the element
- * to move.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
+ * @param __i Iterator referencing the element before the element
+ * to move.
*
* Removes the element in list @a list referenced by @a i and
* inserts it into the current list after @a pos.
/**
* @brief Insert range from another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
- * @param before Iterator referencing before the start of range
- * in list.
- * @param last Iterator referencing the end of range in list.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
+ * @param __before Iterator referencing before the start of range
+ * in list.
+ * @param __last Iterator referencing the end of range in list.
*
- * Removes elements in the range (before,last) and inserts them
- * after @a pos in constant time.
+ * Removes elements in the range (__before,__last) and inserts them
+ * after @a __pos in constant time.
*
- * Undefined if @a pos is in (before,last).
+ * Undefined if @a __pos is in (__before,__last).
*/
void
splice_after(const_iterator __pos, forward_list&& __list,
/**
* @brief Remove all elements equal to value.
- * @param val The value to remove.
+ * @param __val The value to remove.
*
- * Removes every element in the list equal to @a value.
+ * Removes every element in the list equal to @a __val.
* Remaining elements stay in list order. Note that this
* function only erases the elements, and that if the elements
* themselves are pointers, the pointed-to memory is not
/**
* @brief Remove all elements satisfying a predicate.
- * @param pred Unary predicate function or object.
+ * @param __pred Unary predicate function or object.
*
* Removes every element in the list for which the predicate
* returns true. Remaining elements stay in list order. Note
/**
* @brief Remove consecutive elements satisfying a predicate.
- * @param binary_pred Binary predicate function or object.
+ * @param __binary_pred Binary predicate function or object.
*
* For each consecutive set of elements [first,last) that
* satisfy predicate(first,i) where i is an iterator in
/**
* @brief Merge sorted lists.
- * @param list Sorted list to merge.
+ * @param __list Sorted list to merge.
*
* Assumes that both @a list and this list are sorted according to
- * operator<(). Merges elements of @a list into this list in
- * sorted order, leaving @a list empty when complete. Elements in
- * this list precede elements in @a list that are equal.
+ * operator<(). Merges elements of @a __list into this list in
+ * sorted order, leaving @a __list empty when complete. Elements in
+ * this list precede elements in @a __list that are equal.
*/
void
merge(forward_list&& __list)
/**
* @brief Merge sorted lists according to comparison function.
- * @param list Sorted list to merge.
- * @param comp Comparison function defining sort order.
+ * @param __list Sorted list to merge.
+ * @param __comp Comparison function defining sort order.
*
- * Assumes that both @a list and this list are sorted according to
- * comp. Merges elements of @a list into this list
- * in sorted order, leaving @a list empty when complete. Elements
- * in this list precede elements in @a list that are equivalent
+ * Assumes that both @a __list and this list are sorted according to
+ * comp. Merges elements of @a __list into this list
+ * in sorted order, leaving @a __list empty when complete. Elements
+ * in this list precede elements in @a __list that are equivalent
* according to comp().
*/
template<typename _Comp>
/**
* @brief Forward list equality comparison.
- * @param lx A %forward_list
- * @param ly A %forward_list of the same type as @a lx.
+ * @param __lx A %forward_list
+ * @param __ly A %forward_list of the same type as @a __lx.
* @return True iff the size and elements of the forward lists are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Forward list ordering relation.
- * @param lx A %forward_list.
- * @param ly A %forward_list of the same type as @a lx.
- * @return True iff @a lx is lexicographically less than @a ly.
+ * @param __lx A %forward_list.
+ * @param __ly A %forward_list of the same type as @a __lx.
+ * @return True iff @a __lx is lexicographically less than @a __ly.
*
* This is a total ordering relation. It is linear in the size of the
* forward lists. The elements must be comparable with @c <.
// The template and inlines for the -*- C++ -*- gslice class.
-// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2004, 2005, 2006, 2009, 2010
-// Free Software Foundation, Inc.
+// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2004, 2005, 2006, 2009, 2010,
+// 2011 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
* Constructs a slice with as many dimensions as the length of the @a l
* and @a s arrays.
*
- * @param o Offset in array of first element.
- * @param l Array of dimension lengths.
- * @param s Array of dimension strides between array elements.
+ * @param __o Offset in array of first element.
+ * @param __l Array of dimension lengths.
+ * @param __s Array of dimension strides between array elements.
*/
- gslice(size_t, const valarray<size_t>&, const valarray<size_t>&);
+ gslice(size_t __o, const valarray<size_t>& __l,
+ const valarray<size_t>& __s);
// XXX: the IS says the copy-ctor and copy-assignment operators are
// synthesized by the compiler but they are just unsuitable
/**
* @brief The type of an event callback function.
- * @param event One of the members of the event enum.
- * @param ios_base Reference to the ios_base object.
- * @param int The integer provided when the callback was registered.
+ * @param __e One of the members of the event enum.
+ * @param __b Reference to the ios_base object.
+ * @param __i The integer provided when the callback was registered.
*
* Event callbacks are user defined functions that get called during
* several ios_base and basic_ios functions, specifically imbue(),
* copyfmt(), and ~ios().
*/
- typedef void (*event_callback) (event, ios_base&, int);
+ typedef void (*event_callback) (event __e, ios_base& __b, int __i);
/**
* @brief Add the callback __fn with parameter __index.
/**
* @brief Setting new format flags all at once.
- * @param fmtfl The new flags to set.
+ * @param __fmtfl The new flags to set.
* @return The previous format control flags.
*
- * This function overwrites all the format flags with @a fmtfl.
+ * This function overwrites all the format flags with @a __fmtfl.
*/
fmtflags
flags(fmtflags __fmtfl)
/**
* @brief Setting new format flags.
- * @param fmtfl Additional flags to set.
+ * @param __fmtfl Additional flags to set.
* @return The previous format control flags.
*
* This function sets additional flags in format control. Flags that
/**
* @brief Setting new format flags.
- * @param fmtfl Additional flags to set.
- * @param mask The flags mask for @a fmtfl.
+ * @param __fmtfl Additional flags to set.
+ * @param __mask The flags mask for @a fmtfl.
* @return The previous format control flags.
*
* This function clears @a mask in the format flags, then sets
/**
* @brief Clearing format flags.
- * @param mask The flags to unset.
+ * @param __mask The flags to unset.
*
- * This function clears @a mask in the format flags.
+ * This function clears @a __mask in the format flags.
*/
void
unsetf(fmtflags __mask)
/**
* @brief Changing flags.
- * @param prec The new precision value.
+ * @param __prec The new precision value.
* @return The previous value of precision().
*/
streamsize
/**
* @brief Changing flags.
- * @param wide The new width value.
+ * @param __wide The new width value.
* @return The previous value of width().
*/
streamsize
// [27.4.2.4] ios_base static members
/**
* @brief Interaction with the standard C I/O objects.
- * @param sync Whether to synchronize or not.
+ * @param __sync Whether to synchronize or not.
* @return True if the standard streams were previously synchronized.
*
* The synchronization referred to is @e only that between the standard
// [27.4.2.3] ios_base locale functions
/**
* @brief Setting a new locale.
- * @param loc The new locale.
+ * @param __loc The new locale.
* @return The previous locale.
*
* Sets the new locale for this stream, and then invokes each callback
*
* Constructs a copy of @a other.
*
- * @param other The locale to copy.
+ * @param __other The locale to copy.
*/
locale(const locale& __other) throw();
*
* Constructs a copy of the named C library locale.
*
- * @param s Name of the locale to construct.
- * @throw std::runtime_error if s is null or an undefined locale.
+ * @param __s Name of the locale to construct.
+ * @throw std::runtime_error if __s is null or an undefined locale.
*/
explicit
locale(const char* __s);
* cat are replaced with those from the locale named by @a s. If base is
* named, this locale instance will also be named.
*
- * @param base The locale to copy.
- * @param s Name of the locale to use facets from.
- * @param cat Set of categories defining the facets to use from s.
- * @throw std::runtime_error if s is null or an undefined locale.
+ * @param __base The locale to copy.
+ * @param __s Name of the locale to use facets from.
+ * @param __cat Set of categories defining the facets to use from __s.
+ * @throw std::runtime_error if __s is null or an undefined locale.
*/
locale(const locale& __base, const char* __s, category __cat);
* cat are replaced with those from the locale @a add. If @a base and @a
* add are named, this locale instance will also be named.
*
- * @param base The locale to copy.
- * @param add The locale to use facets from.
- * @param cat Set of categories defining the facets to use from add.
+ * @param __base The locale to copy.
+ * @param __add The locale to use facets from.
+ * @param __cat Set of categories defining the facets to use from add.
*/
locale(const locale& __base, const locale& __add, category __cat);
/**
* @brief Construct locale with another facet.
*
- * Constructs a copy of the locale @a other. The facet @f is added to
- * @other, replacing an existing facet of type Facet if there is one. If
- * @f is null, this locale is a copy of @a other.
+ * Constructs a copy of the locale @a __other. The facet @a __f
+ * is added to @a __other, replacing an existing facet of type
+ * Facet if there is one. If @a __f is null, this locale is a
+ * copy of @a __other.
*
- * @param other The locale to copy.
- * @param f The facet to add in.
+ * @param __other The locale to copy.
+ * @param __f The facet to add in.
*/
template<typename _Facet>
locale(const locale& __other, _Facet* __f);
*
* Set this locale to be a copy of @a other.
*
- * @param other The locale to copy.
+ * @param __other The locale to copy.
* @return A reference to this locale.
*/
const locale&
* existing facet of type Facet from the locale @a other into the new
* locale.
*
- * @param Facet The facet type to copy from other
- * @param other The locale to copy from.
+ * @tparam _Facet The facet type to copy from other
+ * @param __other The locale to copy from.
* @return Newly constructed locale.
- * @throw std::runtime_error if other has no facet of type Facet.
+ * @throw std::runtime_error if __other has no facet of type _Facet.
*/
template<typename _Facet>
locale
/**
* @brief Locale equality.
*
- * @param other The locale to compare against.
+ * @param __other The locale to compare against.
* @return True if other and this refer to the same locale instance, are
* copies, or have the same name. False otherwise.
*/
/**
* @brief Locale inequality.
*
- * @param other The locale to compare against.
- * @return ! (*this == other)
+ * @param __other The locale to compare against.
+ * @return ! (*this == __other)
*/
bool
operator!=(const locale& __other) const throw()
* std::sort(v.begin(), v.end(), loc);
* @endcode
*
- * @param s1 First string to compare.
- * @param s2 Second string to compare.
- * @return True if collate<Char> facet compares s1 < s2, else false.
+ * @param __s1 First string to compare.
+ * @param __s2 Second string to compare.
+ * @return True if collate<_Char> facet compares __s1 < __s2, else false.
*/
template<typename _Char, typename _Traits, typename _Alloc>
bool
* copy of the previous global locale. If the argument has a name, it
* will also call std::setlocale(LC_ALL, loc.name()).
*
- * @param locale The new locale to make global.
+ * @param __loc The new locale to make global.
* @return Copy of the old global locale.
*/
static locale
- global(const locale&);
+ global(const locale& __loc);
/**
* @brief Return reference to the C locale.
* facet is destroyed when the last referencing locale is destroyed.
* Otherwise the facet will never be destroyed.
*
- * @param refs The initial value for reference count.
+ * @param __refs The initial value for reference count.
*/
explicit
facet(size_t __refs = 0) throw() : _M_refcount(__refs ? 1 : 0)
* provided as the template parameter. Facets derived from the facet
* parameter will also return true.
*
- * @param Facet The facet type to test the presence of.
- * @param locale The locale to test.
- * @return true if locale contains a facet of type Facet, else false.
+ * @tparam _Facet The facet type to test the presence of.
+ * @param __loc The locale to test.
+ * @return true if __loc contains a facet of type _Facet, else false.
*/
template<typename _Facet>
bool
* there is a suitable facet to return. It throws std::bad_cast if the
* locale doesn't contain a facet of type Facet.
*
- * @param Facet The facet type to access.
- * @param locale The locale to use.
+ * @tparam _Facet The facet type to access.
+ * @param __loc The locale to use.
* @return Reference to facet of type Facet.
- * @throw std::bad_cast if locale doesn't contain a facet of type Facet.
+ * @throw std::bad_cast if __loc doesn't contain a facet of type _Facet.
*/
template<typename _Facet>
const _Facet&
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
collate(size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param refs Passed to the base facet class.
+ * @param __cloc The C locale.
+ * @param __refs Passed to the base facet class.
*/
explicit
collate(__c_locale __cloc, size_t __refs = 0)
* This function compares two strings and returns the result by calling
* collate::do_compare().
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
+ * @param __lo1 Start of string 1.
+ * @param __hi1 End of string 1.
+ * @param __lo2 Start of string 2.
+ * @param __hi2 End of string 2.
* @return 1 if string1 > string2, -1 if string1 < string2, else 0.
*/
int
* locales, it may replace two chars with one, change a char for
* another, etc. It does so by returning collate::do_transform().
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Transformed string_type.
*/
string_type
* This function computes and returns a hash on the input string. It
* does so by returning collate::do_hash().
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Hash value.
*/
long
* This function is a hook for derived classes to change the value
* returned. @see compare().
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
+ * @param __lo1 Start of string 1.
+ * @param __hi1 End of string 1.
+ * @param __lo2 Start of string 2.
+ * @param __hi2 End of string 2.
* @return 1 if string1 > string2, -1 if string1 < string2, else 0.
*/
virtual int
* This function is a hook for derived classes to change the value
* returned.
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
- * @return 1 if string1 > string2, -1 if string1 < string2, else 0.
+ * @param __lo Start.
+ * @param __hi End.
+ * @return transformed string.
*/
virtual string_type
do_transform(const _CharT* __lo, const _CharT* __hi) const;
* This function computes and returns a hash on the input string. This
* function is a hook for derived classes to change the value returned.
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Hash value.
*/
virtual long
/**
* @brief Test char_type classification.
*
- * This function finds a mask M for @a c and compares it to mask @a m.
- * It does so by returning the value of ctype<char_type>::do_is().
+ * This function finds a mask M for @a __c and compares it to
+ * mask @a __m. It does so by returning the value of
+ * ctype<char_type>::do_is().
*
- * @param c The char_type to compare the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The char_type to compare the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
bool
is(mask __m, char_type __c) const
* as the char array. It does so by returning the value of
* ctype<char_type>::do_is().
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
const char_type*
is(const char_type *__lo, const char_type *__hi, mask *__vec) const
* [lo,hi) for which is(m,c) is true. It does so by returning
* ctype<char_type>::do_scan_is().
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to matching char_type if found, else @a __hi.
*/
const char_type*
scan_is(mask __m, const char_type* __lo, const char_type* __hi) const
* [lo,hi) for which is(m,c) is false. It does so by returning
* ctype<char_type>::do_scan_not().
*
- * @param m The mask to compare against.
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return Pointer to non-matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to non-matching char if found, else @a __hi.
*/
const char_type*
scan_not(mask __m, const char_type* __lo, const char_type* __hi) const
* If not possible (for example, '2'), returns the argument. It does
* so by returning ctype<char_type>::do_toupper().
*
- * @param c The char_type to convert.
- * @return The uppercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The uppercase char_type if convertible, else @a __c.
*/
char_type
toupper(char_type __c) const
* uppercase if possible. Other elements remain untouched. It does so
* by returning ctype<char_type>:: do_toupper(lo, hi).
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
toupper(char_type *__lo, const char_type* __hi) const
* not possible (for example, '2'), returns the argument. It does so
* by returning ctype<char_type>::do_tolower(c).
*
- * @param c The char_type to convert.
- * @return The lowercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The lowercase char_type if convertible, else @a __c.
*/
char_type
tolower(char_type __c) const
/**
* @brief Convert array to lowercase.
*
- * This function converts each char_type in the range [lo,hi) to
+ * This function converts each char_type in the range [__lo,__hi) to
* lowercase if possible. Other elements remain untouched. It does so
- * by returning ctype<char_type>:: do_tolower(lo, hi).
+ * by returning ctype<char_type>:: do_tolower(__lo, __hi).
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
tolower(char_type* __lo, const char_type* __hi) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted char_type.
*/
char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char*
widen(const char* __lo, const char* __hi, char_type* __to) const
* This function converts the char_type to char using the simplest
* reasonable transformation. If the conversion fails, dfault is
* returned instead. It does so by returning
- * ctype<char_type>::do_narrow(c).
+ * ctype<char_type>::do_narrow(__c).
*
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char_type to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char_type to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
char
* simplest reasonable transformation and writes the results to the
* destination array. For any char_type in the input that cannot be
* converted, @a dfault is used instead. It does so by returning
- * ctype<char_type>::do_narrow(lo, hi, dfault, to).
+ * ctype<char_type>::do_narrow(__lo, __hi, __dfault, __to).
*
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char_type*
narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char *__to) const
+ char __dfault, char* __to) const
{ return this->do_narrow(__lo, __hi, __dfault, __to); }
protected:
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param c The char_type to find the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The char_type to find the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
virtual bool
do_is(mask __m, char_type __c) const = 0;
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
virtual const char_type*
do_is(const char_type* __lo, const char_type* __hi,
* @brief Find char_type matching mask
*
* This function searches for and returns the first char_type c in
- * [lo,hi) for which is(m,c) is true.
+ * [__lo,__hi) for which is(__m,c) is true.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching char_type if found, else @a __hi.
*/
virtual const char_type*
do_scan_is(mask __m, const char_type* __lo,
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching char_type if found, else @a __hi.
*/
virtual const char_type*
do_scan_not(mask __m, const char_type* __lo,
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The char_type to convert.
- * @return The uppercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The uppercase char_type if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const = 0;
+ do_toupper(char_type __c) const = 0;
/**
* @brief Convert array to uppercase.
*
- * This virtual function converts each char_type in the range [lo,hi)
+ * This virtual function converts each char_type in the range [__lo,__hi)
* to uppercase if possible. Other elements remain untouched.
*
* do_toupper() is a hook for a derived facet to change the behavior of
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const = 0;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The char_type to convert.
- * @return The lowercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The lowercase char_type if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const = 0;
+ do_tolower(char_type __c) const = 0;
/**
* @brief Convert array to lowercase.
*
- * This virtual function converts each char_type in the range [lo,hi)
+ * This virtual function converts each char_type in the range [__lo,__hi)
* to lowercase if possible. Other elements remain untouched.
*
* do_tolower() is a hook for a derived facet to change the behavior of
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const = 0;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted char_type
*/
virtual char_type
- do_widen(char) const = 0;
+ do_widen(char __c) const = 0;
/**
* @brief Widen char array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi,
- char_type* __dest) const = 0;
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const = 0;
/**
* @brief Narrow char_type to char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char_type to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char_type to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type, char __dfault) const = 0;
+ do_narrow(char_type __c, char __dfault) const = 0;
/**
* @brief Narrow char_type array to char
*
- * This virtual function converts each char_type in the range [lo,hi) to
- * char using the simplest reasonable transformation and writes the
- * results to the destination array. For any element in the input that
- * cannot be converted, @a dfault is used instead.
+ * This virtual function converts each char_type in the range
+ * [__lo,__hi) to char using the simplest reasonable
+ * transformation and writes the results to the destination
+ * array. For any element in the input that cannot be
+ * converted, @a __dfault is used instead.
*
* do_narrow() is a hook for a derived facet to change the behavior of
* narrowing. do_narrow() must always return the same result for the
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const = 0;
+ char __dfault, char* __to) const = 0;
};
/**
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const;
+ char __dfault, char* __to) const;
};
template<typename _CharT>
*
* This is the constructor provided by the standard.
*
- * @param table If non-zero, table is used as the per-char mask.
+ * @param __table If non-zero, table is used as the per-char mask.
* Else classic_table() is used.
- * @param del If true, passes ownership of table to this facet.
- * @param refs Passed to the base facet class.
+ * @param __del If true, passes ownership of table to this facet.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(const mask* __table = 0, bool __del = false, size_t __refs = 0);
*
* This constructor is used to construct the initial C locale facet.
*
- * @param cloc Handle to C locale data.
- * @param table If non-zero, table is used as the per-char mask.
- * @param del If true, passes ownership of table to this facet.
- * @param refs Passed to the base facet class.
+ * @param __cloc Handle to C locale data.
+ * @param __table If non-zero, table is used as the per-char mask.
+ * @param __del If true, passes ownership of table to this facet.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(__c_locale __cloc, const mask* __table = 0, bool __del = false,
/**
* @brief Test char classification.
*
- * This function compares the mask table[c] to @a m.
+ * This function compares the mask table[c] to @a __m.
*
- * @param c The char to compare the mask of.
- * @param m The mask to compare against.
- * @return True if m & table[c] is true, false otherwise.
+ * @param __c The char to compare the mask of.
+ * @param __m The mask to compare against.
+ * @return True if __m & table[__c] is true, false otherwise.
*/
inline bool
is(mask __m, char __c) const;
* successively writes it to vec. vec must have as many elements as
* the char array.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
inline const char*
is(const char* __lo, const char* __hi, mask* __vec) const;
* This function searches for and returns the first char in [lo,hi) for
* which is(m,char) is true.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching char if found, else @a __hi.
*/
inline const char*
scan_is(mask __m, const char* __lo, const char* __hi) const;
* @brief Find char not matching a mask
*
* This function searches for and returns a pointer to the first char
- * in [lo,hi) for which is(m,char) is false.
+ * in [__lo,__hi) for which is(m,char) is false.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching char if found, else @a __hi.
*/
inline const char*
scan_not(mask __m, const char* __lo, const char* __hi) const;
* toupper() acts as if it returns ctype<char>::do_toupper(c).
* do_toupper() must always return the same result for the same input.
*
- * @param c The char to convert.
- * @return The uppercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The uppercase char if convertible, else @a __c.
*/
char_type
toupper(char_type __c) const
/**
* @brief Convert array to uppercase.
*
- * This function converts each char in the range [lo,hi) to uppercase
+ * This function converts each char in the range [__lo,__hi) to uppercase
* if possible. Other chars remain untouched.
*
- * toupper() acts as if it returns ctype<char>:: do_toupper(lo, hi).
+ * toupper() acts as if it returns ctype<char>:: do_toupper(__lo, __hi).
* do_toupper() must always return the same result for the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
toupper(char_type *__lo, const char_type* __hi) const
* This function converts the char argument to lowercase if possible.
* If not possible (for example, '2'), returns the argument.
*
- * tolower() acts as if it returns ctype<char>::do_tolower(c).
+ * tolower() acts as if it returns ctype<char>::do_tolower(__c).
* do_tolower() must always return the same result for the same input.
*
- * @param c The char to convert.
- * @return The lowercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The lowercase char if convertible, else @a __c.
*/
char_type
tolower(char_type __c) const
* This function converts each char in the range [lo,hi) to lowercase
* if possible. Other chars remain untouched.
*
- * tolower() acts as if it returns ctype<char>:: do_tolower(lo, hi).
+ * tolower() acts as if it returns ctype<char>:: do_tolower(__lo, __hi).
* do_tolower() must always return the same result for the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
tolower(char_type* __lo, const char_type* __hi) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted character.
*/
char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char*
widen(const char* __lo, const char* __hi, char_type* __to) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted character.
*/
char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char_type*
narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char *__to) const
+ char __dfault, char* __to) const
{
if (__builtin_expect(_M_narrow_ok == 1, true))
{
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The char to convert.
- * @return The uppercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The uppercase char if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const;
+ do_toupper(char_type __c) const;
/**
* @brief Convert array to uppercase.
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The char to convert.
- * @return The lowercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The lowercase char if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const;
+ do_tolower(char_type __c) const;
/**
* @brief Convert array to lowercase.
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted character.
*/
virtual char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi, char_type* __dest) const
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const
{
- __builtin_memcpy(__dest, __lo, __hi - __lo);
+ __builtin_memcpy(__to, __lo, __hi - __lo);
return __hi;
}
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type __c, char) const
+ do_narrow(char_type __c, char __dfault) const
{ return __c; }
/**
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char, char* __dest) const
+ char __dfault, char* __to) const
{
- __builtin_memcpy(__dest, __lo, __hi - __lo);
+ __builtin_memcpy(__to, __lo, __hi - __lo);
return __hi;
}
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(size_t __refs = 0);
*
* This constructor is used to construct the initial C locale facet.
*
- * @param cloc Handle to C locale data.
- * @param refs Passed to the base facet class.
+ * @param __cloc Handle to C locale data.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(__c_locale __cloc, size_t __refs = 0);
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param c The wchar_t to find the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The wchar_t to find the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
virtual bool
do_is(mask __m, char_type __c) const;
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
virtual const char_type*
do_is(const char_type* __lo, const char_type* __hi, mask* __vec) const;
* @brief Find wchar_t matching mask
*
* This function searches for and returns the first wchar_t c in
- * [lo,hi) for which is(m,c) is true.
+ * [__lo,__hi) for which is(__m,c) is true.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching wchar_t if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching wchar_t if found, else @a __hi.
*/
virtual const char_type*
do_scan_is(mask __m, const char_type* __lo, const char_type* __hi) const;
* @brief Find wchar_t not matching mask
*
* This function searches for and returns a pointer to the first
- * wchar_t c of [lo,hi) for which is(m,c) is false.
+ * wchar_t c of [__lo,__hi) for which is(__m,c) is false.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching wchar_t if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching wchar_t if found, else @a __hi.
*/
virtual const char_type*
do_scan_not(mask __m, const char_type* __lo,
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The wchar_t to convert.
- * @return The uppercase wchar_t if convertible, else @a c.
+ * @param __c The wchar_t to convert.
+ * @return The uppercase wchar_t if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const;
+ do_toupper(char_type __c) const;
/**
* @brief Convert array to uppercase.
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The wchar_t to convert.
- * @return The lowercase wchar_t if convertible, else @a c.
+ * @param __c The wchar_t to convert.
+ * @return The lowercase wchar_t if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const;
+ do_tolower(char_type __c) const;
/**
* @brief Convert array to lowercase.
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted wchar_t.
*/
virtual char_type
- do_widen(char) const;
+ do_widen(char __c) const;
/**
* @brief Widen char array to wchar_t array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi, char_type* __dest) const;
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const;
/**
* @brief Narrow wchar_t to char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The wchar_t to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The wchar_t to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type, char __dfault) const;
+ do_narrow(char_type __c, char __dfault) const;
/**
* @brief Narrow wchar_t array to char array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const;
+ char __dfault, char* __to) const;
// For use at construction time only.
void
/**
* @brief Numpunct constructor.
*
- * @param refs Refcount to pass to the base class.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(size_t __refs = 0)
* This is a constructor for use by the library itself to set up the
* predefined locale facets.
*
- * @param cache __numpunct_cache object.
- * @param refs Refcount to pass to the base class.
+ * @param __cache __numpunct_cache object.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(__cache_type* __cache, size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param refs Refcount to pass to the base class.
+ * @param __cloc The C locale.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(__c_locale __cloc, size_t __refs = 0)
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
num_get(size_t __refs = 0) : facet(__refs) { }
* except if the value is 1, sets @a v to true, if the value is 0, sets
* @a v to false, and otherwise set err to ios_base::failbit.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* hook for derived classes to change the value returned. @see get()
* for more details.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __beg Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
- virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, bool&) const;
-
virtual iter_type
do_get(iter_type __beg, iter_type __end, ios_base& __io,
ios_base::iostate& __err, long& __v) const
#endif
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
- float&) const;
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, bool&) const;
+
+ virtual iter_type
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, float&) const;
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
double&) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- __do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ __do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
double&) const;
#else
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
long double&) const;
#endif
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
- void*&) const;
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, void*&) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
long double&) const;
#endif
//@}
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
num_put(size_t __refs = 0) : facet(__refs) { }
* If ios_base::boolalpha is set, writes ctype<CharT>::truename() or
* ctype<CharT>::falsename(). Otherwise formats @a v as an int.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, bool __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, bool __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
//@{
/**
* immediately after either a '+' or '-' or after '0x' or '0X'.
* Otherwise, padding occurs at the beginning.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, long __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
unsigned long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
#ifdef _GLIBCXX_USE_LONG_LONG
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, long long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, long long __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
unsigned long long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
#endif
//@}
* immediately after either a '+' or '-' or after '0x' or '0X'.
* Otherwise, padding occurs at the beginning.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, double __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, double __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
long double __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
//@}
/**
* This function formats @a v as an unsigned long with ios_base::hex
* and ios_base::showbase set.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
const void* __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
protected:
template<typename _ValueT>
* inserting them into a stream. This function is a hook for derived
* classes to change the value returned.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, bool __v) const;
+ do_put(iter_type __s, ios_base& __io, char_type __fill, bool __v) const;
virtual iter_type
do_put(iter_type __s, ios_base& __io, char_type __fill, long __v) const
#endif
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, double __v) const;
+ do_put(iter_type, ios_base&, char_type, double) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- __do_put(iter_type, ios_base&, char_type __fill, double __v) const;
+ __do_put(iter_type, ios_base&, char_type, double) const;
#else
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
+ do_put(iter_type, ios_base&, char_type, long double) const;
#endif
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, const void* __v) const;
+ do_put(iter_type, ios_base&, char_type, const void*) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
+ do_put(iter_type, ios_base&, char_type, long double) const;
#endif
//@}
};
{ return use_facet<ctype<_CharT> >(__loc).tolower(__c); }
_GLIBCXX_END_NAMESPACE_VERSION
-} // namespace
+} // namespace std
# include <bits/locale_facets.tcc>
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
* @param refs Passed to the base facet class.
*/
explicit
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
time_get(size_t __refs = 0)
* the end, err |= ios_base::failbit. If parsing reads all the
* characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond time string.
*/
iter_type
* the end, err |= ios_base::failbit. If parsing reads all the
* characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond date string.
*/
iter_type
* If an error occurs before the end, err |= ios_base::failbit. If
* parsing reads all the characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond weekday name.
*/
iter_type
* parsing reads all the characters, err |=
* ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond month name.
*/
iter_type
* If an error occurs before the end, err |= ios_base::failbit. If
* parsing reads all the characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond year.
*/
iter_type
* derived classes to change the value returned. @see get_time() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond time string.
*/
virtual iter_type
* derived classes to change the value returned. @see get_date() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond date string.
*/
virtual iter_type
* classes to change the value returned. @see get_weekday() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond weekday name.
*/
virtual iter_type
* classes to change the value returned. @see get_monthname() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond month name.
*/
virtual iter_type
* hook for derived classes to change the value returned. @see
* get_year() for details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond year.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
time_put(size_t __refs = 0)
* provided format string. The format string is interpreted as by
* strftime().
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param beg Start of format string.
- * @param end End of format string.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __beg Start of format string.
+ * @param __end End of format string.
* @return Iterator after writing.
*/
iter_type
* are interpreted as by strftime(). It does so by returning
* time_put::do_put().
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param format Format char.
- * @param mod Optional modifier char.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __format Format char.
+ * @param __mod Optional modifier char.
* @return Iterator after writing.
*/
iter_type
* for derived classes to change the value returned. @see put() for
* more details.
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param format Format char.
- * @param mod Optional modifier char.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __format Format char.
+ * @param __mod Optional modifier char.
* @return Iterator after writing.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(size_t __refs = 0)
*
* This is an internal constructor.
*
- * @param cache Cache for optimization.
- * @param refs Passed to the base facet class.
+ * @param __cache Cache for optimization.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(__cache_type* __cache, size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
- * @param refs Passed to the base facet class.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(__c_locale __cloc, const char* __s, size_t __refs = 0)
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
money_get(size_t __refs = 0) : facet(__refs) { }
/**
* @brief Read and parse a monetary value.
*
- * This function reads characters from @a s, interprets them as a
+ * 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 units as an integral
* value moneypunct::frac_digits() * the actual amount. For example,
*
* This function works by returning the result of do_get().
*
- * @param s Start of characters to parse.
- * @param end End of characters to parse.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param err Error field to set if parsing fails.
- * @param units Place to store result of parsing.
+ * @param __s Start of characters to parse.
+ * @param __end End of characters to parse.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __err Error field to set if parsing fails.
+ * @param __units Place to store result of parsing.
* @return Iterator referencing first character beyond valid money
* amount.
*/
/**
* @brief Read and parse a monetary value.
*
- * This function reads characters from @a s, interprets them as
+ * 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
*
* This function works by returning the result of do_get().
*
- * @param s Start of characters to parse.
- * @param end End of characters to parse.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param err Error field to set if parsing fails.
- * @param digits Place to store result of parsing.
+ * @param __s Start of characters to parse.
+ * @param __end End of characters to parse.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __err Error field to set if parsing fails.
+ * @param __digits Place to store result of parsing.
* @return Iterator referencing first character beyond valid money
* amount.
*/
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
money_put(size_t __refs = 0) : facet(__refs) { }
*
* 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 <code>$10.01</code> to @a s.
+ * the resulting characters to @a __s. For example, the value 1001 in a
+ * US locale would write <code>$10.01</code> to @a __s.
*
* This function works by returning the result of do_put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __units Place to store result of parsing.
* @return Iterator after writing.
*/
iter_type
*
* 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.
+ * 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.
+ * would write <code>$10.01</code> to @a __s.
*
* This function works by returning the result of do_put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __digits Place to store result of parsing.
* @return Iterator after writing.
*/
iter_type
*
* 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 <code>$10.01</code> to @a s.
+ * the resulting characters to @a __s. For example, the value 1001 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().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __units Place to store result of parsing.
* @return Iterator after writing.
*/
// XXX GLIBCXX_ABI Deprecated
*
* 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.
+ * 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.
+ * would write <code>$10.01</code> to @a __s.
*
* This function is a hook for derived classes to change the value
* returned. @see put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __digits Place to store result of parsing.
* @return Iterator after writing.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
messages(size_t __refs = 0);
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
- * @param refs Refcount to pass to the base class.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
messages(__c_locale __cloc, const char* __s, size_t __refs = 0);
* @brief Open a message catalog.
*
* This function opens and returns a handle to a message catalog by
- * returning do_open(s, loc).
+ * returning do_open(__s, __loc).
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
* @return Handle to the catalog or value < 0 if open fails.
*/
catalog
* message catalog root directory for gnu gettext and is ignored
* otherwise.
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
- * @param dir Message catalog root directory.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
+ * @param __dir Message catalog root directory.
* @return Handle to the catalog or value < 0 if open fails.
*/
catalog
* This function retrieves and returns a message from a catalog by
* returning do_get(c, set, msgid, s).
*
- * For gnu, @a set and @a msgid are ignored. Returns gettext(s).
+ * For gnu, @a __set and @a msgid are ignored. Returns gettext(s).
* For default, returns s. For ieee, returns catgets(c,set,msgid,s).
*
- * @param c The catalog to access.
- * @param set Implementation-defined.
- * @param msgid Implementation-defined.
- * @param s Default return value if retrieval fails.
- * @return Retrieved message or @a s if get fails.
+ * @param __c The catalog to access.
+ * @param __set Implementation-defined.
+ * @param __msgid Implementation-defined.
+ * @param __s Default return value if retrieval fails.
+ * @return Retrieved message or @a __s if get fails.
*/
string_type
get(catalog __c, int __set, int __msgid, const string_type& __s) const
*
* Closes catalog @a c by calling do_close(c).
*
- * @param c The catalog to close.
+ * @param __c The catalog to close.
*/
void
close(catalog __c) const
* implementation-defined manner. This function is a hook for derived
* classes to change the value returned.
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
* @return Handle to the opened catalog, value < 0 if open failed.
*/
virtual catalog
* implementation-defined manner. This function is a hook for derived
* classes to change the value returned.
*
- * For gnu, @a set and @a msgid are ignored. Returns gettext(s).
+ * For gnu, @a __set and @a __msgid are ignored. Returns gettext(s).
* For default, returns s. For ieee, returns catgets(c,set,msgid,s).
*
- * @param c The catalog to access.
- * @param set Implementation-defined.
- * @param msgid Implementation-defined.
- * @param s Default return value if retrieval fails.
- * @return Retrieved message or @a s if get fails.
+ * @param __c The catalog to access.
+ * @param __set Implementation-defined.
+ * @param __msgid Implementation-defined.
+ * @param __s Default return value if retrieval fails.
+ * @return Retrieved message or @a __s if get fails.
*/
virtual string_type
do_get(catalog, int, int, const string_type& __dfault) const;
/*
* @brief Close a message catalog.
*
- * @param c The catalog to close.
+ * @param __c The catalog to close.
*/
virtual void
do_close(catalog) const;
string_type
_M_convert_from_char(char*) const
{
-#if 0
- // Length of message string without terminating null.
- size_t __len = char_traits<char>::length(__msg) - 1;
-
- // "everybody can easily convert the string using
- // mbsrtowcs/wcsrtombs or with iconv()"
-
- // Convert char* to _CharT in locale used to open catalog.
- // XXX need additional template parameter on messages class for this..
- // typedef typename codecvt<char, _CharT, _StateT> __codecvt_type;
- typedef typename codecvt<char, _CharT, mbstate_t> __codecvt_type;
-
- __codecvt_type::state_type __state;
- // XXX may need to initialize state.
- //initialize_state(__state._M_init());
-
- char* __from_next;
- // XXX what size for this string?
- _CharT* __to = static_cast<_CharT*>(__builtin_alloca(__len + 1));
- const __codecvt_type& __cvt = use_facet<__codecvt_type>(_M_locale_conv);
- __cvt.out(__state, __msg, __msg + __len, __from_next,
- __to, __to + __len + 1, __to_next);
- return string_type(__to);
-#endif
-#if 0
- typedef ctype<_CharT> __ctype_type;
- // const __ctype_type& __cvt = use_facet<__ctype_type>(_M_locale_msg);
- const __ctype_type& __cvt = use_facet<__ctype_type>(locale());
- // XXX Again, proper length of converted string an issue here.
- // For now, assume the converted length is not larger.
- _CharT* __dest = static_cast<_CharT*>(__builtin_alloca(__len + 1));
- __cvt.widen(__msg, __msg + __len, __dest);
- return basic_string<_CharT>(__dest);
-#endif
+ // XXX
return string_type();
}
};
/**
* @brief Obtain a pointer to an object
- * @param r A reference to an object of type @c element_type
- * @return @c addressof(r)
+ * @param __r A reference to an object of type @c element_type
+ * @return @c addressof(__r)
*/
static pointer
pointer_to(typename __ptrtr_not_void<element_type>::__type& __r) noexcept
template<typename _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
_UIntType1 __m1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::linear_congruential_engine<_UIntType1,
- __a1, __c1, __m1>&);
+ __a1, __c1, __m1>& __lcr);
/**
* @brief Sets the state of the engine by reading its textual
template<typename _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
_UIntType1 __m1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::linear_congruential_engine<_UIntType1, __a1,
- __c1, __m1>&);
+ __c1, __m1>& __lcr);
private:
_UIntType _M_x;
* This algorithm was originally invented by Makoto Matsumoto and
* Takuji Nishimura.
*
- * @var word_size The number of bits in each element of the state vector.
- * @var state_size The degree of recursion.
- * @var shift_size The period parameter.
- * @var mask_bits The separation point bit index.
- * @var parameter_a The last row of the twist matrix.
- * @var output_u The first right-shift tempering matrix parameter.
- * @var output_s The first left-shift tempering matrix parameter.
- * @var output_b The first left-shift tempering matrix mask.
- * @var output_t The second left-shift tempering matrix parameter.
- * @var output_c The second left-shift tempering matrix mask.
- * @var output_l The second right-shift tempering matrix parameter.
+ * @tparam __w Word size, the number of bits in each element of
+ * the state vector.
+ * @tparam __n The degree of recursion.
+ * @tparam __m The period parameter.
+ * @tparam __r The separation point bit index.
+ * @tparam __a The last row of the twist matrix.
+ * @tparam __u The first right-shift tempering matrix parameter.
+ * @tparam __d The first right-shift tempering matrix mask.
+ * @tparam __s The first left-shift tempering matrix parameter.
+ * @tparam __b The first left-shift tempering matrix mask.
+ * @tparam __t The second left-shift tempering matrix parameter.
+ * @tparam __c The second left-shift tempering matrix mask.
+ * @tparam __l The second right-shift tempering matrix parameter.
+ * @tparam __f Initialization multiplier.
*/
template<typename _UIntType, size_t __w,
size_t __n, size_t __m, size_t __r,
_UIntType1 __c1, size_t __l1, _UIntType1 __f1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::mersenne_twister_engine<_UIntType1, __w1, __n1,
__m1, __r1, __a1, __u1, __d1, __s1, __b1, __t1, __c1,
- __l1, __f1>&);
+ __l1, __f1>& __x);
/**
* @brief Extracts the current state of a % mersenne_twister_engine
_UIntType1 __c1, size_t __l1, _UIntType1 __f1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::mersenne_twister_engine<_UIntType1, __w1, __n1, __m1,
__r1, __a1, __u1, __d1, __s1, __b1, __t1, __c1,
- __l1, __f1>&);
+ __l1, __f1>& __x);
private:
_UIntType _M_x[state_size];
* @brief Copy constructs a %discard_block_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- discard_block_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne), _M_n(0) { }
+ discard_block_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng), _M_n(0) { }
/**
* @brief Move constructs a %discard_block_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- discard_block_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne)), _M_n(0) { }
+ discard_block_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng)), _M_n(0) { }
/**
* @brief Seed constructs a %discard_block_engine engine.
template<typename _RandomNumberEngine1, size_t __p1, size_t __r1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::discard_block_engine<_RandomNumberEngine1,
- __p1, __r1>&);
+ __p1, __r1>& __x);
/**
* @brief Extracts the current state of a % subtract_with_carry_engine
template<typename _RandomNumberEngine1, size_t __p1, size_t __r1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::discard_block_engine<_RandomNumberEngine1,
- __p1, __r1>&);
+ __p1, __r1>& __x);
private:
_RandomNumberEngine _M_b;
* @brief Copy constructs a %independent_bits_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- independent_bits_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne) { }
+ independent_bits_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng) { }
/**
* @brief Move constructs a %independent_bits_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- independent_bits_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne)) { }
+ independent_bits_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng)) { }
/**
* @brief Seed constructs a %independent_bits_engine engine.
* @brief Copy constructs a %shuffle_order_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- shuffle_order_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne)
+ shuffle_order_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng)
{ _M_initialize(); }
/**
* @brief Move constructs a %shuffle_order_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- shuffle_order_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne))
+ shuffle_order_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng))
{ _M_initialize(); }
/**
template<typename _RandomNumberEngine1, size_t __k1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::shuffle_order_engine<_RandomNumberEngine1,
- __k1>&);
+ __k1>& __x);
/**
* @brief Extracts the current state of a % subtract_with_carry_engine
template<typename _RandomNumberEngine1, size_t __k1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::shuffle_order_engine<_RandomNumberEngine1, __k1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::shuffle_order_engine<_RandomNumberEngine1, __k1>& __x);
private:
void _M_initialize()
/**
* @brief Constructs a uniform_real_distribution object.
*
- * @param __min [IN] The lower bound of the distribution.
- * @param __max [IN] The upper bound of the distribution.
+ * @param __a [IN] The lower bound of the distribution.
+ * @param __b [IN] The upper bound of the distribution.
*/
explicit
uniform_real_distribution(_RealType __a = _RealType(0),
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::normal_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::normal_distribution<_RealType1>& __x);
/**
* @brief Extracts a %normal_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::normal_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::normal_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::lognormal_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::lognormal_distribution<_RealType1>& __x);
/**
* @brief Extracts a %lognormal_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::lognormal_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::lognormal_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::gamma_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::gamma_distribution<_RealType1>& __x);
/**
* @brief Extracts a %gamma_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::gamma_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::gamma_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::chi_squared_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::chi_squared_distribution<_RealType1>& __x);
/**
* @brief Extracts a %chi_squared_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::chi_squared_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::chi_squared_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::cauchy_distribution<_RealType>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::cauchy_distribution<_RealType>& __x);
/**
* @brief Extracts a %cauchy_distribution random number distribution
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::cauchy_distribution<_RealType>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::cauchy_distribution<_RealType>& __x);
/**
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::fisher_f_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::fisher_f_distribution<_RealType1>& __x);
/**
* @brief Extracts a %fisher_f_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::fisher_f_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::fisher_f_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::student_t_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::student_t_distribution<_RealType1>& __x);
/**
* @brief Extracts a %student_t_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::student_t_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::student_t_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::bernoulli_distribution&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::bernoulli_distribution& __x);
/**
* @brief Extracts a %bernoulli_distribution random number distribution
template<typename _IntType1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::binomial_distribution<_IntType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::binomial_distribution<_IntType1>& __x);
/**
* @brief Extracts a %binomial_distribution random number distribution
template<typename _IntType1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::binomial_distribution<_IntType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::binomial_distribution<_IntType1>& __x);
private:
template<typename _UniformRandomNumberGenerator>
template<typename _IntType,
typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::geometric_distribution<_IntType>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::geometric_distribution<_IntType>& __x);
/**
* @brief Extracts a %geometric_distribution random number distribution
template<typename _IntType,
typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::geometric_distribution<_IntType>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::geometric_distribution<_IntType>& __x);
/**
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::negative_binomial_distribution<_IntType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::negative_binomial_distribution<_IntType1>& __x);
/**
* @brief Extracts a %negative_binomial_distribution random number
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::negative_binomial_distribution<_IntType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::negative_binomial_distribution<_IntType1>& __x);
private:
param_type _M_param;
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::poisson_distribution<_IntType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::poisson_distribution<_IntType1>& __x);
/**
* @brief Extracts a %poisson_distribution random number distribution
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::poisson_distribution<_IntType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::poisson_distribution<_IntType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::exponential_distribution<_RealType>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::exponential_distribution<_RealType>& __x);
/**
* @brief Extracts a %exponential_distribution random number distribution
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::exponential_distribution<_RealType>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::exponential_distribution<_RealType>& __x);
/**
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::weibull_distribution<_RealType>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::weibull_distribution<_RealType>& __x);
/**
* @brief Extracts a %weibull_distribution random number distribution
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::weibull_distribution<_RealType>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::weibull_distribution<_RealType>& __x);
/**
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::extreme_value_distribution<_RealType>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::extreme_value_distribution<_RealType>& __x);
/**
* @brief Extracts a %extreme_value_distribution random number
*/
template<typename _RealType, typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::extreme_value_distribution<_RealType>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::extreme_value_distribution<_RealType>& __x);
/**
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::discrete_distribution<_IntType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::discrete_distribution<_IntType1>& __x);
/**
* @brief Extracts a %discrete_distribution random number distribution
*/
template<typename _IntType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::discrete_distribution<_IntType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::discrete_distribution<_IntType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::piecewise_constant_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::piecewise_constant_distribution<_RealType1>& __x);
/**
* @brief Extracts a %piecewise_constan_distribution random
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::piecewise_constant_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::piecewise_constant_distribution<_RealType1>& __x);
private:
param_type _M_param;
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::piecewise_linear_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::piecewise_linear_distribution<_RealType1>& __x);
/**
* @brief Extracts a %piecewise_linear_distribution random number
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::piecewise_linear_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::piecewise_linear_distribution<_RealType1>& __x);
private:
param_type _M_param;
/**
* @brief Return an iterator pointing to the first element of
* the container.
- * @param cont Container.
+ * @param __cont Container.
*/
template<class _Container>
inline auto
/**
* @brief Return an iterator pointing to the first element of
* the const container.
- * @param cont Container.
+ * @param __cont Container.
*/
template<class _Container>
inline auto
/**
* @brief Return an iterator pointing to one past the last element of
* the container.
- * @param cont Container.
+ * @param __cont Container.
*/
template<class _Container>
inline auto
/**
* @brief Return an iterator pointing to one past the last element of
* the const container.
- * @param cont Container.
+ * @param __cont Container.
*/
template<class _Container>
inline auto
/**
* @brief Return an iterator pointing to the first element of the array.
- * @param arr Array.
+ * @param __arr Array.
*/
template<class _Tp, size_t _Nm>
inline _Tp*
/**
* @brief Return an iterator pointing to one past the last element
* of the array.
- * @param arr Array.
+ * @param __arr Array.
*/
template<class _Tp, size_t _Nm>
inline _Tp*
/**
* @brief Performs the identity translation.
*
- * @param c A character to the locale-specific character set.
+ * @param __c A character to the locale-specific character set.
*
- * @returns c.
+ * @returns __c.
*/
char_type
translate(char_type __c) const
/**
* @brief Translates a character into a case-insensitive equivalent.
*
- * @param c A character to the locale-specific character set.
+ * @param __c A character to the locale-specific character set.
*
- * @returns the locale-specific lower-case equivalent of c.
+ * @returns the locale-specific lower-case equivalent of __c.
* @throws std::bad_cast if the imbued locale does not support the ctype
* facet.
*/
/**
* @brief Gets a sort key for a character sequence.
*
- * @param first beginning of the character sequence.
- * @param last one-past-the-end of the character sequence.
+ * @param __first beginning of the character sequence.
+ * @param __last one-past-the-end of the character sequence.
*
* Returns a sort key for the character sequence designated by the
* iterator range [F1, F2) such that if the character sequence [G1, G2)
/**
* @brief Gets a sort key for a character sequence, independant of case.
*
- * @param first beginning of the character sequence.
- * @param last one-past-the-end of the character sequence.
+ * @param __first beginning of the character sequence.
+ * @param __last one-past-the-end of the character sequence.
*
* Effects: if typeid(use_facet<collate<_Ch_type> >) ==
* typeid(collate_byname<_Ch_type>) and the form of the sort key
- * returned by collate_byname<_Ch_type>::transform(first, last) is known
- * and can be converted into a primary sort key then returns that key,
- * otherwise returns an empty string.
+ * returned by collate_byname<_Ch_type>::transform(__first, __last)
+ * is known and can be converted into a primary sort key
+ * then returns that key, otherwise returns an empty string.
*
* @todo Implement this function.
*/
/**
* @brief Gets a collation element by name.
*
- * @param first beginning of the collation element name.
- * @param last one-past-the-end of the collation element name.
+ * @param __first beginning of the collation element name.
+ * @param __last one-past-the-end of the collation element name.
*
* @returns a sequence of one or more characters that represents the
* collating element consisting of the character sequence designated by
- * the iterator range [first, last). Returns an empty string if the
+ * the iterator range [__first, __last). Returns an empty string if the
* character sequence is not a valid collating element.
*
* @todo Implement this function.
* @brief Maps one or more characters to a named character
* classification.
*
- * @param first beginning of the character sequence.
- * @param last one-past-the-end of the character sequence.
- * @param icase ignores the case of the classification name.
+ * @param __first beginning of the character sequence.
+ * @param __last one-past-the-end of the character sequence.
+ * @param __icase ignores the case of the classification name.
*
* @returns an unspecified value that represents the character
- * classification named by the character sequence designated by the
- * iterator range [first, last). If @p icase is true, the returned mask
- * identifies the classification regardless of the case of the characters
- * to be matched (for example, [[:lower:]] is the same as [[:alpha:]]),
- * otherwise a case-dependant classification is returned. The value
- * returned shall be independent of the case of the characters in the
- * character sequence. If the name is not recognized then returns a value
- * that compares equal to 0.
+ * classification named by the character sequence designated by
+ * the iterator range [__first, __last). If @p icase is true,
+ * the returned mask identifies the classification regardless of
+ * the case of the characters to be matched (for example,
+ * [[:lower:]] is the same as [[:alpha:]]), otherwise a
+ * case-dependant classification is returned. The value
+ * returned shall be independent of the case of the characters
+ * in the character sequence. If the name is not recognized then
+ * returns a value that compares equal to 0.
*
* At least the following names (or their wide-character equivalent) are
* supported.
/**
* @brief Determines if @p c is a member of an identified class.
*
- * @param c a character.
- * @param f a class type (as returned from lookup_classname).
+ * @param __c a character.
+ * @param __f a class type (as returned from lookup_classname).
*
- * @returns true if the character @p c is a member of the classification
- * represented by @p f, false otherwise.
+ * @returns true if the character @p __c is a member of the classification
+ * represented by @p __f, false otherwise.
*
* @throws std::bad_cast if the current locale does not have a ctype
* facet.
/**
* @brief Converts a digit to an int.
*
- * @param ch a character representing a digit.
- * @param radix the radix if the numeric conversion (limited to 8, 10,
+ * @param __ch a character representing a digit.
+ * @param __radix the radix if the numeric conversion (limited to 8, 10,
* or 16).
*
- * @returns the value represented by the digit ch in base radix if the
- * character ch is a valid digit in base radix; otherwise returns -1.
+ * @returns the value represented by the digit __ch in base radix if the
+ * character __ch is a valid digit in base radix; otherwise returns -1.
*/
int
value(_Ch_type __ch, int __radix) const;
/**
* @brief Imbues the regex_traits object with a copy of a new locale.
*
- * @param loc A locale.
+ * @param __loc A locale.
*
* @returns a copy of the previous locale in use by the regex_traits
* object.
{ }
/**
- * @brief Constructs a basic regular expression from the sequence
- * [p, p + char_traits<_Ch_type>::length(p)) interpreted according to the
- * flags in @p f.
+ * @brief Constructs a basic regular expression from the
+ * sequence [__p, __p + char_traits<_Ch_type>::length(__p))
+ * interpreted according to the flags in @p __f.
*
- * @param p A pointer to the start of a C-style null-terminated string
+ * @param __p A pointer to the start of a C-style null-terminated string
* containing a regular expression.
- * @param f Flags indicating the syntax rules and options.
+ * @param __f Flags indicating the syntax rules and options.
*
- * @throws regex_error if @p p is not a valid regular expression.
+ * @throws regex_error if @p __p is not a valid regular expression.
*/
explicit
basic_regex(const _Ch_type* __p,
* @brief Constructs a basic regular expression from the sequence
* [p, p + len) interpreted according to the flags in @p f.
*
- * @param p A pointer to the start of a string containing a regular
- * expression.
- * @param len The length of the string containing the regular expression.
- * @param f Flags indicating the syntax rules and options.
+ * @param __p A pointer to the start of a string containing a regular
+ * expression.
+ * @param __len The length of the string containing the regular
+ * expression.
+ * @param __f Flags indicating the syntax rules and options.
*
- * @throws regex_error if @p p is not a valid regular expression.
+ * @throws regex_error if @p __p is not a valid regular expression.
*/
basic_regex(const _Ch_type* __p, std::size_t __len, flag_type __f)
: _M_flags(__f),
/**
* @brief Copy-constructs a basic regular expression.
*
- * @param rhs A @p regex object.
+ * @param __rhs A @p regex object.
*/
basic_regex(const basic_regex& __rhs)
: _M_flags(__rhs._M_flags), _M_traits(__rhs._M_traits),
/**
* @brief Move-constructs a basic regular expression.
*
- * @param rhs A @p regex object.
+ * @param __rhs A @p regex object.
*/
basic_regex(const basic_regex&& __rhs) noexcept
: _M_flags(__rhs._M_flags), _M_traits(__rhs._M_traits),
* @brief Constructs a basic regular expression from the string
* @p s interpreted according to the flags in @p f.
*
- * @param s A string containing a regular expression.
- * @param f Flags indicating the syntax rules and options.
+ * @param __s A string containing a regular expression.
+ * @param __f Flags indicating the syntax rules and options.
*
- * @throws regex_error if @p s is not a valid regular expression.
+ * @throws regex_error if @p __s is not a valid regular expression.
*/
template<typename _Ch_traits, typename _Ch_alloc>
explicit
* @brief Constructs a basic regular expression from the range
* [first, last) interpreted according to the flags in @p f.
*
- * @param first The start of a range containing a valid regular
- * expression.
- * @param last The end of a range containing a valid regular
- * expression.
- * @param f The format flags of the regular expression.
+ * @param __first The start of a range containing a valid regular
+ * expression.
+ * @param __last The end of a range containing a valid regular
+ * expression.
+ * @param __f The format flags of the regular expression.
*
- * @throws regex_error if @p [first, last) is not a valid regular
+ * @throws regex_error if @p [__first, __last) is not a valid regular
* expression.
*/
template<typename _InputIterator>
/**
* @brief Constructs a basic regular expression from an initializer list.
*
- * @param l The initializer list.
- * @param f The format flags of the regular expression.
+ * @param __l The initializer list.
+ * @param __f The format flags of the regular expression.
*
- * @throws regex_error if @p l is not a valid regular expression.
+ * @throws regex_error if @p __l is not a valid regular expression.
*/
basic_regex(initializer_list<_Ch_type> __l,
flag_type __f = regex_constants::ECMAScript)
* @brief Replaces a regular expression with a new one constructed from
* a C-style null-terminated string.
*
- * @param A pointer to the start of a null-terminated C-style string
+ * @param __p A pointer to the start of a null-terminated C-style string
* containing a regular expression.
*/
basic_regex&
* @brief Replaces a regular expression with a new one constructed from
* a string.
*
- * @param A pointer to a string containing a regular expression.
+ * @param __s A pointer to a string containing a regular expression.
*/
template<typename _Ch_typeraits, typename _Allocator>
basic_regex&
/**
* @brief the real assignment operator.
*
- * @param rhs Another regular expression object.
+ * @param __rhs Another regular expression object.
*/
basic_regex&
assign(const basic_regex& __rhs)
/**
* @brief The move-assignment operator.
*
- * @param rhs Another regular expression object.
+ * @param __rhs Another regular expression object.
*/
basic_regex&
assign(basic_regex&& __rhs) noexcept
* C-style null-terminated string containing a regular expression
* pattern.
*
- * @param p A pointer to a C-style null-terminated string containing
+ * @param __p A pointer to a C-style null-terminated string containing
* a regular expression pattern.
- * @param flags Syntax option flags.
+ * @param __flags Syntax option flags.
*
- * @throws regex_error if p does not contain a valid regular expression
- * pattern interpreted according to @p flags. If regex_error is thrown,
- * *this remains unchanged.
+ * @throws regex_error if __p does not contain a valid regular
+ * expression pattern interpreted according to @p __flags. If
+ * regex_error is thrown, *this remains unchanged.
*/
basic_regex&
assign(const _Ch_type* __p,
* @brief Assigns a new regular expression to a regex object from a
* C-style string containing a regular expression pattern.
*
- * @param p A pointer to a C-style string containing a
- * regular expression pattern.
- * @param len The length of the regular expression pattern string.
- * @param flags Syntax option flags.
+ * @param __p A pointer to a C-style string containing a
+ * regular expression pattern.
+ * @param __len The length of the regular expression pattern string.
+ * @param __flags Syntax option flags.
*
- * @throws regex_error if p does not contain a valid regular expression
- * pattern interpreted according to @p flags. If regex_error is thrown,
- * *this remains unchanged.
+ * @throws regex_error if p does not contain a valid regular
+ * expression pattern interpreted according to @p __flags. If
+ * regex_error is thrown, *this remains unchanged.
*/
basic_regex&
assign(const _Ch_type* __p, std::size_t __len, flag_type __flags)
* @brief Assigns a new regular expression to a regex object from a
* string containing a regular expression pattern.
*
- * @param s A string containing a regular expression pattern.
- * @param flags Syntax option flags.
+ * @param __s A string containing a regular expression pattern.
+ * @param __flags Syntax option flags.
*
- * @throws regex_error if p does not contain a valid regular expression
- * pattern interpreted according to @p flags. If regex_error is thrown,
- * *this remains unchanged.
+ * @throws regex_error if __s does not contain a valid regular
+ * expression pattern interpreted according to @p __flags. If
+ * regex_error is thrown, *this remains unchanged.
*/
template<typename _Ch_typeraits, typename _Allocator>
basic_regex&
assign(const basic_string<_Ch_type, _Ch_typeraits, _Allocator>& __s,
- flag_type __f = regex_constants::ECMAScript)
+ flag_type __flags = regex_constants::ECMAScript)
{
- basic_regex __tmp(__s, __f);
+ basic_regex __tmp(__s, __flags);
this->swap(__tmp);
return *this;
}
/**
* @brief Assigns a new regular expression to a regex object.
*
- * @param first The start of a range containing a valid regular
- * expression.
- * @param last The end of a range containing a valid regular
- * expression.
- * @param flags Syntax option flags.
+ * @param __first The start of a range containing a valid regular
+ * expression.
+ * @param __last The end of a range containing a valid regular
+ * expression.
+ * @param __flags Syntax option flags.
*
- * @throws regex_error if p does not contain a valid regular expression
- * pattern interpreted according to @p flags. If regex_error is thrown,
- * the object remains unchanged.
+ * @throws regex_error if p does not contain a valid regular
+ * expression pattern interpreted according to @p __flags. If
+ * regex_error is thrown, the object remains unchanged.
*/
template<typename _InputIterator>
basic_regex&
/**
* @brief Assigns a new regular expression to a regex object.
*
- * @param l An initializer list representing a regular expression.
- * @param flags Syntax option flags.
+ * @param __l An initializer list representing a regular expression.
+ * @param __flags Syntax option flags.
*
- * @throws regex_error if @p l does not contain a valid regular
- * expression pattern interpreted according to @p flags. If regex_error
- * is thrown, the object remains unchanged.
+ * @throws regex_error if @p __l does not contain a valid
+ * regular expression pattern interpreted according to @p
+ * __flags. If regex_error is thrown, the object remains
+ * unchanged.
*/
basic_regex&
assign(initializer_list<_Ch_type> __l,
- flag_type __f = regex_constants::ECMAScript)
- { return this->assign(__l.begin(), __l.end(), __f); }
+ flag_type __flags = regex_constants::ECMAScript)
+ { return this->assign(__l.begin(), __l.end(), __flags); }
// [7.8.4] const operations
/**
/**
* @brief Imbues the regular expression object with the given locale.
*
- * @param loc A locale.
+ * @param __loc A locale.
*/
locale_type
imbue(locale_type __loc)
/**
* @brief Swaps the contents of two regular expression objects.
*
- * @param rhs Another regular expression object.
+ * @param __rhs Another regular expression object.
*/
void
swap(basic_regex& __rhs)
// [7.8.6] basic_regex swap
/**
* @brief Swaps the contents of two regular expression objects.
- * @param lhs First regular expression.
- * @param rhs Second regular expression.
+ * @param __lhs First regular expression.
+ * @param __rhs Second regular expression.
*/
template<typename _Ch_type, typename _Rx_traits>
inline void
/**
* @brief Compares this and another matched sequence.
*
- * @param s Another matched sequence to compare to this one.
+ * @param __s Another matched sequence to compare to this one.
*
- * @retval <0 this matched sequence will collate before @p s.
- * @retval =0 this matched sequence is equivalent to @p s.
- * @retval <0 this matched sequence will collate after @p s.
+ * @retval <0 this matched sequence will collate before @p __s.
+ * @retval =0 this matched sequence is equivalent to @p __s.
+ * @retval <0 this matched sequence will collate after @p __s.
*/
int
compare(const sub_match& __s) const
/**
* @brief Compares this sub_match to a string.
*
- * @param s A string to compare to this sub_match.
+ * @param __s A string to compare to this sub_match.
*
- * @retval <0 this matched sequence will collate before @p s.
- * @retval =0 this matched sequence is equivalent to @p s.
- * @retval <0 this matched sequence will collate after @p s.
+ * @retval <0 this matched sequence will collate before @p __s.
+ * @retval =0 this matched sequence is equivalent to @p __s.
+ * @retval <0 this matched sequence will collate after @p __s.
*/
int
compare(const string_type& __s) const
/**
* @brief Compares this sub_match to a C-style string.
*
- * @param s A C-style string to compare to this sub_match.
+ * @param __s A C-style string to compare to this sub_match.
*
- * @retval <0 this matched sequence will collate before @p s.
- * @retval =0 this matched sequence is equivalent to @p s.
- * @retval <0 this matched sequence will collate after @p s.
+ * @retval <0 this matched sequence will collate before @p __s.
+ * @retval =0 this matched sequence is equivalent to @p __s.
+ * @retval <0 this matched sequence will collate after @p __s.
*/
int
compare(const value_type* __s) const
/**
* @brief Tests the equivalence of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the inequivalence of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the ordering of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the ordering of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the ordering of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the ordering of two regular expression submatches.
- * @param lhs First regular expression submatch.
- * @param rhs Second regular expression submatch.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs First regular expression submatch.
+ * @param __rhs Second regular expression submatch.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _BiIter>
inline bool
/**
* @brief Tests the equivalence of a string and a regular expression
* submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the inequivalence of a string and a regular expression
* submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the equivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the inequivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter, typename _Ch_traits, typename _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter, class _Ch_traits, class _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter, class _Ch_traits, class _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter, class _Ch_traits, class _Ch_alloc>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter, class _Ch_traits, class _Ch_alloc>
inline bool
/**
* @brief Tests the equivalence of a C string and a regular expression
* submatch.
- * @param lhs A C string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A C string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the inequivalence of an iterator value and a regular
* expression submatch.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the equivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A pointer to a string?
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A pointer to a string?
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the inequivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A pointer to a string.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A pointer to a string.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A string.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A string.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the equivalence of a string and a regular expression
* submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the inequivalence of a string and a regular expression
* submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a string and a regular expression submatch.
- * @param lhs A string.
- * @param rhs A regular expression submatch.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A string.
+ * @param __rhs A regular expression submatch.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the equivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs is equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs is equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the inequivalence of a regular expression submatch and a
* string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs is not equivalent to @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs is not equivalent to @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs precedes @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs precedes @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs succeeds @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs succeeds @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs does not precede @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs does not precede @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Tests the ordering of a regular expression submatch and a string.
- * @param lhs A regular expression submatch.
- * @param rhs A const string reference.
- * @returns true if @a lhs does not succeed @a rhs, false otherwise.
+ * @param __lhs A regular expression submatch.
+ * @param __rhs A const string reference.
+ * @returns true if @a __lhs does not succeed @a __rhs, false otherwise.
*/
template<typename _Bi_iter>
inline bool
/**
* @brief Inserts a matched string into an output stream.
*
- * @param os The output stream.
- * @param m A submatch string.
+ * @param __os The output stream.
+ * @param __m A submatch string.
*
* @returns the output stream with the submatch string inserted.
*/
/**
* @brief Gets the length of the indicated submatch.
- * @param sub indicates the submatch.
+ * @param __sub indicates the submatch.
* @pre ready() == true
*
* This function returns the length of the indicated submatch, or the
- * length of the entire match if @p sub is zero (the default).
+ * length of the entire match if @p __sub is zero (the default).
*/
difference_type
length(size_type __sub = 0) const
/**
* @brief Gets the offset of the beginning of the indicated submatch.
- * @param sub indicates the submatch.
+ * @param __sub indicates the submatch.
* @pre ready() == true
*
* This function returns the offset from the beginning of the target
- * sequence to the beginning of the submatch, unless the value of @p sub
+ * sequence to the beginning of the submatch, unless the value of @p __sub
* is zero (the default), in which case this function returns the offset
* from the beginning of the target sequence to the beginning of the
* match.
*
- * Returns -1 if @p sub is out of range.
+ * Returns -1 if @p __sub is out of range.
*/
difference_type
position(size_type __sub = 0) const
/**
* @brief Gets the match or submatch converted to a string type.
- * @param sub indicates the submatch.
+ * @param __sub indicates the submatch.
* @pre ready() == true
*
- * This function gets the submatch (or match, if @p sub is zero) extracted
- * from the target range and converted to the associated string type.
+ * This function gets the submatch (or match, if @p __sub is
+ * zero) extracted from the target range and converted to the
+ * associated string type.
*/
string_type
str(size_type __sub = 0) const
/**
* @brief Gets a %sub_match reference for the match or submatch.
- * @param sub indicates the submatch.
+ * @param __sub indicates the submatch.
* @pre ready() == true
*
- * This function gets a reference to the indicated submatch, or the entire
- * match if @p sub is zero.
+ * This function gets a reference to the indicated submatch, or
+ * the entire match if @p __sub is zero.
*
- * If @p sub >= size() then this function returns a %sub_match with a
+ * If @p __sub >= size() then this function returns a %sub_match with a
* special value indicating no submatch.
*/
const_reference
// [7.10.6] match_results swap
/**
* @brief Swaps two match results.
- * @param lhs A match result.
- * @param rhs A match result.
+ * @param __lhs A match result.
+ * @param __rhs A match result.
*
* The contents of the two match_results objects are swapped.
*/
* @brief Determines if there is a match between the regular expression @p e
* and all of the character sequence [first, last).
*
- * @param s Start of the character sequence to match.
- * @param e One-past-the-end of the character sequence to match.
- * @param m The match results.
- * @param re The regular expression.
- * @param flags Controls how the regular expression is matched.
+ * @param __s Start of the character sequence to match.
+ * @param __e One-past-the-end of the character sequence to match.
+ * @param __m The match results.
+ * @param __re The regular expression.
+ * @param __flags Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
* @brief Indicates if there is a match between the regular expression @p e
* and all of the character sequence [first, last).
*
- * @param first Beginning of the character sequence to match.
- * @param last One-past-the-end of the character sequence to match.
- * @param re The regular expression.
- * @param flags Controls how the regular expression is matched.
+ * @param __first Beginning of the character sequence to match.
+ * @param __last One-past-the-end of the character sequence to match.
+ * @param __re The regular expression.
+ * @param __flags Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
* @brief Determines if there is a match between the regular expression @p e
* and a C-style null-terminated string.
*
- * @param s The C-style null-terminated string to match.
- * @param m The match results.
- * @param re The regular expression.
- * @param f Controls how the regular expression is matched.
+ * @param __s The C-style null-terminated string to match.
+ * @param __m The match results.
+ * @param __re The regular expression.
+ * @param __f Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
* @brief Determines if there is a match between the regular expression @p e
* and a string.
*
- * @param s The string to match.
- * @param m The match results.
- * @param re The regular expression.
- * @param flags Controls how the regular expression is matched.
+ * @param __s The string to match.
+ * @param __m The match results.
+ * @param __re The regular expression.
+ * @param __flags Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
* @brief Indicates if there is a match between the regular expression @p e
* and a C-style null-terminated string.
*
- * @param s The C-style null-terminated string to match.
- * @param re The regular expression.
- * @param f Controls how the regular expression is matched.
+ * @param __s The C-style null-terminated string to match.
+ * @param __re The regular expression.
+ * @param __f Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
* @brief Indicates if there is a match between the regular expression @p e
* and a string.
*
- * @param s [IN] The string to match.
- * @param re [IN] The regular expression.
- * @param flags [IN] Controls how the regular expression is matched.
+ * @param __s [IN] The string to match.
+ * @param __re [IN] The regular expression.
+ * @param __flags [IN] Controls how the regular expression is matched.
*
* @retval true A match exists.
* @retval false Otherwise.
// [7.11.3] Function template regex_search
/**
* Searches for a regular expression within a range.
- * @param first [IN] The start of the string to search.
- * @param last [IN] One-past-the-end of the string to search.
- * @param m [OUT] The match results.
- * @param re [IN] The regular expression to search for.
- * @param flags [IN] Search policy flags.
+ * @param __first [IN] The start of the string to search.
+ * @param __last [IN] One-past-the-end of the string to search.
+ * @param __m [OUT] The match results.
+ * @param __re [IN] The regular expression to search for.
+ * @param __flags [IN] Search policy flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string, the content of %m is
* undefined.
/**
* Searches for a regular expression within a range.
- * @param first [IN] The start of the string to search.
- * @param last [IN] One-past-the-end of the string to search.
- * @param re [IN] The regular expression to search for.
- * @param flags [IN] Search policy flags.
+ * @param __first [IN] The start of the string to search.
+ * @param __last [IN] One-past-the-end of the string to search.
+ * @param __re [IN] The regular expression to search for.
+ * @param __flags [IN] Search policy flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string.
* @doctodo
/**
* @brief Searches for a regular expression within a C-string.
- * @param s [IN] A C-string to search for the regex.
- * @param m [OUT] The set of regex matches.
- * @param e [IN] The regex to search for in @p s.
- * @param f [IN] The search flags.
+ * @param __s [IN] A C-string to search for the regex.
+ * @param __m [OUT] The set of regex matches.
+ * @param __e [IN] The regex to search for in @p s.
+ * @param __f [IN] The search flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string, the content of %m is
* undefined.
/**
* @brief Searches for a regular expression within a C-string.
- * @param s [IN] The C-string to search.
- * @param e [IN] The regular expression to search for.
- * @param f [IN] Search policy flags.
+ * @param __s [IN] The C-string to search.
+ * @param __e [IN] The regular expression to search for.
+ * @param __f [IN] Search policy flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string.
* @doctodo
/**
* @brief Searches for a regular expression within a string.
- * @param s [IN] The string to search.
- * @param e [IN] The regular expression to search for.
- * @param flags [IN] Search policy flags.
+ * @param __s [IN] The string to search.
+ * @param __e [IN] The regular expression to search for.
+ * @param __flags [IN] Search policy flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string.
* @doctodo
/**
* @brief Searches for a regular expression within a string.
- * @param s [IN] A C++ string to search for the regex.
- * @param m [OUT] The set of regex matches.
- * @param e [IN] The regex to search for in @p s.
- * @param f [IN] The search flags.
+ * @param __s [IN] A C++ string to search for the regex.
+ * @param __m [OUT] The set of regex matches.
+ * @param __e [IN] The regex to search for in @p s.
+ * @param __f [IN] The search flags.
* @retval true A match was found within the string.
* @retval false No match was found within the string, the content of %m is
* undefined.
// std [28.11.4] Function template regex_replace
/**
* @doctodo
- * @param out
- * @param first
- * @param last
- * @param e
- * @param fmt
- * @param flags
+ * @param __out
+ * @param __first
+ * @param __last
+ * @param __e
+ * @param __fmt
+ * @param __flags
*
* @returns out
* @throws an exception of type regex_error.
/**
* @doctodo
- * @param s
- * @param e
- * @param fmt
- * @param flags
+ * @param __s
+ * @param __e
+ * @param __fmt
+ * @param __flags
*
* @returns a copy of string @p s with replacements.
*
/**
* Constructs a %regex_iterator...
- * @param a [IN] The start of a text range to search.
- * @param b [IN] One-past-the-end of the text range to search.
- * @param re [IN] The regular expression to match.
- * @param m [IN] Policy flags for match rules.
+ * @param __a [IN] The start of a text range to search.
+ * @param __b [IN] One-past-the-end of the text range to search.
+ * @param __re [IN] The regular expression to match.
+ * @param __m [IN] Policy flags for match rules.
* @todo Implement this function.
* @doctodo
*/
/**
* Constructs a %regex_token_iterator...
- * @param a [IN] The start of the text to search.
- * @param b [IN] One-past-the-end of the text to search.
- * @param re [IN] The regular expression to search for.
- * @param submatch [IN] Which submatch to return. There are some
+ * @param __a [IN] The start of the text to search.
+ * @param __b [IN] One-past-the-end of the text to search.
+ * @param __re [IN] The regular expression to search for.
+ * @param __submatch [IN] Which submatch to return. There are some
* special values for this parameter:
* - -1 each enumerated subexpression does NOT
* match the regular expression (aka field
* within the text.
* - >0 enumerates only the indicated
* subexpression from a match within the text.
- * @param m [IN] Policy flags for match rules.
+ * @param __m [IN] Policy flags for match rules.
*
* @todo Implement this function.
* @doctodo
/**
* Constructs a %regex_token_iterator...
- * @param a [IN] The start of the text to search.
- * @param b [IN] One-past-the-end of the text to search.
- * @param re [IN] The regular expression to search for.
- * @param submatches [IN] A list of subexpressions to return for each
+ * @param __a [IN] The start of the text to search.
+ * @param __b [IN] One-past-the-end of the text to search.
+ * @param __re [IN] The regular expression to search for.
+ * @param __submatches [IN] A list of subexpressions to return for each
* regular expression match within the text.
- * @param m [IN] Policy flags for match rules.
+ * @param __m [IN] Policy flags for match rules.
*
* @todo Implement this function.
* @doctodo
/**
* Constructs a %regex_token_iterator...
- * @param a [IN] The start of the text to search.
- * @param b [IN] One-past-the-end of the text to search.
- * @param re [IN] The regular expression to search for.
- * @param submatches [IN] A list of subexpressions to return for each
- * regular expression match within the text.
- * @param m [IN] Policy flags for match rules.
+ * @param __a [IN] The start of the text to search.
+ * @param __b [IN] One-past-the-end of the text to search.
+ * @param __re [IN] The regular expression to search for.
+ * @param __submatches [IN] A list of subexpressions to return for each
+ * regular expression match within the text.
+ * @param __m [IN] Policy flags for match rules.
* @todo Implement this function.
* @doctodo
/**
* @brief Copy constructs a %regex_token_iterator.
- * @param rhs [IN] A %regex_token_iterator to copy.
+ * @param __rhs [IN] A %regex_token_iterator to copy.
* @todo Implement this function.
*/
regex_token_iterator(const regex_token_iterator& __rhs);
/**
* @brief Assigns a %regex_token_iterator to another.
- * @param rhs [IN] A %regex_token_iterator to copy.
+ * @param __rhs [IN] A %regex_token_iterator to copy.
* @todo Implement this function.
*/
regex_token_iterator&
static constexpr error_type error_space(_S_error_space);
/**
- * One of <em>*?+{<em> was not preceded by a valid regular expression.
+ * One of <em>*?+{</em> was not preceded by a valid regular expression.
*/
static constexpr error_type error_badrepeat(_S_error_badrepeat);
/**
* @brief Constructs a regex_error object.
*
- * @param ecode the regex error code.
+ * @param __ecode the regex error code.
*/
explicit
regex_error(regex_constants::error_type __ecode);
// The template and inlines for the -*- C++ -*- slice_array class.
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006, 2009,
-// 2010 Free Software Foundation, Inc.
+// 2010, 2011 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 Construct a slice.
*
- * @param o Offset in array of first element.
- * @param d Number of elements in slice.
- * @param s Stride between array elements.
+ * @param __o Offset in array of first element.
+ * @param __d Number of elements in slice.
+ * @param __s Stride between array elements.
*/
- slice(size_t, size_t, size_t);
+ slice(size_t __o, size_t __d, size_t __s);
/// Return array offset of first slice element.
size_t start() const;
/**
* @brief Find last matching subsequence in a sequence.
* @ingroup non_mutating_algorithms
- * @param first1 Start of range to search.
- * @param last1 End of range to search.
- * @param first2 Start of sequence to match.
- * @param last2 End of sequence to match.
+ * @param __first1 Start of range to search.
+ * @param __last1 End of range to search.
+ * @param __first2 Start of sequence to match.
+ * @param __last2 End of sequence to match.
* @return The last iterator @c i in the range
- * @p [first1,last1-(last2-first2)) such that @c *(i+N) == @p *(first2+N)
- * for each @c N in the range @p [0,last2-first2), or @p last1 if no
- * such iterator exists.
+ * @p [__first1,__last1-(__last2-__first2)) such that @c *(i+N) ==
+ * @p *(__first2+N) for each @c N in the range @p
+ * [0,__last2-__first2), or @p __last1 if no such iterator exists.
*
- * Searches the range @p [first1,last1) for a sub-sequence that compares
- * equal value-by-value with the sequence given by @p [first2,last2) and
- * returns an iterator to the first element of the sub-sequence, or
- * @p last1 if the sub-sequence is not found. The sub-sequence will be the
- * last such subsequence contained in [first,last1).
+ * Searches the range @p [__first1,__last1) for a sub-sequence that
+ * compares equal value-by-value with the sequence given by @p
+ * [__first2,__last2) and returns an iterator to the __first
+ * element of the sub-sequence, or @p __last1 if the sub-sequence
+ * is not found. The sub-sequence will be the last such
+ * subsequence contained in [__first,__last1).
*
- * Because the sub-sequence must lie completely within the range
- * @p [first1,last1) it must start at a position less than
- * @p last1-(last2-first2) where @p last2-first2 is the length of the
- * sub-sequence.
- * This means that the returned iterator @c i will be in the range
- * @p [first1,last1-(last2-first2))
+ * Because the sub-sequence must lie completely within the range @p
+ * [__first1,__last1) it must start at a position less than @p
+ * __last1-(__last2-__first2) where @p __last2-__first2 is the
+ * length of the sub-sequence. This means that the returned
+ * iterator @c i will be in the range @p
+ * [__first1,__last1-(__last2-__first2))
*/
template<typename _ForwardIterator1, typename _ForwardIterator2>
inline _ForwardIterator1
/**
* @brief Find last matching subsequence in a sequence using a predicate.
* @ingroup non_mutating_algorithms
- * @param first1 Start of range to search.
- * @param last1 End of range to search.
- * @param first2 Start of sequence to match.
- * @param last2 End of sequence to match.
- * @param comp The predicate to use.
- * @return The last iterator @c i in the range
- * @p [first1,last1-(last2-first2)) such that @c predicate(*(i+N), @p
- * (first2+N)) is true for each @c N in the range @p [0,last2-first2), or
- * @p last1 if no such iterator exists.
+ * @param __first1 Start of range to search.
+ * @param __last1 End of range to search.
+ * @param __first2 Start of sequence to match.
+ * @param __last2 End of sequence to match.
+ * @param __comp The predicate to use.
+ * @return The last iterator @c i in the range @p
+ * [__first1,__last1-(__last2-__first2)) such that @c
+ * predicate(*(i+N), @p (__first2+N)) is true for each @c N in the
+ * range @p [0,__last2-__first2), or @p __last1 if no such iterator
+ * exists.
*
- * Searches the range @p [first1,last1) for a sub-sequence that compares
- * equal value-by-value with the sequence given by @p [first2,last2) using
- * comp as a predicate and returns an iterator to the first element of the
- * sub-sequence, or @p last1 if the sub-sequence is not found. The
- * sub-sequence will be the last such subsequence contained in
- * [first,last1).
+ * Searches the range @p [__first1,__last1) for a sub-sequence that
+ * compares equal value-by-value with the sequence given by @p
+ * [__first2,__last2) using comp as a predicate and returns an
+ * iterator to the first element of the sub-sequence, or @p __last1
+ * if the sub-sequence is not found. The sub-sequence will be the
+ * last such subsequence contained in [__first,__last1).
*
- * Because the sub-sequence must lie completely within the range
- * @p [first1,last1) it must start at a position less than
- * @p last1-(last2-first2) where @p last2-first2 is the length of the
- * sub-sequence.
- * This means that the returned iterator @c i will be in the range
- * @p [first1,last1-(last2-first2))
+ * Because the sub-sequence must lie completely within the range @p
+ * [__first1,__last1) it must start at a position less than @p
+ * __last1-(__last2-__first2) where @p __last2-__first2 is the
+ * length of the sub-sequence. This means that the returned
+ * iterator @c i will be in the range @p
+ * [__first1,__last1-(__last2-__first2))
*/
template<typename _ForwardIterator1, typename _ForwardIterator2,
typename _BinaryPredicate>
* @brief Checks that a predicate is true for all the elements
* of a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
* @return True if the check is true, false otherwise.
*
- * Returns true if @p pred is true for each element in the range
- * @p [first,last), and false otherwise.
+ * Returns true if @p __pred is true for each element in the range
+ * @p [__first,__last), and false otherwise.
*/
template<typename _InputIterator, typename _Predicate>
inline bool
* @brief Checks that a predicate is false for all the elements
* of a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
* @return True if the check is true, false otherwise.
*
- * Returns true if @p pred is false for each element in the range
- * @p [first,last), and false otherwise.
+ * Returns true if @p __pred is false for each element in the range
+ * @p [__first,__last), and false otherwise.
*/
template<typename _InputIterator, typename _Predicate>
inline bool
* @brief Checks that a predicate is false for at least an element
* of a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
* @return True if the check is true, false otherwise.
*
- * Returns true if an element exists in the range @p [first,last) such that
- * @p pred is true, and false otherwise.
+ * Returns true if an element exists in the range @p
+ * [__first,__last) such that @p __pred is true, and false
+ * otherwise.
*/
template<typename _InputIterator, typename _Predicate>
inline bool
* @brief Find the first element in a sequence for which a
* predicate is false.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
- * @return The first iterator @c i in the range @p [first,last)
- * such that @p pred(*i) is false, or @p last if no such iterator exists.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
+ * @return The first iterator @c i in the range @p [__first,__last)
+ * such that @p __pred(*i) is false, or @p __last if no such iterator exists.
*/
template<typename _InputIterator, typename _Predicate>
inline _InputIterator
/**
* @brief Checks whether the sequence is partitioned.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
- * @return True if the range @p [first,last) is partioned by @p pred,
- * i.e. if all elements that satisfy @p pred appear before those that
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
+ * @return True if the range @p [__first,__last) is partioned by @p __pred,
+ * i.e. if all elements that satisfy @p __pred appear before those that
* do not.
*/
template<typename _InputIterator, typename _Predicate>
/**
* @brief Find the partition point of a partitioned range.
* @ingroup mutating_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param pred A predicate.
- * @return An iterator @p mid such that @p all_of(first, mid, pred)
- * and @p none_of(mid, last, pred) are both true.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __pred A predicate.
+ * @return An iterator @p mid such that @p all_of(__first, mid, __pred)
+ * and @p none_of(mid, __last, __pred) are both true.
*/
template<typename _ForwardIterator, typename _Predicate>
_ForwardIterator
/**
* @brief Copy a sequence, removing elements of a given value.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param value The value to be removed.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __value The value to be removed.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies each element in the range @p [first,last) not equal to @p value
- * to the range beginning at @p result.
- * remove_copy() is stable, so the relative order of elements that are
- * copied is unchanged.
+ * Copies each element in the range @p [__first,__last) not equal
+ * to @p __value to the range beginning at @p __result.
+ * remove_copy() is stable, so the relative order of elements that
+ * are copied is unchanged.
*/
template<typename _InputIterator, typename _OutputIterator, typename _Tp>
_OutputIterator
/**
* @brief Copy a sequence, removing elements for which a predicate is true.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __pred A predicate.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies each element in the range @p [first,last) for which
- * @p pred returns false to the range beginning at @p result.
+ * Copies each element in the range @p [__first,__last) for which
+ * @p __pred returns false to the range beginning at @p __result.
*
* remove_copy_if() is stable, so the relative order of elements that are
* copied is unchanged.
/**
* @brief Copy the elements of a sequence for which a predicate is true.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __pred A predicate.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies each element in the range @p [first,last) for which
- * @p pred returns true to the range beginning at @p result.
+ * Copies each element in the range @p [__first,__last) for which
+ * @p __pred returns true to the range beginning at @p __result.
*
* copy_if() is stable, so the relative order of elements that are
* copied is unchanged.
/**
* @brief Copies the range [first,first+n) into [result,result+n).
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param n The number of elements to copy.
- * @param result An output iterator.
+ * @param __first An input iterator.
+ * @param __n The number of elements to copy.
+ * @param __result An output iterator.
* @return result+n.
*
* This inline function will boil down to a call to @c memmove whenever
* @brief Copy the elements of a sequence to separate output sequences
* depending on the truth value of a predicate.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param out_true An output iterator.
- * @param out_false An output iterator.
- * @param pred A predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __out_true An output iterator.
+ * @param __out_false An output iterator.
+ * @param __pred A predicate.
* @return A pair designating the ends of the resulting sequences.
*
- * Copies each element in the range @p [first,last) for which
- * @p pred returns true to the range beginning at @p out_true
- * and each element for which @p pred returns false to @p out_false.
+ * Copies each element in the range @p [__first,__last) for which
+ * @p __pred returns true to the range beginning at @p out_true
+ * and each element for which @p __pred returns false to @p __out_false.
*/
template<typename _InputIterator, typename _OutputIterator1,
typename _OutputIterator2, typename _Predicate>
/**
* @brief Remove elements from a sequence.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param value The value to be removed.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __value The value to be removed.
* @return An iterator designating the end of the resulting sequence.
*
- * All elements equal to @p value are removed from the range
- * @p [first,last).
+ * All elements equal to @p __value are removed from the range
+ * @p [__first,__last).
*
* remove() is stable, so the relative order of elements that are
* not removed is unchanged.
*
- * Elements between the end of the resulting sequence and @p last
+ * Elements between the end of the resulting sequence and @p __last
* are still present, but their value is unspecified.
*/
template<typename _ForwardIterator, typename _Tp>
/**
* @brief Remove elements from a sequence using a predicate.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param pred A predicate.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __pred A predicate.
* @return An iterator designating the end of the resulting sequence.
*
- * All elements for which @p pred returns true are removed from the range
- * @p [first,last).
+ * All elements for which @p __pred returns true are removed from the range
+ * @p [__first,__last).
*
* remove_if() is stable, so the relative order of elements that are
* not removed is unchanged.
*
- * Elements between the end of the resulting sequence and @p last
+ * Elements between the end of the resulting sequence and @p __last
* are still present, but their value is unspecified.
*/
template<typename _ForwardIterator, typename _Predicate>
/**
* @brief Remove consecutive duplicate values from a sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
* @return An iterator designating the end of the resulting sequence.
*
* Removes all but the first element from each group of consecutive
* values that compare equal.
* unique() is stable, so the relative order of elements that are
* not removed is unchanged.
- * Elements between the end of the resulting sequence and @p last
+ * Elements between the end of the resulting sequence and @p __last
* are still present, but their value is unspecified.
*/
template<typename _ForwardIterator>
/**
* @brief Remove consecutive values from a sequence using a predicate.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param binary_pred A binary predicate.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __binary_pred A binary predicate.
* @return An iterator designating the end of the resulting sequence.
*
* Removes all but the first element from each group of consecutive
- * values for which @p binary_pred returns true.
+ * values for which @p __binary_pred returns true.
* unique() is stable, so the relative order of elements that are
* not removed is unchanged.
- * Elements between the end of the resulting sequence and @p last
+ * Elements between the end of the resulting sequence and @p __last
* are still present, but their value is unspecified.
*/
template<typename _ForwardIterator, typename _BinaryPredicate>
/**
* @brief Reverse a sequence.
* @ingroup mutating_algorithms
- * @param first A bidirectional iterator.
- * @param last A bidirectional iterator.
+ * @param __first A bidirectional iterator.
+ * @param __last A bidirectional iterator.
* @return reverse() returns no value.
*
- * Reverses the order of the elements in the range @p [first,last),
+ * Reverses the order of the elements in the range @p [__first,__last),
* so that the first element becomes the last etc.
- * For every @c i such that @p 0<=i<=(last-first)/2), @p reverse()
- * swaps @p *(first+i) and @p *(last-(i+1))
+ * For every @c i such that @p 0<=i<=(__last-__first)/2), @p reverse()
+ * swaps @p *(__first+i) and @p *(__last-(i+1))
*/
template<typename _BidirectionalIterator>
inline void
/**
* @brief Copy a sequence, reversing its elements.
* @ingroup mutating_algorithms
- * @param first A bidirectional iterator.
- * @param last A bidirectional iterator.
- * @param result An output iterator.
+ * @param __first A bidirectional iterator.
+ * @param __last A bidirectional iterator.
+ * @param __result An output iterator.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies the elements in the range @p [first,last) to the range
- * @p [result,result+(last-first)) such that the order of the
- * elements is reversed.
- * For every @c i such that @p 0<=i<=(last-first), @p reverse_copy()
- * performs the assignment @p *(result+(last-first)-i) = *(first+i).
- * The ranges @p [first,last) and @p [result,result+(last-first))
- * must not overlap.
+ * Copies the elements in the range @p [__first,__last) to the
+ * range @p [__result,__result+(__last-__first)) such that the
+ * order of the elements is reversed. For every @c i such that @p
+ * 0<=i<=(__last-__first), @p reverse_copy() performs the
+ * assignment @p *(__result+(__last-__first)-i) = *(__first+i).
+ * The ranges @p [__first,__last) and @p
+ * [__result,__result+(__last-__first)) must not overlap.
*/
template<typename _BidirectionalIterator, typename _OutputIterator>
_OutputIterator
/**
* @brief Rotate the elements of a sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param middle A forward iterator.
- * @param last A forward iterator.
+ * @param __first A forward iterator.
+ * @param __middle A forward iterator.
+ * @param __last A forward iterator.
* @return Nothing.
*
- * Rotates the elements of the range @p [first,last) by @p (middle-first)
- * positions so that the element at @p middle is moved to @p first, the
- * element at @p middle+1 is moved to @first+1 and so on for each element
- * in the range @p [first,last).
+ * Rotates the elements of the range @p [__first,__last) by
+ * @p(__middle - __first) positions so that the element at @p __middle
+ * is moved to @p __first, the element at @p __middle+1 is moved to
+ * @ __first+1 and so on for each element in the range
+ * @p [__first,__last).
*
- * This effectively swaps the ranges @p [first,middle) and
- * @p [middle,last).
+ * This effectively swaps the ranges @p [__first,__middle) and
+ * @p [__middle,__last).
*
- * Performs @p *(first+(n+(last-middle))%(last-first))=*(first+n) for
- * each @p n in the range @p [0,last-first).
+ * Performs
+ * @p *(__first+(n+(__last-__middle))%(__last-__first))=*(__first+n)
+ * for each @p n in the range @p [0,__last-__first).
*/
template<typename _ForwardIterator>
inline void
/**
* @brief Copy a sequence, rotating its elements.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param middle A forward iterator.
- * @param last A forward iterator.
- * @param result An output iterator.
+ * @param __first A forward iterator.
+ * @param __middle A forward iterator.
+ * @param __last A forward iterator.
+ * @param __result An output iterator.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies the elements of the range @p [first,last) to the range
- * beginning at @result, rotating the copied elements by @p (middle-first)
- * positions so that the element at @p middle is moved to @p result, the
- * element at @p middle+1 is moved to @result+1 and so on for each element
- * in the range @p [first,last).
+ * Copies the elements of the range @p [__first,__last) to the
+ * range beginning at @result, rotating the copied elements by
+ * @p (__middle-__first) positions so that the element at @p __middle
+ * is moved to @p __result, the element at @p __middle+1 is moved
+ * to @__result+1 and so on for each element in the range @p
+ * [__first,__last).
*
- * Performs @p *(result+(n+(last-middle))%(last-first))=*(first+n) for
- * each @p n in the range @p [0,last-first).
+ * Performs
+ * @p *(__result+(n+(__last-__middle))%(__last-__first))=*(__first+n)
+ * for each @p n in the range @p [0,__last-__first).
*/
template<typename _ForwardIterator, typename _OutputIterator>
_OutputIterator
* @brief Move elements for which a predicate is true to the beginning
* of a sequence, preserving relative ordering.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param pred A predicate functor.
- * @return An iterator @p middle such that @p pred(i) is true for each
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __pred A predicate functor.
+ * @return An iterator @p middle such that @p __pred(i) is true for each
* iterator @p i in the range @p [first,middle) and false for each @p i
* in the range @p [middle,last).
*
* Performs the same function as @p partition() with the additional
* guarantee that the relative ordering of elements in each group is
* preserved, so any two elements @p x and @p y in the range
- * @p [first,last) such that @p pred(x)==pred(y) will have the same
+ * @p [__first,__last) such that @p __pred(x)==__pred(y) will have the same
* relative ordering after calling @p stable_partition().
*/
template<typename _ForwardIterator, typename _Predicate>
/**
* @brief Copy the smallest elements of a sequence.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param result_first A random-access iterator.
- * @param result_last Another random-access iterator.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __result_first A random-access iterator.
+ * @param __result_last Another random-access iterator.
* @return An iterator indicating the end of the resulting sequence.
*
- * Copies and sorts the smallest N values from the range @p [first,last)
- * to the range beginning at @p result_first, where the number of
- * elements to be copied, @p N, is the smaller of @p (last-first) and
- * @p (result_last-result_first).
+ * Copies and sorts the smallest N values from the range @p [__first,__last)
+ * to the range beginning at @p __result_first, where the number of
+ * elements to be copied, @p N, is the smaller of @p (__last-__first) and
+ * @p (__result_last-__result_first).
* After the sort if @p i and @j are iterators in the range
- * @p [result_first,result_first+N) such that @i precedes @j then
+ * @p [__result_first,__result_first+N) such that @i precedes @j then
* @p *j<*i is false.
- * The value returned is @p result_first+N.
+ * The value returned is @p __result_first+N.
*/
template<typename _InputIterator, typename _RandomAccessIterator>
_RandomAccessIterator
* @brief Copy the smallest elements of a sequence using a predicate for
* comparison.
* @ingroup sorting_algorithms
- * @param first An input iterator.
- * @param last Another input iterator.
- * @param result_first A random-access iterator.
- * @param result_last Another random-access iterator.
- * @param comp A comparison functor.
+ * @param __first An input iterator.
+ * @param __last Another input iterator.
+ * @param __result_first A random-access iterator.
+ * @param __result_last Another random-access iterator.
+ * @param __comp A comparison functor.
* @return An iterator indicating the end of the resulting sequence.
*
- * Copies and sorts the smallest N values from the range @p [first,last)
+ * Copies and sorts the smallest N values from the range @p [__first,__last)
* to the range beginning at @p result_first, where the number of
- * elements to be copied, @p N, is the smaller of @p (last-first) and
- * @p (result_last-result_first).
+ * elements to be copied, @p N, is the smaller of @p (__last-__first) and
+ * @p (__result_last-__result_first).
* After the sort if @p i and @j are iterators in the range
- * @p [result_first,result_first+N) such that @i precedes @j then
- * @p comp(*j,*i) is false.
- * The value returned is @p result_first+N.
+ * @p [__result_first,__result_first+N) such that @i precedes @j then
+ * @p __comp(*j,*i) is false.
+ * The value returned is @p __result_first+N.
*/
template<typename _InputIterator, typename _RandomAccessIterator, typename _Compare>
_RandomAccessIterator
* @brief Finds the first position in which @a val could be inserted
* without changing the ordering.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
- * @param comp A functor to use for comparisons.
+ * @param __first An iterator.
+ * @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 <em>not less
- * than</em> @a val, or end() if every element is less
- * than @a val.
+ * 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
* @brief Finds the last position in which @a val could be inserted
* without changing the ordering.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
- * @return An iterator pointing to the first element greater than @a val,
- * or end() if no elements are greater than @a val.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
+ * @return An iterator pointing to the first element greater than @a __val,
+ * or end() if no elements are greater than @a __val.
* @ingroup binary_search_algorithms
*/
template<typename _ForwardIterator, typename _Tp>
* @brief Finds the last position in which @a val could be inserted
* without changing the ordering.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @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 greater than @a val,
- * or end() if no elements are greater than @a val.
+ * @param __first An iterator.
+ * @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 greater than @a __val,
+ * or end() if no elements are greater than @a __val.
* @ingroup binary_search_algorithms
*
* The comparison function should have the same effects on ordering as
* @brief Finds the largest subrange in which @a val could be inserted
* at any place in it without changing the ordering.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
* @return An pair of iterators defining the subrange.
* @ingroup binary_search_algorithms
*
* This is equivalent to
* @code
- * std::make_pair(lower_bound(first, last, val),
- * upper_bound(first, last, val))
+ * std::make_pair(lower_bound(__first, __last, __val),
+ * upper_bound(__first, __last, __val))
* @endcode
* but does not actually call those functions.
*/
/**
* @brief Finds the largest subrange in which @a val could be inserted
* at any place in it without changing the ordering.
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
- * @param comp A functor to use for comparisons.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
+ * @param __comp A functor to use for comparisons.
* @return An pair of iterators defining the subrange.
* @ingroup binary_search_algorithms
*
* This is equivalent to
* @code
- * std::make_pair(lower_bound(first, last, val, comp),
- * upper_bound(first, last, val, comp))
+ * std::make_pair(lower_bound(__first, __last, __val, __comp),
+ * upper_bound(__first, __last, __val, __comp))
* @endcode
* but does not actually call those functions.
*/
/**
* @brief Determines whether an element exists in a range.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
- * @return True if @a val (or its equivalent) is in [@a first,@a last ].
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
+ * @return True if @a __val (or its equivalent) is in [@a
+ * __first,@a __last ].
*
- * Note that this does not actually return an iterator to @a val. For
+ * Note that this does not actually return an iterator to @a __val. For
* that, use std::find or a container's specialized find member functions.
*/
template<typename _ForwardIterator, typename _Tp>
/**
* @brief Determines whether an element exists in a range.
* @ingroup binary_search_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
- * @param comp A functor to use for comparisons.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
+ * @param __comp A functor to use for comparisons.
* @return True if @a val (or its equivalent) is in [@a first,@a last ].
*
* Note that this does not actually return an iterator to @a val. For
/**
* @brief Merges two sorted ranges in place.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param middle Another iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __middle Another iterator.
+ * @param __last Another iterator.
* @return Nothing.
*
- * Merges two sorted and consecutive ranges, [first,middle) and
- * [middle,last), and puts the result in [first,last). The output will
- * be sorted. The sort is @e stable, that is, for equivalent
- * elements in the two ranges, elements from the first range will always
- * come before elements from the second.
+ * Merges two sorted and consecutive ranges, [__first,__middle) and
+ * [__middle,__last), and puts the result in [__first,__last). The
+ * output will be sorted. The sort is @e stable, that is, for
+ * equivalent elements in the two ranges, elements from the first
+ * range will always come before elements from the second.
*
- * If enough additional memory is available, this takes (last-first)-1
+ * If enough additional memory is available, this takes (__last-__first)-1
* comparisons. Otherwise an NlogN algorithm is used, where N is
- * distance(first,last).
+ * distance(__first,__last).
*/
template<typename _BidirectionalIterator>
void
/**
* @brief Merges two sorted ranges in place.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param middle Another iterator.
- * @param last Another iterator.
- * @param comp A functor to use for comparisons.
+ * @param __first An iterator.
+ * @param __middle Another iterator.
+ * @param __last Another iterator.
+ * @param __comp A functor to use for comparisons.
* @return Nothing.
*
- * Merges two sorted and consecutive ranges, [first,middle) and
- * [middle,last), and puts the result in [first,last). The output will
+ * Merges two sorted and consecutive ranges, [__first,__middle) and
+ * [middle,last), and puts the result in [__first,__last). The output will
* be sorted. The sort is @e stable, that is, for equivalent
* elements in the two ranges, elements from the first range will always
* come before elements from the second.
*
- * If enough additional memory is available, this takes (last-first)-1
+ * If enough additional memory is available, this takes (__last-__first)-1
* comparisons. Otherwise an NlogN algorithm is used, where N is
- * distance(first,last).
+ * distance(__first,__last).
*
* The comparison function should have the same effects on ordering as
* the function used for the initial sort.
/**
* @brief Determines whether all elements of a sequence exists in a range.
- * @param first1 Start of search range.
- * @param last1 End of search range.
- * @param first2 Start of sequence
- * @param last2 End of sequence.
- * @return True if each element in [first2,last2) is contained in order
- * within [first1,last1). False otherwise.
+ * @param __first1 Start of search range.
+ * @param __last1 End of search range.
+ * @param __first2 Start of sequence
+ * @param __last2 End of sequence.
+ * @return True if each element in [__first2,__last2) is contained in order
+ * within [__first1,__last1). False otherwise.
* @ingroup set_algorithms
*
- * This operation expects both [first1,last1) and [first2,last2) to be
- * sorted. Searches for the presence of each element in [first2,last2)
- * within [first1,last1). The iterators over each range only move forward,
- * so this is a linear algorithm. If an element in [first2,last2) is not
- * found before the search iterator reaches @a last2, false is returned.
+ * This operation expects both [__first1,__last1) and
+ * [__first2,__last2) to be sorted. Searches for the presence of
+ * each element in [__first2,__last2) within [__first1,__last1).
+ * The iterators over each range only move forward, so this is a
+ * linear algorithm. If an element in [__first2,__last2) is not
+ * found before the search iterator reaches @a __last2, false is
+ * returned.
*/
template<typename _InputIterator1, typename _InputIterator2>
bool
* @brief Determines whether all elements of a sequence exists in a range
* using comparison.
* @ingroup set_algorithms
- * @param first1 Start of search range.
- * @param last1 End of search range.
- * @param first2 Start of sequence
- * @param last2 End of sequence.
- * @param comp Comparison function to use.
- * @return True if each element in [first2,last2) is contained in order
- * within [first1,last1) according to comp. False otherwise.
- * @ingroup set_algorithms
+ * @param __first1 Start of search range.
+ * @param __last1 End of search range.
+ * @param __first2 Start of sequence
+ * @param __last2 End of sequence.
+ * @param __comp Comparison function to use.
+ * @return True if each element in [__first2,__last2) is contained
+ * in order within [__first1,__last1) according to comp. False
+ * otherwise. @ingroup set_algorithms
*
- * This operation expects both [first1,last1) and [first2,last2) to be
- * sorted. Searches for the presence of each element in [first2,last2)
- * within [first1,last1), using comp to decide. The iterators over each
- * range only move forward, so this is a linear algorithm. If an element
- * in [first2,last2) is not found before the search iterator reaches @a
- * last2, false is returned.
+ * This operation expects both [__first1,__last1) and
+ * [__first2,__last2) to be sorted. Searches for the presence of
+ * each element in [__first2,__last2) within [__first1,__last1),
+ * using comp to decide. The iterators over each range only move
+ * forward, so this is a linear algorithm. If an element in
+ * [__first2,__last2) is not found before the search iterator
+ * reaches @a __last2, false is returned.
*/
template<typename _InputIterator1, typename _InputIterator2,
typename _Compare>
/**
* @brief Permute range into the next @a dictionary ordering.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
+ * @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 @a dictionary sorted
* @brief Permute range into the next @a dictionary ordering using
* comparison functor.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
- * @param comp A comparison functor.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp A comparison functor.
* @return False if wrapped to first permutation, true otherwise.
*
- * Treats all permutations of the range [first,last) as a set of
+ * Treats all permutations of the range [__first,__last) as a set of
* @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
/**
* @brief Permute range into the previous @a dictionary ordering.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
+ * @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 @a dictionary sorted
* @brief Permute range into the previous @a dictionary ordering using
* comparison functor.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
- * @param comp A comparison functor.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp A comparison functor.
* @return False if wrapped to last permutation, true otherwise.
*
- * Treats all permutations of the range [first,last) as a set of
+ * Treats all permutations of the range [__first,__last) as a set of
* @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,
/**
* @brief Copy a sequence, replacing each element of one value with another
* value.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param old_value The value to be replaced.
- * @param new_value The replacement value.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __old_value The value to be replaced.
+ * @param __new_value The replacement value.
* @return The end of the output sequence, @p result+(last-first).
*
- * Copies each element in the input range @p [first,last) to the
- * output range @p [result,result+(last-first)) replacing elements
- * equal to @p old_value with @p new_value.
+ * Copies each element in the input range @p [__first,__last) to the
+ * output range @p [__result,__result+(__last-__first)) replacing elements
+ * equal to @p __old_value with @p __new_value.
*/
template<typename _InputIterator, typename _OutputIterator, typename _Tp>
_OutputIterator
* @brief Copy a sequence, replacing each value for which a predicate
* returns true with another value.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param pred A predicate.
- * @param new_value The replacement value.
- * @return The end of the output sequence, @p result+(last-first).
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __pred A predicate.
+ * @param __new_value The replacement value.
+ * @return The end of the output sequence, @p __result+(__last-__first).
*
- * Copies each element in the range @p [first,last) to the range
- * @p [result,result+(last-first)) replacing elements for which
- * @p pred returns true with @p new_value.
+ * Copies each element in the range @p [__first,__last) to the range
+ * @p [__result,__result+(__last-__first)) replacing elements for which
+ * @p __pred returns true with @p __new_value.
*/
template<typename _InputIterator, typename _OutputIterator,
typename _Predicate, typename _Tp>
/**
* @brief Determines whether the elements of a sequence are sorted.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __last Another iterator.
* @return True if the elements are sorted, false otherwise.
*/
template<typename _ForwardIterator>
* @brief Determines whether the elements of a sequence are sorted
* according to a comparison functor.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
* @return True if the elements are sorted, false otherwise.
*/
template<typename _ForwardIterator, typename _Compare>
/**
* @brief Determines the end of a sorted sequence.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @return An iterator pointing to the last iterator i in [first, last)
- * for which the range [first, i) is sorted.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @return An iterator pointing to the last iterator i in [__first, __last)
+ * for which the range [__first, i) is sorted.
*/
template<typename _ForwardIterator>
_ForwardIterator
/**
* @brief Determines the end of a sorted sequence using comparison functor.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
- * @return An iterator pointing to the last iterator i in [first, last)
- * for which the range [first, i) is sorted.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
+ * @return An iterator pointing to the last iterator i in [__first, __last)
+ * for which the range [__first, i) is sorted.
*/
template<typename _ForwardIterator, typename _Compare>
_ForwardIterator
/**
* @brief Determines min and max at once as an ordered pair.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
- * @return A pair(b, a) if b is smaller than a, pair(a, b) otherwise.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
+ * @return A pair(__b, __a) if __b is smaller than __a, pair(__a,
+ * __b) otherwise.
*/
template<typename _Tp>
inline pair<const _Tp&, const _Tp&>
/**
* @brief Determines min and max at once as an ordered pair.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
- * @param comp A @link comparison_functor comparison functor@endlink.
- * @return A pair(b, a) if b is smaller than a, pair(a, b) otherwise.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
+ * @param __comp A @link comparison_functor comparison functor @endlink.
+ * @return A pair(__b, __a) if __b is smaller than __a, pair(__a,
+ * __b) otherwise.
*/
template<typename _Tp, typename _Compare>
inline pair<const _Tp&, const _Tp&>
* @brief Return a pair of iterators pointing to the minimum and maximum
* elements in a range.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
+ * @param __first Start of range.
+ * @param __last End of range.
* @return make_pair(m, M), where m is the first iterator i in
- * [first, last) such that no other element in the range is
- * smaller, and where M is the last iterator i in [first, last)
+ * [__first, __last) such that no other element in the range is
+ * smaller, and where M is the last iterator i in [__first, __last)
* such that no other element in the range is larger.
*/
template<typename _ForwardIterator>
* @brief Return a pair of iterators pointing to the minimum and maximum
* elements in a range.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
- * @param comp Comparison functor.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp Comparison functor.
* @return make_pair(m, M), where m is the first iterator i in
- * [first, last) such that no other element in the range is
- * smaller, and where M is the last iterator i in [first, last)
+ * [__first, __last) such that no other element in the range is
+ * smaller, and where M is the last iterator i in [__first, __last)
* such that no other element in the range is larger.
*/
template<typename _ForwardIterator, typename _Compare>
* @brief Checks whether a permutaion of the second sequence is equal
* to the first sequence.
* @ingroup non_mutating_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
* @return true if there exists a permutation of the elements in the range
- * [first2, first2 + (last1 - first1)), beginning with
- * ForwardIterator2 begin, such that equal(first1, last1, begin)
+ * [__first2, __first2 + (__last1 - __first1)), beginning with
+ * ForwardIterator2 begin, such that equal(__first1, __last1, begin)
* returns true; otherwise, returns false.
*/
template<typename _ForwardIterator1, typename _ForwardIterator2>
* @brief Checks whether a permutation of the second sequence is equal
* to the first sequence.
* @ingroup non_mutating_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param pred A binary predicate.
- * @return true if there exists a permutation of the elements in the range
- * [first2, first2 + (last1 - first1)), beginning with
- * ForwardIterator2 begin, such that equal(first1, last1, begin,
- * pred) returns true; otherwise, returns false.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __pred A binary predicate.
+ * @return true if there exists a permutation of the elements in
+ * the range [__first2, __first2 + (__last1 - __first1)),
+ * beginning with ForwardIterator2 begin, such that
+ * equal(__first1, __last1, __begin, __pred) returns true;
+ * otherwise, returns false.
*/
template<typename _ForwardIterator1, typename _ForwardIterator2,
typename _BinaryPredicate>
* @brief Shuffle the elements of a sequence using a uniform random
* number generator.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param g A UniformRandomNumberGenerator (26.5.1.3).
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __g A UniformRandomNumberGenerator (26.5.1.3).
* @return Nothing.
*
- * Reorders the elements in the range @p [first,last) using @p g to
+ * Reorders the elements in the range @p [__first,__last) using @p __g to
* provide random numbers.
*/
template<typename _RandomAccessIterator,
/**
* @brief Apply a function to every element of a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param f A unary function object.
- * @return @p f (std::move(@p f) in C++0x).
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __f A unary function object.
+ * @return @p __f (std::move(@p __f) in C++0x).
*
- * Applies the function object @p f to each element in the range
- * @p [first,last). @p f must not modify the order of the sequence.
- * If @p f has a return value it is ignored.
+ * Applies the function object @p __f to each element in the range
+ * @p [first,last). @p __f must not modify the order of the sequence.
+ * If @p __f has a return value it is ignored.
*/
template<typename _InputIterator, typename _Function>
_Function
/**
* @brief Find the first occurrence of a value in a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param val The value to find.
- * @return The first iterator @c i in the range @p [first,last)
- * such that @c *i == @p val, or @p last if no such iterator exists.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __val The value to find.
+ * @return The first iterator @c i in the range @p [__first,__last)
+ * such that @c *i == @p __val, or @p __last if no such iterator exists.
*/
template<typename _InputIterator, typename _Tp>
inline _InputIterator
* @brief Find the first element in a sequence for which a
* predicate is true.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
- * @return The first iterator @c i in the range @p [first,last)
- * such that @p pred(*i) is true, or @p last if no such iterator exists.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
+ * @return The first iterator @c i in the range @p [__first,__last)
+ * such that @p __pred(*i) is true, or @p __last if no such iterator exists.
*/
template<typename _InputIterator, typename _Predicate>
inline _InputIterator
/**
* @brief Find element from a set in a sequence.
* @ingroup non_mutating_algorithms
- * @param first1 Start of range to search.
- * @param last1 End of range to search.
- * @param first2 Start of match candidates.
- * @param last2 End of match candidates.
+ * @param __first1 Start of range to search.
+ * @param __last1 End of range to search.
+ * @param __first2 Start of match candidates.
+ * @param __last2 End of match candidates.
* @return The first iterator @c i in the range
- * @p [first1,last1) such that @c *i == @p *(i2) such that i2 is an
- * iterator in [first2,last2), or @p last1 if no such iterator exists.
+ * @p [__first1,__last1) such that @c *i == @p *(i2) such that i2 is an
+ * iterator in [__first2,__last2), or @p __last1 if no such iterator exists.
*
- * Searches the range @p [first1,last1) for an element that is equal to
- * some element in the range [first2,last2). If found, returns an iterator
- * in the range [first1,last1), otherwise returns @p last1.
+ * Searches the range @p [__first1,__last1) for an element that is
+ * equal to some element in the range [__first2,__last2). If
+ * found, returns an iterator in the range [__first1,__last1),
+ * otherwise returns @p __last1.
*/
template<typename _InputIterator, typename _ForwardIterator>
_InputIterator
/**
* @brief Find element from a set in a sequence using a predicate.
* @ingroup non_mutating_algorithms
- * @param first1 Start of range to search.
- * @param last1 End of range to search.
- * @param first2 Start of match candidates.
- * @param last2 End of match candidates.
- * @param comp Predicate to use.
+ * @param __first1 Start of range to search.
+ * @param __last1 End of range to search.
+ * @param __first2 Start of match candidates.
+ * @param __last2 End of match candidates.
+ * @param __comp Predicate to use.
* @return The first iterator @c i in the range
- * @p [first1,last1) such that @c comp(*i, @p *(i2)) is true and i2 is an
- * iterator in [first2,last2), or @p last1 if no such iterator exists.
+ * @p [__first1,__last1) such that @c comp(*i, @p *(i2)) is true
+ * and i2 is an iterator in [__first2,__last2), or @p __last1 if no
+ * such iterator exists.
*
- * Searches the range @p [first1,last1) for an element that is
- * equal to some element in the range [first2,last2). If found,
- * returns an iterator in the range [first1,last1), otherwise
- * returns @p last1.
+ * Searches the range @p [__first1,__last1) for an element that is
+ * equal to some element in the range [__first2,__last2). If
+ * found, returns an iterator in the range [__first1,__last1),
+ * otherwise returns @p __last1.
*/
template<typename _InputIterator, typename _ForwardIterator,
typename _BinaryPredicate>
/**
* @brief Find two adjacent values in a sequence that are equal.
* @ingroup non_mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
* @return The first iterator @c i such that @c i and @c i+1 are both
- * valid iterators in @p [first,last) and such that @c *i == @c *(i+1),
- * or @p last if no such iterator exists.
+ * valid iterators in @p [__first,__last) and such that @c *i == @c *(i+1),
+ * or @p __last if no such iterator exists.
*/
template<typename _ForwardIterator>
_ForwardIterator
/**
* @brief Find two adjacent values in a sequence using a predicate.
* @ingroup non_mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param binary_pred A binary predicate.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __binary_pred A binary predicate.
* @return The first iterator @c i such that @c i and @c i+1 are both
- * valid iterators in @p [first,last) and such that
- * @p binary_pred(*i,*(i+1)) is true, or @p last if no such iterator
+ * valid iterators in @p [__first,__last) and such that
+ * @p __binary_pred(*i,*(i+1)) is true, or @p __last if no such iterator
* exists.
*/
template<typename _ForwardIterator, typename _BinaryPredicate>
/**
* @brief Count the number of copies of a value in a sequence.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param value The value to be counted.
- * @return The number of iterators @c i in the range @p [first,last)
- * for which @c *i == @p value
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __value The value to be counted.
+ * @return The number of iterators @c i in the range @p [__first,__last)
+ * for which @c *i == @p __value
*/
template<typename _InputIterator, typename _Tp>
typename iterator_traits<_InputIterator>::difference_type
/**
* @brief Count the elements of a sequence for which a predicate is true.
* @ingroup non_mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param pred A predicate.
- * @return The number of iterators @c i in the range @p [first,last)
- * for which @p pred(*i) is true.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __pred A predicate.
+ * @return The number of iterators @c i in the range @p [__first,__last)
+ * for which @p __pred(*i) is true.
*/
template<typename _InputIterator, typename _Predicate>
typename iterator_traits<_InputIterator>::difference_type
/**
* @brief Search a sequence for a matching sub-sequence.
* @ingroup non_mutating_algorithms
- * @param first1 A forward iterator.
- * @param last1 A forward iterator.
- * @param first2 A forward iterator.
- * @param last2 A forward iterator.
- * @return The first iterator @c i in the range
- * @p [first1,last1-(last2-first2)) such that @c *(i+N) == @p *(first2+N)
- * for each @c N in the range @p [0,last2-first2), or @p last1 if no
- * such iterator exists.
+ * @param __first1 A forward iterator.
+ * @param __last1 A forward iterator.
+ * @param __first2 A forward iterator.
+ * @param __last2 A forward iterator.
+ * @return The first iterator @c i in the range @p
+ * [__first1,__last1-(__last2-__first2)) such that @c *(i+N) == @p
+ * *(__first2+N) for each @c N in the range @p
+ * [0,__last2-__first2), or @p __last1 if no such iterator exists.
*
- * Searches the range @p [first1,last1) for a sub-sequence that compares
- * equal value-by-value with the sequence given by @p [first2,last2) and
- * returns an iterator to the first element of the sub-sequence, or
- * @p last1 if the sub-sequence is not found.
+ * Searches the range @p [__first1,__last1) for a sub-sequence that
+ * compares equal value-by-value with the sequence given by @p
+ * [__first2,__last2) and returns an iterator to the first element
+ * of the sub-sequence, or @p __last1 if the sub-sequence is not
+ * found.
+ *
+ * Because the sub-sequence must lie completely within the range @p
+ * [__first1,__last1) it must start at a position less than @p
+ * __last1-(__last2-__first2) where @p __last2-__first2 is the
+ * length of the sub-sequence.
*
- * Because the sub-sequence must lie completely within the range
- * @p [first1,last1) it must start at a position less than
- * @p last1-(last2-first2) where @p last2-first2 is the length of the
- * sub-sequence.
* This means that the returned iterator @c i will be in the range
- * @p [first1,last1-(last2-first2))
+ * @p [__first1,__last1-(__last2-__first2))
*/
template<typename _ForwardIterator1, typename _ForwardIterator2>
_ForwardIterator1
/**
* @brief Search a sequence for a matching sub-sequence using a predicate.
* @ingroup non_mutating_algorithms
- * @param first1 A forward iterator.
- * @param last1 A forward iterator.
- * @param first2 A forward iterator.
- * @param last2 A forward iterator.
- * @param predicate A binary predicate.
+ * @param __first1 A forward iterator.
+ * @param __last1 A forward iterator.
+ * @param __first2 A forward iterator.
+ * @param __last2 A forward iterator.
+ * @param __predicate A binary predicate.
* @return The first iterator @c i in the range
- * @p [first1,last1-(last2-first2)) such that
- * @p predicate(*(i+N),*(first2+N)) is true for each @c N in the range
- * @p [0,last2-first2), or @p last1 if no such iterator exists.
+ * @p [__first1,__last1-(__last2-__first2)) such that
+ * @p __predicate(*(i+N),*(__first2+N)) is true for each @c N in the range
+ * @p [0,__last2-__first2), or @p __last1 if no such iterator exists.
*
- * Searches the range @p [first1,last1) for a sub-sequence that compares
- * equal value-by-value with the sequence given by @p [first2,last2),
- * using @p predicate to determine equality, and returns an iterator
- * to the first element of the sub-sequence, or @p last1 if no such
- * iterator exists.
+ * Searches the range @p [__first1,__last1) for a sub-sequence that
+ * compares equal value-by-value with the sequence given by @p
+ * [__first2,__last2), using @p __predicate to determine equality,
+ * and returns an iterator to the first element of the
+ * sub-sequence, or @p __last1 if no such iterator exists.
*
* @see search(_ForwardIter1, _ForwardIter1, _ForwardIter2, _ForwardIter2)
*/
/**
* @brief Search a sequence for a number of consecutive values.
* @ingroup non_mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param count The number of consecutive values.
- * @param val The value to find.
- * @return The first iterator @c i in the range @p [first,last-count)
- * such that @c *(i+N) == @p val for each @c N in the range @p [0,count),
- * or @p last if no such iterator exists.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __count The number of consecutive values.
+ * @param __val The value to find.
+ * @return The first iterator @c i in the range @p
+ * [__first,__last-__count) such that @c *(i+N) == @p __val for
+ * each @c N in the range @p [0,__count), or @p __last if no such
+ * iterator exists.
*
- * Searches the range @p [first,last) for @p count consecutive elements
- * equal to @p val.
+ * Searches the range @p [__first,__last) for @p count consecutive elements
+ * equal to @p __val.
*/
template<typename _ForwardIterator, typename _Integer, typename _Tp>
_ForwardIterator
* @brief Search a sequence for a number of consecutive values using a
* predicate.
* @ingroup non_mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param count The number of consecutive values.
- * @param val The value to find.
- * @param binary_pred A binary predicate.
- * @return The first iterator @c i in the range @p [first,last-count)
- * such that @p binary_pred(*(i+N),val) is true for each @c N in the
- * range @p [0,count), or @p last if no such iterator exists.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __count The number of consecutive values.
+ * @param __val The value to find.
+ * @param __binary_pred A binary predicate.
+ * @return The first iterator @c i in the range @p
+ * [__first,__last-__count) such that @p
+ * __binary_pred(*(i+N),__val) is true for each @c N in the range
+ * @p [0,__count), or @p __last if no such iterator exists.
*
- * Searches the range @p [first,last) for @p count consecutive elements
- * for which the predicate returns true.
+ * Searches the range @p [__first,__last) for @p __count
+ * consecutive elements for which the predicate returns true.
*/
template<typename _ForwardIterator, typename _Integer, typename _Tp,
typename _BinaryPredicate>
/**
* @brief Perform an operation on a sequence.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param unary_op A unary operator.
- * @return An output iterator equal to @p result+(last-first).
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __unary_op A unary operator.
+ * @return An output iterator equal to @p __result+(__last-__first).
*
* Applies the operator to each element in the input range and assigns
* the results to successive elements of the output sequence.
- * Evaluates @p *(result+N)=unary_op(*(first+N)) for each @c N in the
- * range @p [0,last-first).
+ * Evaluates @p *(__result+N)=unary_op(*(__first+N)) for each @c N in the
+ * range @p [0,__last-__first).
*
* @p unary_op must not alter its argument.
*/
/**
* @brief Perform an operation on corresponding elements of two sequences.
* @ingroup mutating_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param result An output iterator.
- * @param binary_op A binary operator.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __result An output iterator.
+ * @param __binary_op A binary operator.
* @return An output iterator equal to @p result+(last-first).
*
* Applies the operator to the corresponding elements in the two
* input ranges and assigns the results to successive elements of the
* output sequence.
- * Evaluates @p *(result+N)=binary_op(*(first1+N),*(first2+N)) for each
- * @c N in the range @p [0,last1-first1).
+ * Evaluates @p
+ * *(__result+N)=__binary_op(*(__first1+N),*(__first2+N)) for each
+ * @c N in the range @p [0,__last1-__first1).
*
* @p binary_op must not alter either of its arguments.
*/
* @brief Replace each occurrence of one value in a sequence with another
* value.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param old_value The value to be replaced.
- * @param new_value The replacement value.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __old_value The value to be replaced.
+ * @param __new_value The replacement value.
* @return replace() returns no value.
*
- * For each iterator @c i in the range @p [first,last) if @c *i ==
- * @p old_value then the assignment @c *i = @p new_value is performed.
+ * For each iterator @c i in the range @p [__first,__last) if @c *i ==
+ * @p __old_value then the assignment @c *i = @p __new_value is performed.
*/
template<typename _ForwardIterator, typename _Tp>
void
* @brief Replace each value in a sequence for which a predicate returns
* true with another value.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param pred A predicate.
- * @param new_value The replacement value.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __pred A predicate.
+ * @param __new_value The replacement value.
* @return replace_if() returns no value.
*
- * For each iterator @c i in the range @p [first,last) if @p pred(*i)
- * is true then the assignment @c *i = @p new_value is performed.
+ * For each iterator @c i in the range @p [__first,__last) if @p __pred(*i)
+ * is true then the assignment @c *i = @p __new_value is performed.
*/
template<typename _ForwardIterator, typename _Predicate, typename _Tp>
void
* @brief Assign the result of a function object to each value in a
* sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param gen A function object taking no arguments and returning
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __gen A function object taking no arguments and returning
* std::iterator_traits<_ForwardIterator>::value_type
* @return generate() returns no value.
*
- * Performs the assignment @c *i = @p gen() for each @c i in the range
- * @p [first,last).
+ * Performs the assignment @c *i = @p __gen() for each @c i in the range
+ * @p [__first,__last).
*/
template<typename _ForwardIterator, typename _Generator>
void
* @brief Assign the result of a function object to each value in a
* sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param n The length of the sequence.
- * @param gen A function object taking no arguments and returning
+ * @param __first A forward iterator.
+ * @param __n The length of the sequence.
+ * @param __gen A function object taking no arguments and returning
* std::iterator_traits<_ForwardIterator>::value_type
- * @return The end of the sequence, @p first+n
+ * @return The end of the sequence, @p __first+__n
*
- * Performs the assignment @c *i = @p gen() for each @c i in the range
- * @p [first,first+n).
+ * Performs the assignment @c *i = @p __gen() for each @c i in the range
+ * @p [__first,__first+__n).
*
* _GLIBCXX_RESOLVE_LIB_DEFECTS
* DR 865. More algorithms that throw away information
/**
* @brief Copy a sequence, removing consecutive duplicate values.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies each element in the range @p [first,last) to the range
- * beginning at @p result, except that only the first element is copied
+ * Copies each element in the range @p [__first,__last) to the range
+ * beginning at @p __result, except that only the first element is copied
* from groups of consecutive elements that compare equal.
* unique_copy() is stable, so the relative order of elements that are
* copied is unchanged.
/**
* @brief Copy a sequence, removing consecutive values using a predicate.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @param binary_pred A binary predicate.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @param __binary_pred A binary predicate.
* @return An iterator designating the end of the resulting sequence.
*
- * Copies each element in the range @p [first,last) to the range
- * beginning at @p result, except that only the first element is copied
- * from groups of consecutive elements for which @p binary_pred returns
+ * Copies each element in the range @p [__first,__last) to the range
+ * beginning at @p __result, except that only the first element is copied
+ * from groups of consecutive elements for which @p __binary_pred returns
* true.
* unique_copy() is stable, so the relative order of elements that are
* copied is unchanged.
/**
* @brief Randomly shuffle the elements of a sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
* @return Nothing.
*
- * Reorder the elements in the range @p [first,last) using a random
+ * Reorder the elements in the range @p [__first,__last) using a random
* distribution, so that every possible ordering of the sequence is
* equally likely.
*/
* @brief Shuffle the elements of a sequence using a random number
* generator.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param rand The RNG functor or function.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __rand The RNG functor or function.
* @return Nothing.
*
- * Reorders the elements in the range @p [first,last) using @p rand to
- * provide a random distribution. Calling @p rand(N) for a positive
+ * Reorders the elements in the range @p [__first,__last) using @p __rand to
+ * provide a random distribution. Calling @p __rand(N) for a positive
* integer @p N should return a randomly chosen integer from the
* range [0,N).
*/
* @brief Move elements for which a predicate is true to the beginning
* of a sequence.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param pred A predicate functor.
- * @return An iterator @p middle such that @p pred(i) is true for each
- * iterator @p i in the range @p [first,middle) and false for each @p i
- * in the range @p [middle,last).
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __pred A predicate functor.
+ * @return An iterator @p middle such that @p __pred(i) is true for each
+ * iterator @p i in the range @p [__first,middle) and false for each @p i
+ * in the range @p [middle,__last).
*
- * @p pred must not modify its operand. @p partition() does not preserve
+ * @p __pred must not modify its operand. @p partition() does not preserve
* the relative ordering of elements in each group, use
* @p stable_partition() if this is needed.
*/
/**
* @brief Sort the smallest elements of a sequence.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param middle Another iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __middle Another iterator.
+ * @param __last Another iterator.
* @return Nothing.
*
- * Sorts the smallest @p (middle-first) elements in the range
- * @p [first,last) and moves them to the range @p [first,middle). The
- * order of the remaining elements in the range @p [middle,last) is
+ * Sorts the smallest @p (__middle-__first) elements in the range
+ * @p [first,last) and moves them to the range @p [__first,__middle). The
+ * order of the remaining elements in the range @p [__middle,__last) is
* undefined.
* After the sort if @p i and @j are iterators in the range
- * @p [first,middle) such that @i precedes @j and @k is an iterator in
- * the range @p [middle,last) then @p *j<*i and @p *k<*i are both false.
+ * @p [__first,__middle) such that @i precedes @j and @k is an iterator in
+ * the range @p [__middle,__last) then @p *j<*i and @p *k<*i are both false.
*/
template<typename _RandomAccessIterator>
inline void
* @brief Sort the smallest elements of a sequence using a predicate
* for comparison.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param middle Another iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
+ * @param __first An iterator.
+ * @param __middle Another iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
* @return Nothing.
*
- * Sorts the smallest @p (middle-first) elements in the range
- * @p [first,last) and moves them to the range @p [first,middle). The
- * order of the remaining elements in the range @p [middle,last) is
+ * Sorts the smallest @p (__middle-__first) elements in the range
+ * @p [__first,__last) and moves them to the range @p [__first,__middle). The
+ * order of the remaining elements in the range @p [__middle,__last) is
* undefined.
* After the sort if @p i and @j are iterators in the range
- * @p [first,middle) such that @i precedes @j and @k is an iterator in
- * the range @p [middle,last) then @p *comp(j,*i) and @p comp(*k,*i)
+ * @p [__first,__middle) such that @i precedes @j and @k is an iterator in
+ * the range @p [__middle,__last) then @p *__comp(j,*i) and @p __comp(*k,*i)
* are both false.
*/
template<typename _RandomAccessIterator, typename _Compare>
/**
* @brief Sort a sequence just enough to find a particular position.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param nth Another iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __nth Another iterator.
+ * @param __last Another iterator.
* @return Nothing.
*
- * Rearranges the elements in the range @p [first,last) so that @p *nth
+ * Rearranges the elements in the range @p [__first,__last) so that @p *__nth
* is the same element that would have been in that position had the
* whole sequence been sorted.
- * whole sequence been sorted. The elements either side of @p *nth are
+ * whole sequence been sorted. The elements either side of @p *__nth are
* not completely sorted, but for any iterator @i in the range
- * @p [first,nth) and any iterator @j in the range @p [nth,last) it
+ * @p [__first,__nth) and any iterator @j in the range @p [__nth,__last) it
* holds that @p *j<*i is false.
*/
template<typename _RandomAccessIterator>
* @brief Sort a sequence just enough to find a particular position
* using a predicate for comparison.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param nth Another iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
+ * @param __first An iterator.
+ * @param __nth Another iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
* @return Nothing.
*
- * Rearranges the elements in the range @p [first,last) so that @p *nth
+ * Rearranges the elements in the range @p [__first,__last) so that @p *__nth
* is the same element that would have been in that position had the
- * whole sequence been sorted. The elements either side of @p *nth are
+ * whole sequence been sorted. The elements either side of @p *__nth are
* not completely sorted, but for any iterator @i in the range
- * @p [first,nth) and any iterator @j in the range @p [nth,last) it
- * holds that @p comp(*j,*i) is false.
+ * @p [__first,__nth) and any iterator @j in the range @p [__nth,__last) it
+ * holds that @p __comp(*j,*i) is false.
*/
template<typename _RandomAccessIterator, typename _Compare>
inline void
/**
* @brief Sort the elements of a sequence.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __last Another iterator.
* @return Nothing.
*
- * Sorts the elements in the range @p [first,last) in ascending order,
+ * Sorts the elements in the range @p [__first,__last) in ascending order,
* such that @p *(i+1)<*i is false for each iterator @p i in the range
- * @p [first,last-1).
+ * @p [__first,__last-1).
*
* The relative ordering of equivalent elements is not preserved, use
* @p stable_sort() if this is needed.
/**
* @brief Sort the elements of a sequence using a predicate for comparison.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
* @return Nothing.
*
- * Sorts the elements in the range @p [first,last) in ascending order,
- * such that @p comp(*(i+1),*i) is false for every iterator @p i in the
- * range @p [first,last-1).
+ * Sorts the elements in the range @p [__first,__last) in ascending order,
+ * such that @p __comp(*(i+1),*i) is false for every iterator @p i in the
+ * range @p [__first,__last-1).
*
* The relative ordering of equivalent elements is not preserved, use
* @p stable_sort() if this is needed.
/**
* @brief Merges two sorted ranges.
* @ingroup sorting_algorithms
- * @param first1 An iterator.
- * @param first2 Another iterator.
- * @param last1 Another iterator.
- * @param last2 Another iterator.
- * @param result An iterator pointing to the end of the merged range.
+ * @param __first1 An iterator.
+ * @param __first2 Another iterator.
+ * @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 <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
- * must be sorted, and the output range must not overlap with either of
- * the input ranges. The sort is @e stable, that is, for equivalent
- * elements in the two ranges, elements from the first range will always
- * come before elements from the second.
+ * Merges the ranges [__first1,__last1) and [__first2,__last2) into
+ * the sorted range [__result, __result + (__last1-__first1) +
+ * (__last2-__first2)). Both input ranges must be sorted, and the
+ * output range must not overlap with either of the input ranges.
+ * The sort is @e stable, that is, for equivalent elements in the
+ * two ranges, elements from the first range will always come
+ * before elements from the second.
*/
template<typename _InputIterator1, typename _InputIterator2,
typename _OutputIterator>
/**
* @brief Merges two sorted ranges.
* @ingroup sorting_algorithms
- * @param first1 An iterator.
- * @param first2 Another iterator.
- * @param last1 Another iterator.
- * @param last2 Another iterator.
- * @param result An iterator pointing to the end of the merged range.
- * @param comp A functor to use for comparisons.
+ * @param __first1 An iterator.
+ * @param __first2 Another iterator.
+ * @param __last1 Another iterator.
+ * @param __last2 Another iterator.
+ * @param __result An iterator pointing to the end of the merged range.
+ * @param __comp A functor to use for comparisons.
* @return An iterator pointing to the first element "not less
* than" @a val.
*
- * Merges the ranges [first1,last1) and [first2,last2) into the sorted range
- * [result, result + (last1-first1) + (last2-first2)). Both input ranges
- * must be sorted, and the output range must not overlap with either of
- * the input ranges. The sort is @e stable, that is, for equivalent
- * elements in the two ranges, elements from the first range will always
- * come before elements from the second.
+ * Merges the ranges [__first1,__last1) and [__first2,__last2) into
+ * the sorted range [__result, __result + (__last1-__first1) +
+ * (__last2-__first2)). Both input ranges must be sorted, and the
+ * output range must not overlap with either of the input ranges.
+ * The sort is @e stable, that is, for equivalent elements in the
+ * two ranges, elements from the first range will always come
+ * before elements from the second.
*
* The comparison function should have the same effects on ordering as
* the function used for the initial sort.
* @brief Sort the elements of a sequence, preserving the relative order
* of equivalent elements.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
+ * @param __first An iterator.
+ * @param __last Another iterator.
* @return Nothing.
*
- * Sorts the elements in the range @p [first,last) in ascending order,
+ * Sorts the elements in the range @p [__first,__last) in ascending order,
* such that @p *(i+1)<*i is false for each iterator @p i in the range
- * @p [first,last-1).
+ * @p [__first,__last-1).
*
* The relative ordering of equivalent elements is preserved, so any two
- * elements @p x and @p y in the range @p [first,last) such that
+ * elements @p x and @p y in the range @p [__first,__last) such that
* @p x<y is false and @p y<x is false will have the same relative
* ordering after calling @p stable_sort().
*/
* @brief Sort the elements of a sequence using a predicate for comparison,
* preserving the relative order of equivalent elements.
* @ingroup sorting_algorithms
- * @param first An iterator.
- * @param last Another iterator.
- * @param comp A comparison functor.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __comp A comparison functor.
* @return Nothing.
*
- * Sorts the elements in the range @p [first,last) in ascending order,
- * such that @p comp(*(i+1),*i) is false for each iterator @p i in the
- * range @p [first,last-1).
+ * Sorts the elements in the range @p [__first,__last) in ascending order,
+ * such that @p __comp(*(i+1),*i) is false for each iterator @p i in the
+ * range @p [__first,__last-1).
*
* The relative ordering of equivalent elements is preserved, so any two
- * elements @p x and @p y in the range @p [first,last) such that
- * @p comp(x,y) is false and @p comp(y,x) is false will have the same
+ * elements @p x and @p y in the range @p [__first,__last) such that
+ * @p __comp(x,y) is false and @p __comp(y,x) is false will have the same
* relative ordering after calling @p stable_sort().
*/
template<typename _RandomAccessIterator, typename _Compare>
/**
* @brief Return the union of two sorted ranges.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
* @return End of the output range.
* @ingroup set_algorithms
*
/**
* @brief Return the union of two sorted ranges using a comparison functor.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
- * @param comp The comparison functor.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
+ * @param __comp The comparison functor.
* @return End of the output range.
* @ingroup set_algorithms
*
* This operation iterates over both ranges, copying elements present in
* each range in order to the output range. Iterators increment for each
* range. When the current element of one range is less than the other
- * according to @a comp, that element is copied and the iterator advanced.
- * If an equivalent element according to @a comp is contained in both
+ * according to @a __comp, that element is copied and the iterator advanced.
+ * If an equivalent element according to @a __comp is contained in both
* ranges, the element from the first range is copied and both ranges
* advance. The output range may not overlap either input range.
*/
/**
* @brief Return the intersection of two sorted ranges.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
* @return End of the output range.
* @ingroup set_algorithms
*
* @brief Return the intersection of two sorted ranges using comparison
* functor.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
- * @param comp The comparison functor.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
+ * @param __comp The comparison functor.
* @return End of the output range.
* @ingroup set_algorithms
*
* This operation iterates over both ranges, copying elements present in
* both ranges in order to the output range. Iterators increment for each
* range. When the current element of one range is less than the other
- * according to @a comp, that iterator advances. If an element is
- * contained in both ranges according to @a comp, the element from the
+ * according to @a __comp, that iterator advances. If an element is
+ * contained in both ranges according to @a __comp, the element from the
* first range is copied and both ranges advance. The output range may not
* overlap either input range.
*/
/**
* @brief Return the difference of two sorted ranges.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
* @return End of the output range.
* @ingroup set_algorithms
*
* @brief Return the difference of two sorted ranges using comparison
* functor.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
- * @param comp The comparison functor.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
+ * @param __comp The comparison functor.
* @return End of the output range.
* @ingroup set_algorithms
*
/**
* @brief Return the symmetric difference of two sorted ranges.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
* @return End of the output range.
* @ingroup set_algorithms
*
* @brief Return the symmetric difference of two sorted ranges using
* comparison functor.
* @ingroup set_algorithms
- * @param first1 Start of first range.
- * @param last1 End of first range.
- * @param first2 Start of second range.
- * @param last2 End of second range.
- * @param comp The comparison functor.
+ * @param __first1 Start of first range.
+ * @param __last1 End of first range.
+ * @param __first2 Start of second range.
+ * @param __last2 End of second range.
+ * @param __comp The comparison functor.
* @return End of the output range.
* @ingroup set_algorithms
*
/**
* @brief Return the minimum element in a range.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
+ * @param __first Start of range.
+ * @param __last End of range.
* @return Iterator referencing the first instance of the smallest value.
*/
template<typename _ForwardIterator>
/**
* @brief Return the minimum element in a range using comparison functor.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
- * @param comp Comparison functor.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp Comparison functor.
* @return Iterator referencing the first instance of the smallest value
* according to comp.
*/
/**
* @brief Return the maximum element in a range.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
+ * @param __first Start of range.
+ * @param __last End of range.
* @return Iterator referencing the first instance of the largest value.
*/
template<typename _ForwardIterator>
/**
* @brief Return the maximum element in a range using comparison functor.
* @ingroup sorting_algorithms
- * @param first Start of range.
- * @param last End of range.
- * @param comp Comparison functor.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp Comparison functor.
* @return Iterator referencing the first instance of the largest value
- * according to comp.
+ * according to __comp.
*/
template<typename _ForwardIterator, typename _Compare>
_ForwardIterator
/**
* @brief Swaps the contents of two iterators.
* @ingroup mutating_algorithms
- * @param a An iterator.
- * @param b Another iterator.
+ * @param __a An iterator.
+ * @param __b Another iterator.
* @return Nothing.
*
* This function swaps the values pointed to by two iterators, not the
/**
* @brief Swap the elements of two sequences.
* @ingroup mutating_algorithms
- * @param first1 A forward iterator.
- * @param last1 A forward iterator.
- * @param first2 A forward iterator.
+ * @param __first1 A forward iterator.
+ * @param __last1 A forward iterator.
+ * @param __first2 A forward iterator.
* @return An iterator equal to @p first2+(last1-first1).
*
* Swaps each element in the range @p [first1,last1) with the
/**
* @brief This does what you think it does.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
* @return The lesser of the parameters.
*
* This is the simple classic generic implementation. It will work on
/**
* @brief This does what you think it does.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
* @return The greater of the parameters.
*
* This is the simple classic generic implementation. It will work on
/**
* @brief This does what you think it does.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
- * @param comp A @link comparison_functors comparison functor@endlink.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
+ * @param __comp A @link comparison_functors comparison functor@endlink.
* @return The lesser of the parameters.
*
* This will work on temporary expressions, since they are only evaluated
/**
* @brief This does what you think it does.
* @ingroup sorting_algorithms
- * @param a A thing of arbitrary type.
- * @param b Another thing of arbitrary type.
- * @param comp A @link comparison_functors comparison functor@endlink.
+ * @param __a A thing of arbitrary type.
+ * @param __b Another thing of arbitrary type.
+ * @param __comp A @link comparison_functors comparison functor@endlink.
* @return The greater of the parameters.
*
* This will work on temporary expressions, since they are only evaluated
/**
* @brief Copies the range [first,last) into result.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
* @return result + (first - last)
*
* This inline function will boil down to a call to @c memmove whenever
/**
* @brief Moves the range [first,last) into result.
* @ingroup mutating_algorithms
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
* @return result + (first - last)
*
* This inline function will boil down to a call to @c memmove whenever
/**
* @brief Copies the range [first,last) into result.
* @ingroup mutating_algorithms
- * @param first A bidirectional iterator.
- * @param last A bidirectional iterator.
- * @param result A bidirectional iterator.
+ * @param __first A bidirectional iterator.
+ * @param __last A bidirectional iterator.
+ * @param __result A bidirectional iterator.
* @return result - (first - last)
*
* The function has the same effect as copy, but starts at the end of the
/**
* @brief Moves the range [first,last) into result.
* @ingroup mutating_algorithms
- * @param first A bidirectional iterator.
- * @param last A bidirectional iterator.
- * @param result A bidirectional iterator.
+ * @param __first A bidirectional iterator.
+ * @param __last A bidirectional iterator.
+ * @param __result A bidirectional iterator.
* @return result - (first - last)
*
* The function has the same effect as move, but starts at the end of the
/**
* @brief Fills the range [first,last) with copies of value.
* @ingroup mutating_algorithms
- * @param first A forward iterator.
- * @param last A forward iterator.
- * @param value A reference-to-const of arbitrary type.
+ * @param __first A forward iterator.
+ * @param __last A forward iterator.
+ * @param __value A reference-to-const of arbitrary type.
* @return Nothing.
*
* This function fills a range with copies of the same value. For char
/**
* @brief Fills the range [first,first+n) with copies of value.
* @ingroup mutating_algorithms
- * @param first An output iterator.
- * @param n The count of copies to perform.
- * @param value A reference-to-const of arbitrary type.
+ * @param __first An output iterator.
+ * @param __n The count of copies to perform.
+ * @param __value A reference-to-const of arbitrary type.
* @return The iterator at first+n.
*
* This function fills a range with copies of the same value. For char
/**
* @brief Finds the first position in which @a val could be inserted
* without changing the ordering.
- * @param first An iterator.
- * @param last Another iterator.
- * @param val The search term.
+ * @param __first An iterator.
+ * @param __last Another iterator.
+ * @param __val The search term.
* @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.
/**
* @brief Tests a range for element-wise equality.
* @ingroup non_mutating_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
* @return A boolean true or false.
*
* This compares the elements of two ranges using @c == and returns true or
/**
* @brief Tests a range for element-wise equality.
* @ingroup non_mutating_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param binary_pred A binary predicate @link functors
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __binary_pred A binary predicate @link functors
* functor@endlink.
* @return A boolean true or false.
*
/**
* @brief Performs @b dictionary comparison on ranges.
* @ingroup sorting_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param last2 An input iterator.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __last2 An input iterator.
* @return A boolean true or false.
*
* <em>Returns true if the sequence of elements defined by the range
/**
* @brief Performs @b dictionary comparison on ranges.
* @ingroup sorting_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param last2 An input iterator.
- * @param comp A @link comparison_functors comparison functor@endlink.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __last2 An input iterator.
+ * @param __comp A @link comparison_functors comparison functor@endlink.
* @return A boolean true or false.
*
* The same as the four-parameter @c lexicographical_compare, but uses the
/**
* @brief Finds the places in ranges which don't match.
* @ingroup non_mutating_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
* @return A pair of iterators pointing to the first mismatch.
*
* This compares the elements of two ranges using @c == and returns a pair
/**
* @brief Finds the places in ranges which don't match.
* @ingroup non_mutating_algorithms
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param binary_pred A binary predicate @link functors
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __binary_pred A binary predicate @link functors
* functor@endlink.
* @return A pair of iterators pointing to the first mismatch.
*
/**
* @brief This function controls the size of memory nodes.
- * @param size The size of an element.
+ * @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
/**
* @brief Layout storage.
- * @param num_elements The count of T's for which to allocate space
+ * @param __num_elements The count of T's for which to allocate space
* at first.
* @return Nothing.
*
* - iterator _M_start, _M_finish
*
* map_size is at least 8. %map is an array of map_size
- * pointers-to-@anodes. (The name %map has nothing to do with the
+ * pointers-to-@a nodes. (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.)
*
/**
* @brief Creates a %deque with no elements.
- * @param a An allocator object.
+ * @param __a An allocator object.
*/
explicit
deque(const allocator_type& __a)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Creates a %deque with default constructed elements.
- * @param n The number of elements to initially create.
+ * @param __n The number of elements to initially create.
*
* This constructor fills the %deque with @a n default
* constructed elements.
/**
* @brief Creates a %deque with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator.
*
- * This constructor fills the %deque with @a n copies of @a value.
+ * This constructor fills the %deque with @a __n copies of @a __value.
*/
deque(size_type __n, const value_type& __value,
const allocator_type& __a = allocator_type())
#else
/**
* @brief Creates a %deque with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator.
*
- * This constructor fills the %deque with @a n copies of @a value.
+ * This constructor fills the %deque with @a __n copies of @a __value.
*/
explicit
deque(size_type __n, const value_type& __value = value_type(),
/**
* @brief %Deque copy constructor.
- * @param x A %deque of identical element and allocator types.
+ * @param __x A %deque of identical element and allocator types.
*
* The newly-created %deque uses a copy of the allocation object used
- * by @a x.
+ * by @a __x.
*/
deque(const deque& __x)
: _Base(__x._M_get_Tp_allocator(), __x.size())
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Deque move constructor.
- * @param x A %deque of identical element and allocator types.
+ * @param __x A %deque of identical element and allocator types.
*
- * The newly-created %deque contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %deque.
+ * The newly-created %deque contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %deque.
*/
deque(deque&& __x)
: _Base(std::move(__x)) { }
/**
* @brief Builds a %deque from an initializer list.
- * @param l An initializer_list.
- * @param a An allocator object.
+ * @param __l An initializer_list.
+ * @param __a An allocator object.
*
* Create a %deque consisting of copies of the elements in the
- * initializer_list @a l.
+ * initializer_list @a __l.
*
* This will call the element type's copy constructor N times
- * (where N is l.size()) and do no memory reallocation.
+ * (where N is __l.size()) and do no memory reallocation.
*/
deque(initializer_list<value_type> __l,
const allocator_type& __a = allocator_type())
/**
* @brief Builds a %deque from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __a An allocator object.
*
- * Create a %deque consisting of copies of the elements from [first,
- * last).
+ * Create a %deque consisting of copies of the elements from [__first,
+ * __last).
*
* If the iterators are forward, bidirectional, or random-access, then
* this will call the elements' copy constructor N times (where N is
- * distance(first,last)) and do no memory reallocation. But if only
+ * distance(__first,__last)) and do no memory reallocation. But if only
* input iterators are used, then this will do at most 2N calls to the
* copy constructor, and logN memory reallocations.
*/
/**
* @brief %Deque assignment operator.
- * @param x A %deque of identical element and allocator types.
+ * @param __x A %deque of identical element and allocator types.
*
* All the elements of @a x are copied, but unlike the copy constructor,
* the allocator object is not copied.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Deque move assignment operator.
- * @param x A %deque of identical element and allocator types.
+ * @param __x A %deque of identical element and allocator types.
*
- * The contents of @a x are moved into this deque (without copying).
- * @a x is a valid, but unspecified %deque.
+ * The contents of @a __x are moved into this deque (without copying).
+ * @a __x is a valid, but unspecified %deque.
*/
deque&
operator=(deque&& __x)
/**
* @brief Assigns an initializer list to a %deque.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %deque with copies of the elements in the
- * initializer_list @a l.
+ * initializer_list @a __l.
*
* Note that the assignment completely changes the %deque and that the
* resulting %deque's size is the same as the number of elements
/**
* @brief Assigns a given value to a %deque.
- * @param n Number of elements to be assigned.
- * @param val Value to be assigned.
+ * @param __n Number of elements to be assigned.
+ * @param __val Value to be assigned.
*
* This function fills a %deque with @a n copies of the given
* value. Note that the assignment completely changes the
/**
* @brief Assigns a range to a %deque.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function fills a %deque with copies of the elements in the
- * range [first,last).
+ * range [__first,__last).
*
* Note that the assignment completely changes the %deque and that the
* resulting %deque's size is the same as the number of elements
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Assigns an initializer list to a %deque.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %deque with copies of the elements in the
- * initializer_list @a l.
+ * initializer_list @a __l.
*
* Note that the assignment completely changes the %deque and that the
* resulting %deque's size is the same as the number of elements
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Resizes the %deque to the specified number of elements.
- * @param new_size Number of elements the %deque should contain.
+ * @param __new_size Number of elements the %deque should contain.
*
* This function will %resize the %deque to the specified
* number of elements. If the number is smaller than the
/**
* @brief Resizes the %deque to the specified number of elements.
- * @param new_size Number of elements the %deque should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %deque should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %deque to the specified
* number of elements. If the number is smaller than the
#else
/**
* @brief Resizes the %deque to the specified number of elements.
- * @param new_size Number of elements the %deque should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %deque should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %deque to the specified
* number of elements. If the number is smaller than the
// element access
/**
* @brief Subscript access to the data contained in the %deque.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read/write reference to data.
*
/**
* @brief Subscript access to the data contained in the %deque.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read-only (constant) reference to data.
*
public:
/**
* @brief Provides access to the data contained in the %deque.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read/write reference to data.
- * @throw std::out_of_range If @a n is an invalid index.
+ * @throw std::out_of_range If @a __n is an invalid index.
*
* This function provides for safer data access. The parameter
* is first checked that it is in the range of the deque. The
/**
* @brief Provides access to the data contained in the %deque.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read-only (constant) reference to data.
- * @throw std::out_of_range If @a n is an invalid index.
+ * @throw std::out_of_range If @a __n is an invalid index.
*
* This function provides for safer data access. The parameter is first
* checked that it is in the range of the deque. The function throws
// [23.2.1.2] modifiers
/**
* @brief Add data to the front of the %deque.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the front of the %deque and assigns the given
/**
* @brief Add data to the end of the %deque.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the end of the %deque and assigns the given data
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Inserts an object in %deque before specified iterator.
- * @param position An iterator into the %deque.
- * @param args Arguments.
+ * @param __position An iterator into the %deque.
+ * @param __args Arguments.
* @return An iterator that points to the inserted data.
*
* This function will insert an object of type T constructed
/**
* @brief Inserts given value into %deque before specified iterator.
- * @param position An iterator into the %deque.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %deque.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given value before the
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Inserts given rvalue into %deque before specified iterator.
- * @param position An iterator into the %deque.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %deque.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given rvalue before the
/**
* @brief Inserts an initializer list into the %deque.
- * @param p An iterator into the %deque.
- * @param l An initializer_list.
+ * @param __p An iterator into the %deque.
+ * @param __l An initializer_list.
*
* 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 <em>list insert</em>.
+ * initializer_list @a __l into the %deque before the location
+ * specified by @a __p. This is known as <em>list insert</em>.
*/
void
insert(iterator __p, initializer_list<value_type> __l)
/**
* @brief Inserts a number of copies of given data into the %deque.
- * @param position An iterator into the %deque.
- * @param n Number of elements to be inserted.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %deque.
+ * @param __n Number of elements to be inserted.
+ * @param __x Data to be inserted.
*
* This function will insert a specified number of copies of the given
- * data before the location specified by @a position.
+ * data before the location specified by @a __position.
*/
void
insert(iterator __position, size_type __n, const value_type& __x)
/**
* @brief Inserts a range into the %deque.
- * @param position An iterator into the %deque.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __position An iterator into the %deque.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* 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 <em>range insert</em>.
+ * [__first,__last) into the %deque before the location specified
+ * by @a __position. This is known as <em>range insert</em>.
*/
template<typename _InputIterator>
void
/**
* @brief Remove element at given position.
- * @param position Iterator pointing to element to be erased.
+ * @param __position Iterator pointing to element to be erased.
* @return An iterator pointing to the next element (or end()).
*
* This function will erase the element at the given position and thus
/**
* @brief Remove a range of elements.
- * @param first Iterator pointing to the first element to be erased.
- * @param last Iterator pointing to one past the last element to be
+ * @param __first Iterator pointing to the first element to be erased.
+ * @param __last Iterator pointing to one past the last element to be
* erased.
* @return An iterator pointing to the element pointed to by @a last
* prior to erasing (or end()).
*
- * This function will erase the elements in the range [first,last) and
- * shorten the %deque accordingly.
+ * This function will erase the elements in the range
+ * [__first,__last) and shorten the %deque accordingly.
*
* The user is cautioned that
* this function only erases the elements, and that if the elements
/**
* @brief Swaps data with another %deque.
- * @param x A %deque of the same element and allocator types.
+ * @param __x A %deque of the same element and allocator types.
*
* This exchanges the elements between two deques in constant time.
* (Four pointers, so it should be quite fast.)
//@{
/**
* @brief Fills the deque with whatever is in [first,last).
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
* @return Nothing.
*
* If the iterators are actually forward iterators (or better), then the
/**
* @brief Fills the %deque with copies of value.
- * @param value Initial value.
+ * @param __value Initial value.
* @return Nothing.
* @pre _M_start and _M_finish have already been initialized,
* but none of the %deque's elements have yet been constructed.
/**
* @brief Deque equality comparison.
- * @param x A %deque.
- * @param y A %deque of the same type as @a x.
+ * @param __x A %deque.
+ * @param __y A %deque of the same type as @a __x.
* @return True iff the size and elements of the deques are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Deque ordering relation.
- * @param x A %deque.
- * @param y A %deque of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %deque.
+ * @param __y A %deque of the same type as @a __x.
+ * @return True iff @a x is lexicographically less than @a __y.
*
* This is a total ordering relation. It is linear in the size of the
* deques. The elements must be comparable with @c <.
/**
* @brief Push an element onto a heap.
- * @param first Start of heap.
- * @param last End of heap + element.
+ * @param __first Start of heap.
+ * @param __last End of heap + element.
* @ingroup heap_algorithms
*
- * This operation pushes the element at last-1 onto the valid heap over the
- * range [first,last-1). After completion, [first,last) is a valid heap.
+ * This operation pushes the element at last-1 onto the valid heap
+ * over the range [__first,__last-1). After completion,
+ * [__first,__last) is a valid heap.
*/
template<typename _RandomAccessIterator>
inline void
/**
* @brief Push an element onto a heap using comparison functor.
- * @param first Start of heap.
- * @param last End of heap + element.
- * @param comp Comparison functor.
+ * @param __first Start of heap.
+ * @param __last End of heap + element.
+ * @param __comp Comparison functor.
* @ingroup heap_algorithms
*
- * This operation pushes the element at last-1 onto the valid heap over the
- * range [first,last-1). After completion, [first,last) is a valid heap.
- * Compare operations are performed using comp.
+ * This operation pushes the element at __last-1 onto the valid
+ * heap over the range [__first,__last-1). After completion,
+ * [__first,__last) is a valid heap. Compare operations are
+ * performed using comp.
*/
template<typename _RandomAccessIterator, typename _Compare>
inline void
/**
* @brief Pop an element off a heap.
- * @param first Start of heap.
- * @param last End of heap.
+ * @param __first Start of heap.
+ * @param __last End of heap.
* @ingroup heap_algorithms
*
- * This operation pops the top of the heap. The elements first and last-1
- * are swapped and [first,last-1) is made into a heap.
+ * This operation pops the top of the heap. The elements __first
+ * and __last-1 are swapped and [__first,__last-1) is made into a
+ * heap.
*/
template<typename _RandomAccessIterator>
inline void
/**
* @brief Pop an element off a heap using comparison functor.
- * @param first Start of heap.
- * @param last End of heap.
- * @param comp Comparison functor to use.
+ * @param __first Start of heap.
+ * @param __last End of heap.
+ * @param __comp Comparison functor to use.
* @ingroup heap_algorithms
*
- * This operation pops the top of the heap. The elements first and last-1
- * are swapped and [first,last-1) is made into a heap. Comparisons are
- * made using comp.
+ * This operation pops the top of the heap. The elements __first
+ * and __last-1 are swapped and [__first,__last-1) is made into a
+ * heap. Comparisons are made using comp.
*/
template<typename _RandomAccessIterator, typename _Compare>
inline void
/**
* @brief Construct a heap over a range.
- * @param first Start of heap.
- * @param last End of heap.
+ * @param __first Start of heap.
+ * @param __last End of heap.
* @ingroup heap_algorithms
*
- * This operation makes the elements in [first,last) into a heap.
+ * This operation makes the elements in [__first,__last) into a heap.
*/
template<typename _RandomAccessIterator>
void
/**
* @brief Construct a heap over a range using comparison functor.
- * @param first Start of heap.
- * @param last End of heap.
- * @param comp Comparison functor to use.
+ * @param __first Start of heap.
+ * @param __last End of heap.
+ * @param __comp Comparison functor to use.
* @ingroup heap_algorithms
*
- * This operation makes the elements in [first,last) into a heap.
- * Comparisons are made using comp.
+ * This operation makes the elements in [__first,__last) into a heap.
+ * Comparisons are made using __comp.
*/
template<typename _RandomAccessIterator, typename _Compare>
void
/**
* @brief Sort a heap.
- * @param first Start of heap.
- * @param last End of heap.
+ * @param __first Start of heap.
+ * @param __last End of heap.
* @ingroup heap_algorithms
*
- * This operation sorts the valid heap in the range [first,last).
+ * This operation sorts the valid heap in the range [__first,__last).
*/
template<typename _RandomAccessIterator>
void
/**
* @brief Sort a heap using comparison functor.
- * @param first Start of heap.
- * @param last End of heap.
- * @param comp Comparison functor to use.
+ * @param __first Start of heap.
+ * @param __last End of heap.
+ * @param __comp Comparison functor to use.
* @ingroup heap_algorithms
*
- * This operation sorts the valid heap in the range [first,last).
- * Comparisons are made using comp.
+ * This operation sorts the valid heap in the range [__first,__last).
+ * Comparisons are made using __comp.
*/
template<typename _RandomAccessIterator, typename _Compare>
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Search the end of a heap.
- * @param first Start of range.
- * @param last End of range.
+ * @param __first Start of range.
+ * @param __last End of range.
* @return An iterator pointing to the first element not in the heap.
* @ingroup heap_algorithms
*
- * This operation returns the last iterator i in [first, last) for which
- * the range [first, i) is a heap.
+ * This operation returns the last iterator i in [__first, __last) for which
+ * the range [__first, i) is a heap.
*/
template<typename _RandomAccessIterator>
inline _RandomAccessIterator
/**
* @brief Search the end of a heap using comparison functor.
- * @param first Start of range.
- * @param last End of range.
- * @param comp Comparison functor to use.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp Comparison functor to use.
* @return An iterator pointing to the first element not in the heap.
* @ingroup heap_algorithms
*
- * This operation returns the last iterator i in [first, last) for which
- * the range [first, i) is a heap. Comparisons are made using comp.
+ * This operation returns the last iterator i in [__first, __last) for which
+ * the range [__first, i) is a heap. Comparisons are made using __comp.
*/
template<typename _RandomAccessIterator, typename _Compare>
inline _RandomAccessIterator
/**
* @brief Determines whether a range is a heap.
- * @param first Start of range.
- * @param last End of range.
+ * @param __first Start of range.
+ * @param __last End of range.
* @return True if range is a heap, false otherwise.
* @ingroup heap_algorithms
*/
/**
* @brief Determines whether a range is a heap using comparison functor.
- * @param first Start of range.
- * @param last End of range.
- * @param comp Comparison functor to use.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __comp Comparison functor to use.
* @return True if range is a heap, false otherwise.
* @ingroup heap_algorithms
*/
//@{
/**
- * @param x A %reverse_iterator.
- * @param y A %reverse_iterator.
+ * @param __x A %reverse_iterator.
+ * @param __y A %reverse_iterator.
* @return A simple bool.
*
* Reverse iterators forward many operations to their underlying base()
back_insert_iterator(_Container& __x) : container(&__x) { }
/**
- * @param value An instance of whatever type
+ * @param __value An instance of whatever type
* container_type::const_reference is; presumably a
* reference-to-const T for container<T>.
* @return This %iterator, for chained operations.
};
/**
- * @param x A container of arbitrary type.
- * @return An instance of back_insert_iterator working on @p x.
+ * @param __x A container of arbitrary type.
+ * @return An instance of back_insert_iterator working on @p __x.
*
* This wrapper function helps in creating back_insert_iterator instances.
* Typing the name of the %iterator requires knowing the precise full
explicit front_insert_iterator(_Container& __x) : container(&__x) { }
/**
- * @param value An instance of whatever type
+ * @param __value An instance of whatever type
* container_type::const_reference is; presumably a
* reference-to-const T for container<T>.
* @return This %iterator, for chained operations.
};
/**
- * @param x A container of arbitrary type.
+ * @param __x A container of arbitrary type.
* @return An instance of front_insert_iterator working on @p x.
*
* This wrapper function helps in creating front_insert_iterator instances.
: container(&__x), iter(__i) {}
/**
- * @param value An instance of whatever type
+ * @param __value An instance of whatever type
* container_type::const_reference is; presumably a
* reference-to-const T for container<T>.
* @return This %iterator, for chained operations.
};
/**
- * @param x A container of arbitrary type.
- * @return An instance of insert_iterator working on @p x.
+ * @param __x A container of arbitrary type.
+ * @return An instance of insert_iterator working on @p __x.
*
* This wrapper function helps in creating insert_iterator instances.
* Typing the name of the %iterator requires knowing the precise full
/**
* @brief A generalization of pointer arithmetic.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
* @return The distance between them.
*
- * Returns @c n such that first + n == last. This requires that @p last
- * must be reachable from @p first. Note that @c n may be negative.
+ * Returns @c n such that __first + n == __last. This requires
+ * that @p __last must be reachable from @p __first. Note that @c
+ * n may be negative.
*
* For random access iterators, this uses their @c + and @c - operations
* and are constant time. For other %iterator classes they are linear time.
/**
* @brief A generalization of pointer arithmetic.
- * @param i An input iterator.
- * @param n The @a delta by which to change @p i.
+ * @param __i An input iterator.
+ * @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
- * iterators, @p n may be negative, in which case @p i is decremented.
+ * iterators, @p __n may be negative, in which case @p __i is decremented.
*
* For random access iterators, this uses their @c + and @c - operations
* and are constant time. For other %iterator classes they are linear time.
using _Base::_M_get_Node_allocator;
/**
- * @param x An instance of user data.
+ * @param __args An instance of user data.
*
- * Allocates space for a new node and constructs a copy of @a x in it.
+ * Allocates space for a new node and constructs a copy of
+ * @a __args in it.
*/
#ifndef __GXX_EXPERIMENTAL_CXX0X__
_Node*
/**
* @brief Creates a %list with no elements.
- * @param a An allocator object.
+ * @param __a An allocator object.
*/
explicit
list(const allocator_type& __a)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Creates a %list with default constructed elements.
- * @param n The number of elements to initially create.
+ * @param __n The number of elements to initially create.
*
- * This constructor fills the %list with @a n default
+ * This constructor fills the %list with @a __n default
* constructed elements.
*/
explicit
/**
* @brief Creates a %list with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator object.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator object.
*
- * This constructor fills the %list with @a n copies of @a value.
+ * This constructor fills the %list with @a __n copies of @a __value.
*/
list(size_type __n, const value_type& __value,
const allocator_type& __a = allocator_type())
#else
/**
* @brief Creates a %list with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator object.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator object.
*
- * This constructor fills the %list with @a n copies of @a value.
+ * This constructor fills the %list with @a __n copies of @a __value.
*/
explicit
list(size_type __n, const value_type& __value = value_type(),
/**
* @brief %List copy constructor.
- * @param x A %list of identical element and allocator types.
+ * @param __x A %list of identical element and allocator types.
*
* The newly-created %list uses a copy of the allocation object used
- * by @a x.
+ * by @a __x.
*/
list(const list& __x)
: _Base(__x._M_get_Node_allocator())
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %List move constructor.
- * @param x A %list of identical element and allocator types.
+ * @param __x A %list of identical element and allocator types.
*
- * The newly-created %list contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %list.
+ * The newly-created %list contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %list.
*/
list(list&& __x) noexcept
: _Base(std::move(__x)) { }
/**
* @brief Builds a %list from an initializer_list
- * @param l An initializer_list of value_type.
- * @param a An allocator object.
+ * @param __l An initializer_list of value_type.
+ * @param __a An allocator object.
*
* Create a %list consisting of copies of the elements in the
- * initializer_list @a l. This is linear in l.size().
+ * initializer_list @a __l. This is linear in __l.size().
*/
list(initializer_list<value_type> __l,
const allocator_type& __a = allocator_type())
/**
* @brief Builds a %list from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __a An allocator object.
*
* Create a %list consisting of copies of the elements from
- * [@a first,@a last). This is linear in N (where N is
- * distance(@a first,@a last)).
+ * [@a __first,@a __last). This is linear in N (where N is
+ * distance(@a __first,@a __last)).
*/
template<typename _InputIterator>
list(_InputIterator __first, _InputIterator __last,
/**
* @brief %List assignment operator.
- * @param x A %list of identical element and allocator types.
+ * @param __x A %list of identical element and allocator types.
*
- * All the elements of @a x are copied, but unlike the copy
+ * All the elements of @a __x are copied, but unlike the copy
* constructor, the allocator object is not copied.
*/
list&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %List move assignment operator.
- * @param x A %list of identical element and allocator types.
+ * @param __x A %list of identical element and allocator types.
*
- * The contents of @a x are moved into this %list (without copying).
- * @a x is a valid, but unspecified %list
+ * The contents of @a __x are moved into this %list (without copying).
+ * @a __x is a valid, but unspecified %list
*/
list&
operator=(list&& __x)
/**
* @brief %List initializer list assignment operator.
- * @param l An initializer_list of value_type.
+ * @param __l An initializer_list of value_type.
*
* Replace the contents of the %list with copies of the elements
- * in the initializer_list @a l. This is linear in l.size().
+ * in the initializer_list @a __l. This is linear in l.size().
*/
list&
operator=(initializer_list<value_type> __l)
/**
* @brief Assigns a given value to a %list.
- * @param n Number of elements to be assigned.
- * @param val Value to be assigned.
+ * @param __n Number of elements to be assigned.
+ * @param __val Value to be assigned.
*
- * This function fills a %list with @a n copies of the given
+ * This function fills a %list with @a __n copies of the given
* value. Note that the assignment completely changes the %list
* and that the resulting %list's size is the same as the number
* of elements assigned. Old data may be lost.
/**
* @brief Assigns a range to a %list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function fills a %list with copies of the elements in the
- * range [@a first,@a last).
+ * range [@a __first,@a __last).
*
* Note that the assignment completely changes the %list and
* that the resulting %list's size is the same as the number of
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Assigns an initializer_list to a %list.
- * @param l An initializer_list of value_type.
+ * @param __l An initializer_list of value_type.
*
* Replace the contents of the %list with copies of the elements
- * in the initializer_list @a l. This is linear in l.size().
+ * in the initializer_list @a __l. This is linear in __l.size().
*/
void
assign(initializer_list<value_type> __l)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Resizes the %list to the specified number of elements.
- * @param new_size Number of elements the %list should contain.
+ * @param __new_size Number of elements the %list should contain.
*
* This function will %resize the %list to the specified number
* of elements. If the number is smaller than the %list's
/**
* @brief Resizes the %list to the specified number of elements.
- * @param new_size Number of elements the %list should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %list should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %list to the specified number
* of elements. If the number is smaller than the %list's
#else
/**
* @brief Resizes the %list to the specified number of elements.
- * @param new_size Number of elements the %list should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %list should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %list to the specified number
* of elements. If the number is smaller than the %list's
// [23.2.2.3] modifiers
/**
* @brief Add data to the front of the %list.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the front of the %list and assigns the given data
/**
* @brief Add data to the end of the %list.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the end of the %list and assigns the given data to
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Constructs object in %list before specified iterator.
- * @param position A const_iterator into the %list.
- * @param args Arguments.
+ * @param __position A const_iterator into the %list.
+ * @param __args Arguments.
* @return An iterator that points to the inserted data.
*
* This function will insert an object of type T constructed
/**
* @brief Inserts given value into %list before specified iterator.
- * @param position An iterator into the %list.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %list.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given value before
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Inserts given rvalue into %list before specified iterator.
- * @param position An iterator into the %list.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %list.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given rvalue before
/**
* @brief Inserts the contents of an initializer_list into %list
* before specified iterator.
- * @param p An iterator into the %list.
- * @param l An initializer_list of value_type.
+ * @param __p An iterator into the %list.
+ * @param __l An initializer_list of value_type.
*
* This function will insert copies of the data in the
* initializer_list @a l into the %list before the location
/**
* @brief Inserts a number of copies of given data into the %list.
- * @param position An iterator into the %list.
- * @param n Number of elements to be inserted.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %list.
+ * @param __n Number of elements to be inserted.
+ * @param __x Data to be inserted.
*
* This function will insert a specified number of copies of the
* given data before the location specified by @a position.
/**
* @brief Inserts a range into the %list.
- * @param position An iterator into the %list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __position An iterator into the %list.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function will insert copies of the data in the range [@a
* first,@a last) into the %list before the location specified by
/**
* @brief Remove element at given position.
- * @param position Iterator pointing to element to be erased.
+ * @param __position Iterator pointing to element to be erased.
* @return An iterator pointing to the next element (or end()).
*
* This function will erase the element at the given position and thus
/**
* @brief Remove a range of elements.
- * @param first Iterator pointing to the first element to be erased.
- * @param last Iterator pointing to one past the last element to be
+ * @param __first Iterator pointing to the first element to be erased.
+ * @param __last Iterator pointing to one past the last element to be
* erased.
* @return An iterator pointing to the element pointed to by @a last
* prior to erasing (or end()).
/**
* @brief Swaps data with another %list.
- * @param x A %list of the same element and allocator types.
+ * @param __x A %list of the same element and allocator types.
*
* This exchanges the elements between two lists in constant
* time. Note that the global std::swap() function is
// [23.2.2.4] list operations
/**
* @brief Insert contents of another %list.
- * @param position Iterator referencing the element to insert before.
- * @param x Source list.
+ * @param __position Iterator referencing the element to insert before.
+ * @param __x Source list.
*
- * The elements of @a x are inserted in constant time in front of
- * the element referenced by @a position. @a x becomes an empty
+ * The elements of @a __x are inserted in constant time in front of
+ * the element referenced by @a __position. @a __x becomes an empty
* list.
*
- * Requires this != @a x.
+ * Requires this != @a __x.
*/
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Insert element from another %list.
- * @param position Iterator referencing the element to insert before.
- * @param x Source list.
- * @param i Iterator referencing the element to move.
+ * @param __position Iterator referencing the element to insert before.
+ * @param __x Source list.
+ * @param __i Iterator referencing the element to move.
*
- * Removes the element in list @a x referenced by @a i and
- * inserts it into the current list before @a position.
+ * Removes the element in list @a __x referenced by @a __i and
+ * inserts it into the current list before @a __position.
*/
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Insert range from another %list.
- * @param position Iterator referencing the element to insert before.
- * @param x Source list.
- * @param first Iterator referencing the start of range in x.
- * @param last Iterator referencing the end of range in x.
+ * @param __position Iterator referencing the element to insert before.
+ * @param __x Source list.
+ * @param __first Iterator referencing the start of range in x.
+ * @param __last Iterator referencing the end of range in x.
*
- * Removes elements in the range [first,last) and inserts them
- * before @a position in constant time.
+ * Removes elements in the range [__first,__last) and inserts them
+ * before @a __position in constant time.
*
- * Undefined if @a position is in [first,last).
+ * Undefined if @a __position is in [__first,__last).
*/
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Remove all elements equal to value.
- * @param value The value to remove.
+ * @param __value The value to remove.
*
* Removes every element in the list equal to @a value.
* Remaining elements stay in list order. Note that this
/**
* @brief Remove all elements satisfying a predicate.
- * @param Predicate Unary predicate function or object.
+ * @tparam _Predicate Unary predicate function or object.
*
* Removes every element in the list for which the predicate
* returns true. Remaining elements stay in list order. Note
/**
* @brief Remove consecutive elements satisfying a predicate.
- * @param BinaryPredicate Binary predicate function or object.
+ * @tparam _BinaryPredicate Binary predicate function or object.
*
* For each consecutive set of elements [first,last) that
* satisfy predicate(first,i) where i is an iterator in
/**
* @brief Merge sorted lists.
- * @param x Sorted list to merge.
+ * @param __x Sorted list to merge.
*
- * Assumes that both @a x and this list are sorted according to
- * operator<(). Merges elements of @a x into this list in
- * sorted order, leaving @a x empty when complete. Elements in
- * this list precede elements in @a x that are equal.
+ * Assumes that both @a __x and this list are sorted according to
+ * operator<(). Merges elements of @a __x into this list in
+ * sorted order, leaving @a __x empty when complete. Elements in
+ * this list precede elements in @a __x that are equal.
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
void
/**
* @brief Merge sorted lists according to comparison function.
- * @param x Sorted list to merge.
- * @param StrictWeakOrdering Comparison function defining
+ * @param __x Sorted list to merge.
+ * @tparam _StrictWeakOrdering Comparison function defining
* sort order.
*
- * Assumes that both @a x and this list are sorted according to
- * StrictWeakOrdering. Merges elements of @a x into this list
- * in sorted order, leaving @a x empty when complete. Elements
- * in this list precede elements in @a x that are equivalent
+ * Assumes that both @a __x and this list are sorted according to
+ * StrictWeakOrdering. Merges elements of @a __x into this list
+ * in sorted order, leaving @a __x empty when complete. Elements
+ * in this list precede elements in @a __x that are equivalent
* according to StrictWeakOrdering().
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
template<typename _StrictWeakOrdering>
void
- merge(list&&, _StrictWeakOrdering);
+ merge(list&& __x, _StrictWeakOrdering __comp);
template<typename _StrictWeakOrdering>
void
#else
template<typename _StrictWeakOrdering>
void
- merge(list&, _StrictWeakOrdering);
+ merge(list& __x, _StrictWeakOrdering __comp);
#endif
/**
/**
* @brief List equality comparison.
- * @param x A %list.
- * @param y A %list of the same type as @a x.
+ * @param __x A %list.
+ * @param __y A %list of the same type as @a __x.
* @return True iff the size and elements of the lists are equal.
*
* This is an equivalence relation. It is linear in the size of
/**
* @brief List ordering relation.
- * @param x A %list.
- * @param y A %list of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %list.
+ * @param __y A %list of the same type as @a __x.
+ * @return True iff @a __x is lexicographically less than @a __y.
*
* This is a total ordering relation. It is linear in the size of the
* lists. The elements must be comparable with @c <.
/**
* @brief Creates a %map with no elements.
- * @param comp A comparison object.
- * @param a An allocator object.
+ * @param __comp A comparison object.
+ * @param __a An allocator object.
*/
explicit
map(const _Compare& __comp,
/**
* @brief %Map copy constructor.
- * @param x A %map of identical element and allocator types.
+ * @param __x A %map of identical element and allocator types.
*
* The newly-created %map uses a copy of the allocation object
- * used by @a x.
+ * used by @a __x.
*/
map(const map& __x)
: _M_t(__x._M_t) { }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Map move constructor.
- * @param x A %map of identical element and allocator types.
+ * @param __x A %map of identical element and allocator types.
*
- * The newly-created %map contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %map.
+ * The newly-created %map contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %map.
*/
map(map&& __x)
noexcept(is_nothrow_copy_constructible<_Compare>::value)
/**
* @brief Builds a %map from an initializer_list.
- * @param l An initializer_list.
- * @param comp A comparison object.
- * @param a An allocator object.
+ * @param __l An initializer_list.
+ * @param __comp A comparison object.
+ * @param __a An allocator object.
*
* Create a %map consisting of copies of the elements in the
- * initializer_list @a l.
+ * initializer_list @a __l.
* This is linear in N if the range is already sorted, and NlogN
- * otherwise (where N is @a l.size()).
+ * otherwise (where N is @a __l.size()).
*/
map(initializer_list<value_type> __l,
- const _Compare& __c = _Compare(),
+ const _Compare& __comp = _Compare(),
const allocator_type& __a = allocator_type())
- : _M_t(__c, __a)
+ : _M_t(__comp, __a)
{ _M_t._M_insert_unique(__l.begin(), __l.end()); }
#endif
/**
* @brief Builds a %map from a range.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
- * Create a %map consisting of copies of the elements from [first,last).
- * This is linear in N if the range is already sorted, and NlogN
- * otherwise (where N is distance(first,last)).
+ * Create a %map consisting of copies of the elements from
+ * [__first,__last). This is linear in N if the range is
+ * already sorted, and NlogN otherwise (where N is
+ * distance(__first,__last)).
*/
template<typename _InputIterator>
map(_InputIterator __first, _InputIterator __last)
/**
* @brief Builds a %map from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
- * Create a %map consisting of copies of the elements from [first,last).
- * This is linear in N if the range is already sorted, and NlogN
- * otherwise (where N is distance(first,last)).
+ * Create a %map consisting of copies of the elements from
+ * [__first,__last). This is linear in N if the range is
+ * already sorted, and NlogN otherwise (where N is
+ * distance(__first,__last)).
*/
template<typename _InputIterator>
map(_InputIterator __first, _InputIterator __last,
/**
* @brief %Map assignment operator.
- * @param x A %map of identical element and allocator types.
+ * @param __x A %map of identical element and allocator types.
*
- * All the elements of @a x are copied, but unlike the copy constructor,
- * the allocator object is not copied.
+ * All the elements of @a __x are copied, but unlike the copy
+ * constructor, the allocator object is not copied.
*/
map&
operator=(const map& __x)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Map move assignment operator.
- * @param x A %map of identical element and allocator types.
+ * @param __x A %map of identical element and allocator types.
*
- * The contents of @a x are moved into this map (without copying).
- * @a x is a valid, but unspecified %map.
+ * The contents of @a __x are moved into this map (without copying).
+ * @a __x is a valid, but unspecified %map.
*/
map&
operator=(map&& __x)
/**
* @brief %Map list assignment operator.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %map with copies of the elements in the
- * initializer list @a l.
+ * initializer list @a __l.
*
* Note that the assignment completely changes the %map and
* that the resulting %map's size is the same as the number
// [23.3.1.2] element access
/**
* @brief Subscript ( @c [] ) access to %map data.
- * @param k The key for which data should be retrieved.
+ * @param __k The key for which data should be retrieved.
* @return A reference to the data of the (key,data) %pair.
*
* Allows for easy lookup with the subscript ( @c [] )
// DR 464. Suggestion for new member functions in standard containers.
/**
* @brief Access to %map data.
- * @param k The key for which data should be retrieved.
- * @return A reference to the data whose key is equivalent to @a k, if
+ * @param __k The key for which data should be retrieved.
+ * @return A reference to the data whose key is equivalent to @a __k, if
* such a data is present in the %map.
* @throw std::out_of_range If no such data is present.
*/
/**
* @brief Attempts to insert a std::pair into the %map.
- * @param x Pair to be inserted (see std::make_pair for easy creation
- * of pairs).
-
+ * @param __x Pair to be inserted (see std::make_pair for easy
+ * creation of pairs).
+ *
* @return A pair, of which the first element is an iterator that
* points to the possibly inserted pair, and the second is
* a bool that is true if the pair was actually inserted.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Attempts to insert a list of std::pairs into the %map.
- * @param list A std::initializer_list<value_type> of pairs to be
- * inserted.
+ * @param __list A std::initializer_list<value_type> of pairs to be
+ * inserted.
*
* Complexity similar to that of the range constructor.
*/
/**
* @brief Attempts to insert a std::pair into the %map.
- * @param position An iterator that serves as a hint as to where the
+ * @param __position An iterator that serves as a hint as to where the
* pair should be inserted.
- * @param x Pair to be inserted (see std::make_pair for easy creation
- * of pairs).
- * @return An iterator that points to the element with key of @a x (may
- * or may not be the %pair passed in).
+ * @param __x Pair to be inserted (see std::make_pair for easy creation
+ * of pairs).
+ * @return An iterator that points to the element with key of
+ * @a __x (may or may not be the %pair passed in).
*
* This function is not concerned about whether the insertion
/**
* @brief Template function that attempts 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.
+ * @param __first Iterator pointing to the start of the range to be
+ * inserted.
+ * @param __last Iterator pointing to the end of the range.
*
* Complexity similar to that of the range constructor.
*/
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases an element from a %map.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
* @return An iterator pointing to the element immediately following
* @a position prior to the element being erased. If no such
* element exists, end() is returned.
#else
/**
* @brief Erases an element from a %map.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
*
* This function erases an element, pointed to by the given
* iterator, from a %map. Note that this function only erases
/**
* @brief Erases elements according to the provided key.
- * @param x Key of element to be erased.
+ * @param __x Key of element to be erased.
* @return The number of elements erased.
*
* This function erases all the elements located by the given key from
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases a [first,last) range of elements from a %map.
- * @param first Iterator pointing to the start of the range to be
- * erased.
- * @param last Iterator pointing to the end of the range to be erased.
- * @return The iterator @a last.
+ * @param __first Iterator pointing to the start of the range to be
+ * erased.
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
+ * @return The iterator @a __last.
*
* This function erases a sequence of elements from a %map.
* Note that this function only erases the element, and that if
{ return _M_t.erase(__first, __last); }
#else
/**
- * @brief Erases a [first,last) range of elements from a %map.
- * @param first Iterator pointing to the start of the range to be
- * erased.
- * @param last Iterator pointing to the end of the range to be erased.
+ * @brief Erases a [__first,__last) range of elements from a %map.
+ * @param __first Iterator pointing to the start of the range to be
+ * erased.
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
*
* This function erases a sequence of elements from a %map.
* Note that this function only erases the element, and that if
/**
* @brief Swaps data with another %map.
- * @param x A %map of the same element and allocator types.
+ * @param __x A %map of the same element and allocator types.
*
* This exchanges the elements between two maps in constant
* time. (It is only swapping a pointer, an integer, and an
// [23.3.1.3] map operations
/**
* @brief Tries to locate an element in a %map.
- * @param x Key of (key, value) %pair to be located.
+ * @param __x Key of (key, value) %pair to be located.
* @return Iterator pointing to sought-after element, or end() if not
* found.
*
/**
* @brief Tries to locate an element in a %map.
- * @param x Key of (key, value) %pair to be located.
+ * @param __x Key of (key, value) %pair to be located.
* @return Read-only (constant) iterator pointing to sought-after
* element, or end() if not found.
*
/**
* @brief Finds the number of elements with given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Number of elements with specified key.
*
* This function only makes sense for multimaps; for map the result will
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Iterator pointing to first element equal to or greater
* than key, or end().
*
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Read-only (constant) iterator pointing to first element
* equal to or greater than key, or end().
*
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Iterator pointing to the first element
* greater than key, or end().
*/
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Read-only (constant) iterator pointing to first iterator
* greater than key, or end().
*/
/**
* @brief Finds a subsequence matching given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Pair of iterators that possibly points to the subsequence
* matching given key.
*
/**
* @brief Finds a subsequence matching given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Pair of read-only (constant) iterators that possibly points
* to the subsequence matching given key.
*
/**
* @brief Map equality comparison.
- * @param x A %map.
- * @param y A %map of the same type as @a x.
+ * @param __x A %map.
+ * @param __y A %map of the same type as @a x.
* @return True iff the size and elements of the maps are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Map ordering relation.
- * @param x A %map.
- * @param y A %map of the same type as @a x.
+ * @param __x A %map.
+ * @param __y A %map of the same type as @a x.
* @return True iff @a x is lexicographically less than @a y.
*
* This is a total ordering relation. It is linear in the size of the
/**
* @brief Creates a %multimap with no elements.
- * @param comp A comparison object.
- * @param a An allocator object.
+ * @param __comp A comparison object.
+ * @param __a An allocator object.
*/
explicit
multimap(const _Compare& __comp,
/**
* @brief %Multimap copy constructor.
- * @param x A %multimap of identical element and allocator types.
+ * @param __x A %multimap of identical element and allocator types.
*
* The newly-created %multimap uses a copy of the allocation object
- * used by @a x.
+ * used by @a __x.
*/
multimap(const multimap& __x)
: _M_t(__x._M_t) { }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Multimap move constructor.
- * @param x A %multimap of identical element and allocator types.
+ * @param __x A %multimap of identical element and allocator types.
*
- * The newly-created %multimap contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %multimap.
+ * The newly-created %multimap contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %multimap.
*/
multimap(multimap&& __x)
noexcept(is_nothrow_copy_constructible<_Compare>::value)
/**
* @brief Builds a %multimap from an initializer_list.
- * @param l An initializer_list.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __l An initializer_list.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
* Create a %multimap consisting of copies of the elements from
* the initializer_list. This is linear in N if the list is already
/**
* @brief Builds a %multimap from a range.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* Create a %multimap consisting of copies of the elements from
- * [first,last). This is linear in N if the range is already sorted,
- * and NlogN otherwise (where N is distance(first,last)).
+ * [__first,__last). This is linear in N if the range is already sorted,
+ * and NlogN otherwise (where N is distance(__first,__last)).
*/
template<typename _InputIterator>
multimap(_InputIterator __first, _InputIterator __last)
/**
* @brief Builds a %multimap from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
* Create a %multimap consisting of copies of the elements from
- * [first,last). This is linear in N if the range is already sorted,
- * and NlogN otherwise (where N is distance(first,last)).
+ * [__first,__last). This is linear in N if the range is already sorted,
+ * and NlogN otherwise (where N is distance(__first,__last)).
*/
template<typename _InputIterator>
multimap(_InputIterator __first, _InputIterator __last,
/**
* @brief %Multimap assignment operator.
- * @param x A %multimap of identical element and allocator types.
+ * @param __x A %multimap of identical element and allocator types.
*
- * All the elements of @a x are copied, but unlike the copy constructor,
- * the allocator object is not copied.
+ * All the elements of @a __x are copied, but unlike the copy
+ * constructor, the allocator object is not copied.
*/
multimap&
operator=(const multimap& __x)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Multimap move assignment operator.
- * @param x A %multimap of identical element and allocator types.
+ * @param __x A %multimap of identical element and allocator types.
*
- * The contents of @a x are moved into this multimap (without copying).
- * @a x is a valid, but unspecified multimap.
+ * The contents of @a __x are moved into this multimap (without copying).
+ * @a __x is a valid, but unspecified multimap.
*/
multimap&
operator=(multimap&& __x)
/**
* @brief %Multimap list assignment operator.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %multimap with copies of the elements
- * in the initializer list @a l.
+ * in the initializer list @a __l.
*
* Note that the assignment completely changes the %multimap and
* that the resulting %multimap's size is the same as the number
// modifiers
/**
* @brief Inserts a std::pair into the %multimap.
- * @param x Pair to be inserted (see std::make_pair for easy creation
+ * @param __x Pair to be inserted (see std::make_pair for easy creation
* of pairs).
* @return An iterator that points to the inserted (key,value) pair.
*
/**
* @brief Inserts a std::pair into the %multimap.
- * @param position An iterator that serves as a hint as to where the
- * pair should be inserted.
- * @param x Pair to be inserted (see std::make_pair for easy creation
- * of pairs).
+ * @param __position An iterator that serves as a hint as to where the
+ * pair should be inserted.
+ * @param __x Pair to be inserted (see std::make_pair for easy creation
+ * of pairs).
* @return An iterator that points to the inserted (key,value) pair.
*
* This function inserts a (key, value) pair into the %multimap.
/**
* @brief A template function that attempts 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.
+ * @param __first Iterator pointing to the start of the range to be
+ * inserted.
+ * @param __last Iterator pointing to the end of the range.
*
* Complexity similar to that of the range constructor.
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Attempts to insert a list of std::pairs into the %multimap.
- * @param list A std::initializer_list<value_type> of pairs to be
- * inserted.
+ * @param __l A std::initializer_list<value_type> of pairs to be
+ * inserted.
*
* Complexity similar to that of the range constructor.
*/
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases an element from a %multimap.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
* @return An iterator pointing to the element immediately following
* @a position prior to the element being erased. If no such
* element exists, end() is returned.
#else
/**
* @brief Erases an element from a %multimap.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
*
* This function erases an element, pointed to by the given iterator,
* from a %multimap. Note that this function only erases the element,
/**
* @brief Erases elements according to the provided key.
- * @param x Key of element to be erased.
+ * @param __x Key of element to be erased.
* @return The number of elements erased.
*
* This function erases all elements located by the given key from a
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases a [first,last) range of elements from a %multimap.
- * @param first Iterator pointing to the start of the range to be
- * erased.
- * @param last Iterator pointing to the end of the range to be erased.
- * @return The iterator @a last.
+ * @param __first Iterator pointing to the start of the range to be
+ * erased.
+ * @param __last Iterator pointing to the end of the range to be
+ * erased .
+ * @return The iterator @a __last.
*
* This function erases a sequence of elements from a %multimap.
* Note that this function only erases the elements, and that if
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases a [first,last) range of elements from a %multimap.
- * @param first Iterator pointing to the start of the range to be
+ * @param __first Iterator pointing to the start of the range to be
* erased.
- * @param last Iterator pointing to the end of the range to be erased.
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
*
* This function erases a sequence of elements from a %multimap.
* Note that this function only erases the elements, and that if
/**
* @brief Swaps data with another %multimap.
- * @param x A %multimap of the same element and allocator types.
+ * @param __x A %multimap of the same element and allocator types.
*
* This exchanges the elements between two multimaps in constant time.
* (It is only swapping a pointer, an integer, and an instance of
// multimap operations
/**
* @brief Tries to locate an element in a %multimap.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Iterator pointing to sought-after element,
* or end() if not found.
*
/**
* @brief Tries to locate an element in a %multimap.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Read-only (constant) iterator pointing to sought-after
* element, or end() if not found.
*
/**
* @brief Finds the number of elements with given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Number of elements with specified key.
*/
size_type
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Iterator pointing to first element equal to or greater
* than key, or end().
*
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Read-only (constant) iterator pointing to first element
* equal to or greater than key, or end().
*
- * This function returns the first element of a subsequence of elements
- * that matches the given key. If unsuccessful the iterator will point
- * to the next greatest element or, if no such greater element exists, to
- * end().
+ * This function returns the first element of a subsequence of
+ * elements that matches the given key. If unsuccessful the
+ * iterator will point to the next greatest element or, if no
+ * such greater element exists, to end().
*/
const_iterator
lower_bound(const key_type& __x) const
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Iterator pointing to the first element
* greater than key, or end().
*/
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key of (key, value) pair to be located.
+ * @param __x Key of (key, value) pair to be located.
* @return Read-only (constant) iterator pointing to first iterator
* greater than key, or end().
*/
/**
* @brief Finds a subsequence matching given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Pair of iterators that possibly points to the subsequence
* matching given key.
*
/**
* @brief Finds a subsequence matching given key.
- * @param x Key of (key, value) pairs to be located.
+ * @param __x Key of (key, value) pairs to be located.
* @return Pair of read-only (constant) iterators that possibly points
* to the subsequence matching given key.
*
/**
* @brief Multimap equality comparison.
- * @param x A %multimap.
- * @param y A %multimap of the same type as @a x.
+ * @param __x A %multimap.
+ * @param __y A %multimap of the same type as @a __x.
* @return True iff the size and elements of the maps are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Multimap ordering relation.
- * @param x A %multimap.
- * @param y A %multimap of the same type as @a x.
+ * @param __x A %multimap.
+ * @param __y A %multimap of the same type as @a __x.
* @return True iff @a x is lexicographically less than @a y.
*
* This is a total ordering relation. It is linear in the size of the
/**
* @brief Creates a %multiset with no elements.
- * @param comp Comparator to use.
- * @param a An allocator object.
+ * @param __comp Comparator to use.
+ * @param __a An allocator object.
*/
explicit
multiset(const _Compare& __comp,
/**
* @brief Builds a %multiset from a range.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* Create a %multiset consisting of copies of the elements from
* [first,last). This is linear in N if the range is already sorted,
- * and NlogN otherwise (where N is distance(first,last)).
+ * and NlogN otherwise (where N is distance(__first,__last)).
*/
template<typename _InputIterator>
multiset(_InputIterator __first, _InputIterator __last)
/**
* @brief Builds a %multiset from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
* Create a %multiset consisting of copies of the elements from
- * [first,last). This is linear in N if the range is already sorted,
- * and NlogN otherwise (where N is distance(first,last)).
+ * [__first,__last). This is linear in N if the range is already sorted,
+ * and NlogN otherwise (where N is distance(__first,__last)).
*/
template<typename _InputIterator>
multiset(_InputIterator __first, _InputIterator __last,
/**
* @brief %Multiset copy constructor.
- * @param x A %multiset of identical element and allocator types.
+ * @param __x A %multiset of identical element and allocator types.
*
* The newly-created %multiset uses a copy of the allocation object used
- * by @a x.
+ * by @a __x.
*/
multiset(const multiset& __x)
: _M_t(__x._M_t) { }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Multiset move constructor.
- * @param x A %multiset of identical element and allocator types.
+ * @param __x A %multiset of identical element and allocator types.
*
- * The newly-created %multiset contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %multiset.
+ * The newly-created %multiset contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %multiset.
*/
multiset(multiset&& __x)
noexcept(is_nothrow_copy_constructible<_Compare>::value)
/**
* @brief Builds a %multiset from an initializer_list.
- * @param l An initializer_list.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __l An initializer_list.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
* Create a %multiset consisting of copies of the elements from
* the list. This is linear in N if the list is already sorted,
- * and NlogN otherwise (where N is @a l.size()).
+ * and NlogN otherwise (where N is @a __l.size()).
*/
multiset(initializer_list<value_type> __l,
const _Compare& __comp = _Compare(),
/**
* @brief %Multiset assignment operator.
- * @param x A %multiset of identical element and allocator types.
+ * @param __x A %multiset of identical element and allocator types.
*
- * All the elements of @a x are copied, but unlike the copy constructor,
- * the allocator object is not copied.
+ * All the elements of @a __x are copied, but unlike the copy
+ * constructor, the allocator object is not copied.
*/
multiset&
operator=(const multiset& __x)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Multiset move assignment operator.
- * @param x A %multiset of identical element and allocator types.
+ * @param __x A %multiset of identical element and allocator types.
*
- * The contents of @a x are moved into this %multiset (without copying).
- * @a x is a valid, but unspecified %multiset.
+ * The contents of @a __x are moved into this %multiset
+ * (without copying). @a __x is a valid, but unspecified
+ * %multiset.
*/
multiset&
operator=(multiset&& __x)
/**
* @brief %Multiset list assignment operator.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %multiset with copies of the elements in the
- * initializer list @a l.
+ * initializer list @a __l.
*
* Note that the assignment completely changes the %multiset and
* that the resulting %multiset's size is the same as the number
/**
* @brief Swaps data with another %multiset.
- * @param x A %multiset of the same element and allocator types.
+ * @param __x A %multiset of the same element and allocator types.
*
* This exchanges the elements between two multisets in constant time.
* (It is only swapping a pointer, an integer, and an instance of the @c
// insert/erase
/**
* @brief Inserts an element into the %multiset.
- * @param x Element to be inserted.
+ * @param __x Element to be inserted.
* @return An iterator that points to the inserted element.
*
* This function inserts an element into the %multiset. Contrary
/**
* @brief Inserts an element into the %multiset.
- * @param position An iterator that serves as a hint as to where the
+ * @param __position An iterator that serves as a hint as to where the
* element should be inserted.
- * @param x Element to be inserted.
+ * @param __x Element to be inserted.
* @return An iterator that points to the inserted element.
*
* This function inserts an element into the %multiset. Contrary
/**
* @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.
+ * @param __first Iterator pointing to the start of the range to be
+ * inserted.
+ * @param __last Iterator pointing to the end of the range.
*
* Complexity similar to that of the range constructor.
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Attempts to insert a list of elements into the %multiset.
- * @param list A std::initializer_list<value_type> of elements
- * to be inserted.
+ * @param __l A std::initializer_list<value_type> of elements
+ * to be inserted.
*
* Complexity similar to that of the range constructor.
*/
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases an element from a %multiset.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
* @return An iterator pointing to the element immediately following
* @a position prior to the element being erased. If no such
* element exists, end() is returned.
#else
/**
* @brief Erases an element from a %multiset.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
*
* This function erases an element, pointed to by the given iterator,
* from a %multiset. Note that this function only erases the element,
/**
* @brief Erases elements according to the provided key.
- * @param x Key of element to be erased.
+ * @param __x Key of element to be erased.
* @return The number of elements erased.
*
* This function erases all elements located by the given key from a
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases a [first,last) range of elements from a %multiset.
- * @param first Iterator pointing to the start of the range to be
- * erased.
- * @param last Iterator pointing to the end of the range to be erased.
+ * @param __first Iterator pointing to the start of the range to be
+ * erased.
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
* @return The iterator @a last.
*
* This function erases a sequence of elements from a %multiset.
/**
* @brief Finds the number of elements with given key.
- * @param x Key of elements to be located.
+ * @param __x Key of elements to be located.
* @return Number of elements with specified key.
*/
size_type
//@{
/**
* @brief Tries to locate an element in a %set.
- * @param x Element to be located.
+ * @param __x Element to be located.
* @return Iterator pointing to sought-after element, or end() if not
* found.
*
//@{
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Iterator pointing to first element equal to or greater
* than key, or end().
*
//@{
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Iterator pointing to the first element
* greater than key, or end().
*/
//@{
/**
* @brief Finds a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Pair of iterators that possibly points to the subsequence
* matching given key.
*
std::pair<const_iterator, const_iterator>
equal_range(const key_type& __x) const
{ return _M_t.equal_range(__x); }
+ //@}
template<typename _K1, typename _C1, typename _A1>
friend bool
/**
* @brief Multiset equality comparison.
- * @param x A %multiset.
- * @param y A %multiset of the same type as @a x.
+ * @param __x A %multiset.
+ * @param __y A %multiset of the same type as @a __x.
* @return True iff the size and elements of the multisets are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Multiset ordering relation.
- * @param x A %multiset.
- * @param y A %multiset of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %multiset.
+ * @param __y A %multiset of the same type as @a __x.
+ * @return True iff @a __x is lexicographically less than @a __y.
*
* This is a total ordering relation. It is linear in the size of the
* maps. The elements must be comparable with @c <.
* For each element in the range @p [first,last) assigns @p value and
* increments @p value as if by @p ++value.
*
- * @param first Start of range.
- * @param last End of range.
- * @param value Starting value.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __value Starting value.
* @return Nothing.
*/
template<typename _ForwardIterator, typename _Tp>
* Accumulates the values in the range [first,last) using operator+(). The
* initial value is @a init. The values are processed in order.
*
- * @param first Start of range.
- * @param last End of range.
- * @param init Starting value to add other values to.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __init Starting value to add other values to.
* @return The final sum.
*/
template<typename _InputIterator, typename _Tp>
* object @a binary_op. The initial value is @a init. The values are
* processed in order.
*
- * @param first Start of range.
- * @param last End of range.
- * @param init Starting value to add other values to.
- * @param binary_op Function object to accumulate with.
+ * @param __first Start of range.
+ * @param __last End of range.
+ * @param __init Starting value to add other values to.
+ * @param __binary_op Function object to accumulate with.
* @return The final sum.
*/
template<typename _InputIterator, typename _Tp, typename _BinaryOperation>
* value using operator+(). The values in the ranges are processed in
* order.
*
- * @param first1 Start of range 1.
- * @param last1 End of range 1.
- * @param first2 Start of range 2.
- * @param init Starting value to add other values to.
+ * @param __first1 Start of range 1.
+ * @param __last1 End of range 1.
+ * @param __first2 Start of range 2.
+ * @param __init Starting value to add other values to.
* @return The final inner product.
*/
template<typename _InputIterator1, typename _InputIterator2, typename _Tp>
* the accumulated value using @a binary_op1. The values in the ranges are
* processed in order.
*
- * @param first1 Start of range 1.
- * @param last1 End of range 1.
- * @param first2 Start of range 2.
- * @param init Starting value to add other values to.
- * @param binary_op1 Function object to accumulate with.
- * @param binary_op2 Function object to apply to pairs of input values.
+ * @param __first1 Start of range 1.
+ * @param __last1 End of range 1.
+ * @param __first2 Start of range 2.
+ * @param __init Starting value to add other values to.
+ * @param __binary_op1 Function object to accumulate with.
+ * @param __binary_op2 Function object to apply to pairs of input values.
* @return The final inner product.
*/
template<typename _InputIterator1, typename _InputIterator2, typename _Tp,
* first value of the input, the second value in result is the sum of the
* first and second input values, and so on.
*
- * @param first Start of input range.
- * @param last End of input range.
- * @param result Output to write sums to.
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output to write sums to.
* @return Iterator pointing just beyond the values written to result.
*/
template<typename _InputIterator, typename _OutputIterator>
* first value of the input, the second value in result is the sum of the
* first and second input values, and so on.
*
- * @param first Start of input range.
- * @param last End of input range.
- * @param result Output to write sums to.
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output to write sums to.
* @return Iterator pointing just beyond the values written to result.
*/
template<typename _InputIterator, typename _OutputIterator,
* Computes the difference between adjacent values in the range
* [first,last) using operator-() and writes the result to @a result.
*
- * @param first Start of input range.
- * @param last End of input range.
- * @param result Output to write sums to.
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output to write sums to.
* @return Iterator pointing just beyond the values written to result.
*
* _GLIBCXX_RESOLVE_LIB_DEFECTS
* @brief Return differences between adjacent values.
*
* Computes the difference between adjacent values in the range
- * [first,last) using the function object @a binary_op and writes the
- * result to @a result.
+ * [__first,__last) using the function object @a __binary_op and writes the
+ * result to @a __result.
*
- * @param first Start of input range.
- * @param last End of input range.
- * @param result Output to write sums to.
+ * @param __first Start of input range.
+ * @param __last End of input range.
+ * @param __result Output to write sums to.
* @return Iterator pointing just beyond the values written to result.
*
* _GLIBCXX_RESOLVE_LIB_DEFECTS
/**
* @brief A convenience wrapper for creating a pair from two objects.
- * @param x The first object.
- * @param y The second object.
+ * @param __x The first object.
+ * @param __y The second object.
* @return A newly-constructed pair<> object of the appropriate type.
*
* The standard requires that the objects be passed by reference-to-const,
/**
* @brief Add data to the end of the %queue.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical %queue operation. The function creates an
* element at the end of the %queue and assigns the given data
/**
* @brief Queue equality comparison.
- * @param x A %queue.
- * @param y A %queue of the same type as @a x.
+ * @param __x A %queue.
+ * @param __y A %queue of the same type as @a __x.
* @return True iff the size and elements of the queues are equal.
*
* This is an equivalence relation. Complexity and semantics depend on the
/**
* @brief Queue ordering relation.
- * @param x A %queue.
- * @param y A %queue of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %queue.
+ * @param __y A %queue of the same type as @a x.
+ * @return True iff @a __x is lexicographically less than @a __y.
*
* This is an total ordering relation. Complexity and semantics
* depend on the underlying sequence type, but the expected rules
/**
* @brief Builds a %queue from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param x A comparison functor describing a strict weak ordering.
- * @param s An initial sequence with which to start.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __x A comparison functor describing a strict weak ordering.
+ * @param __s An initial sequence with which to start.
*
- * Begins by copying @a s, inserting a copy of the elements
- * from @a [first,last) into the copy of @a s, then ordering
- * the copy according to @a x.
+ * Begins by copying @a __s, inserting a copy of the elements
+ * from @a [first,last) into the copy of @a __s, then ordering
+ * the copy according to @a __x.
*
* For more information on function objects, see the
* documentation on @link functors functor base
/**
* @brief Add data to the %queue.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical %queue operation.
* The time complexity of the operation depends on the underlying
/**
* @brief Defines @c != for arbitrary types, in terms of @c ==.
- * @param x A thing.
- * @param y Another thing.
- * @return x != y
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x != __y
*
* This function uses @c == to determine its result.
*/
/**
* @brief Defines @c > for arbitrary types, in terms of @c <.
- * @param x A thing.
- * @param y Another thing.
- * @return x > y
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x > __y
*
* This function uses @c < to determine its result.
*/
/**
* @brief Defines @c <= for arbitrary types, in terms of @c <.
- * @param x A thing.
- * @param y Another thing.
- * @return x <= y
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x <= __y
*
* This function uses @c < to determine its result.
*/
/**
* @brief Defines @c >= for arbitrary types, in terms of @c <.
- * @param x A thing.
- * @param y Another thing.
- * @return x >= y
+ * @param __x A thing.
+ * @param __y Another thing.
+ * @return __x >= __y
*
* This function uses @c < to determine its result.
*/
*
* Sets support bidirectional iterators.
*
- * @param Key Type of key objects.
- * @param Compare Comparison function object type, defaults to less<Key>.
- * @param Alloc Allocator type, defaults to allocator<Key>.
+ * @tparam _Key Type of key objects.
+ * @tparam _Compare Comparison function object type, defaults to less<Key>.
+ * @tparam _Alloc Allocator type, defaults to allocator<Key>.
*
* The private tree data is declared exactly the same way for set and
* multiset; the distinction is made entirely in how the tree functions are
/**
* @brief Creates a %set with no elements.
- * @param comp Comparator to use.
- * @param a An allocator object.
+ * @param __comp Comparator to use.
+ * @param __a An allocator object.
*/
explicit
set(const _Compare& __comp,
/**
* @brief Builds a %set from a range.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
- * Create a %set consisting of copies of the elements from [first,last).
- * This is linear in N if the range is already sorted, and NlogN
- * otherwise (where N is distance(first,last)).
+ * Create a %set consisting of copies of the elements from
+ * [__first,__last). This is linear in N if the range is
+ * already sorted, and NlogN otherwise (where N is
+ * distance(__first,__last)).
*/
template<typename _InputIterator>
set(_InputIterator __first, _InputIterator __last)
/**
* @brief Builds a %set from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
- * Create a %set consisting of copies of the elements from [first,last).
- * This is linear in N if the range is already sorted, and NlogN
- * otherwise (where N is distance(first,last)).
+ * Create a %set consisting of copies of the elements from
+ * [__first,__last). This is linear in N if the range is
+ * already sorted, and NlogN otherwise (where N is
+ * distance(__first,__last)).
*/
template<typename _InputIterator>
set(_InputIterator __first, _InputIterator __last,
/**
* @brief %Set copy constructor.
- * @param x A %set of identical element and allocator types.
+ * @param __x A %set of identical element and allocator types.
*
* The newly-created %set uses a copy of the allocation object used
- * by @a x.
+ * by @a __x.
*/
set(const set& __x)
: _M_t(__x._M_t) { }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Set move constructor
- * @param x A %set of identical element and allocator types.
+ * @param __x A %set of identical element and allocator types.
*
* The newly-created %set contains the exact contents of @a x.
* The contents of @a x are a valid, but unspecified %set.
/**
* @brief Builds a %set from an initializer_list.
- * @param l An initializer_list.
- * @param comp A comparison functor.
- * @param a An allocator object.
+ * @param __l An initializer_list.
+ * @param __comp A comparison functor.
+ * @param __a An allocator object.
*
* Create a %set consisting of copies of the elements in the list.
* This is linear in N if the list is already sorted, and NlogN
- * otherwise (where N is @a l.size()).
+ * otherwise (where N is @a __l.size()).
*/
set(initializer_list<value_type> __l,
const _Compare& __comp = _Compare(),
/**
* @brief %Set assignment operator.
- * @param x A %set of identical element and allocator types.
+ * @param __x A %set of identical element and allocator types.
*
- * All the elements of @a x are copied, but unlike the copy constructor,
- * the allocator object is not copied.
+ * All the elements of @a __x are copied, but unlike the copy
+ * constructor, the allocator object is not copied.
*/
set&
operator=(const set& __x)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Set move assignment operator.
- * @param x A %set of identical element and allocator types.
+ * @param __x A %set of identical element and allocator types.
*
- * The contents of @a x are moved into this %set (without copying).
- * @a x is a valid, but unspecified %set.
+ * The contents of @a __x are moved into this %set (without copying).
+ * @a __x is a valid, but unspecified %set.
*/
set&
operator=(set&& __x)
/**
* @brief %Set list assignment operator.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %set with copies of the elements in the
- * initializer list @a l.
+ * initializer list @a __l.
*
* Note that the assignment completely changes the %set and
* that the resulting %set's size is the same as the number
/**
* @brief Swaps data with another %set.
- * @param x A %set of the same element and allocator types.
+ * @param __x A %set of the same element and allocator types.
*
- * This exchanges the elements between two sets in constant time.
- * (It is only swapping a pointer, an integer, and an instance of
- * the @c Compare type (which itself is often stateless and empty), so it
- * should be quite fast.)
- * Note that the global std::swap() function is specialized such that
- * std::swap(s1,s2) will feed to this function.
+ * This exchanges the elements between two sets in constant
+ * time. (It is only swapping a pointer, an integer, and an
+ * instance of the @c Compare type (which itself is often
+ * stateless and empty), so it should be quite fast.) Note
+ * that the global std::swap() function is specialized such
+ * that std::swap(s1,s2) will feed to this function.
*/
void
swap(set& __x)
// insert/erase
/**
* @brief Attempts to insert an element into the %set.
- * @param x Element to be inserted.
+ * @param __x Element to be inserted.
* @return A pair, of which the first element is an iterator that points
* to the possibly inserted element, and the second is a bool
* that is true if the element was actually inserted.
/**
* @brief Attempts to insert an element into the %set.
- * @param position An iterator that serves as a hint as to where the
+ * @param __position An iterator that serves as a hint as to where the
* element should be inserted.
- * @param x Element to be inserted.
- * @return An iterator that points to the element with key of @a x (may
- * or may not be the element passed in).
+ * @param __x Element to be inserted.
+ * @return An iterator that points to the element with key of
+ * @a __x (may or may not be the element passed in).
*
* This function is not concerned about whether the insertion took place,
* and thus does not return a boolean like the single-argument insert()
/**
* @brief A template function that attempts 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.
+ * @param __first Iterator pointing to the start of the range to be
+ * inserted.
+ * @param __last Iterator pointing to the end of the range.
*
* Complexity similar to that of the range constructor.
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Attempts to insert a list of elements into the %set.
- * @param list A std::initializer_list<value_type> of elements
- * to be inserted.
+ * @param __l A std::initializer_list<value_type> of elements
+ * to be inserted.
*
* Complexity similar to that of the range constructor.
*/
// DR 130. Associative erase should return an iterator.
/**
* @brief Erases an element from a %set.
- * @param position An iterator pointing to the element to be erased.
+ * @param __position An iterator pointing to the element to be erased.
* @return An iterator pointing to the element immediately following
- * @a position prior to the element being erased. If no such
+ * @a __position prior to the element being erased. If no such
* element exists, end() is returned.
*
* This function erases an element, pointed to by the given iterator,
/**
* @brief Erases elements according to the provided key.
- * @param x Key of element to be erased.
+ * @param __x Key of element to be erased.
* @return The number of elements erased.
*
* This function erases all the elements located by the given key from
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// DR 130. Associative erase should return an iterator.
/**
- * @brief Erases a [first,last) range of elements from a %set.
- * @param first Iterator pointing to the start of the range to be
+ * @brief Erases a [__first,__last) range of elements from a %set.
+ * @param __first Iterator pointing to the start of the range to be
* erased.
- * @param last Iterator pointing to the end of the range to be erased.
- * @return The iterator @a last.
+
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
+ * @return The iterator @a __last.
*
* This function erases a sequence of elements from a %set.
* Note that this function only erases the element, and that if
#else
/**
* @brief Erases a [first,last) range of elements from a %set.
- * @param first Iterator pointing to the start of the range to be
+ * @param __first Iterator pointing to the start of the range to be
* erased.
- * @param last Iterator pointing to the end of the range to be erased.
+ * @param __last Iterator pointing to the end of the range to
+ * be erased.
*
* This function erases a sequence of elements from a %set.
* Note that this function only erases the element, and that if
/**
* @brief Finds the number of elements.
- * @param x Element to located.
+ * @param __x Element to located.
* @return Number of elements with specified key.
*
* This function only makes sense for multisets; for set the result will
//@{
/**
* @brief Tries to locate an element in a %set.
- * @param x Element to be located.
+ * @param __x Element to be located.
* @return Iterator pointing to sought-after element, or end() if not
* found.
*
//@{
/**
* @brief Finds the beginning of a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Iterator pointing to first element equal to or greater
* than key, or end().
*
//@{
/**
* @brief Finds the end of a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Iterator pointing to the first element
* greater than key, or end().
*/
//@{
/**
* @brief Finds a subsequence matching given key.
- * @param x Key to be located.
+ * @param __x Key to be located.
* @return Pair of iterators that possibly points to the subsequence
* matching given key.
*
/**
* @brief Set equality comparison.
- * @param x A %set.
- * @param y A %set of the same type as @a x.
+ * @param __x A %set.
+ * @param __y A %set of the same type as @a x.
* @return True iff the size and elements of the sets are equal.
*
* This is an equivalence relation. It is linear in the size of the sets.
/**
* @brief Set ordering relation.
- * @param x A %set.
- * @param y A %set of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %set.
+ * @param __y A %set of the same type as @a x.
+ * @return True iff @a __x is lexicographically less than @a __y.
*
* This is a total ordering relation. It is linear in the size of the
* maps. The elements must be comparable with @c <.
/**
* @brief Add data to the top of the %stack.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical %stack operation. The function creates an
* element at the top of the %stack and assigns the given data
/**
* @brief Stack equality comparison.
- * @param x A %stack.
- * @param y A %stack of the same type as @a x.
+ * @param __x A %stack.
+ * @param __y A %stack of the same type as @a __x.
* @return True iff the size and elements of the stacks are equal.
*
* This is an equivalence relation. Complexity and semantics
/**
* @brief Stack ordering relation.
- * @param x A %stack.
- * @param y A %stack of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %stack.
+ * @param __y A %stack of the same type as @a x.
+ * @return True iff @a x is lexicographically less than @a __y.
*
* This is an total ordering relation. Complexity and semantics
* depend on the underlying sequence type, but the expected rules
/**
* @brief Allocates a temporary buffer.
- * @param len The number of objects of type Tp.
+ * @param __len The number of objects of type Tp.
* @return See full description.
*
* Reinventing the wheel, but this time with prettier spokes!
*
- * This function tries to obtain storage for @c len adjacent Tp
+ * 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 <em>the buffer s address and
- * capacity (in the units of sizeof(Tp)), or a pair of 0 values if
+ * capacity (in the units of sizeof(_Tp)), or a pair of 0 values if
* 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.
/**
* @brief The companion to get_temporary_buffer().
- * @param p A buffer previously allocated by get_temporary_buffer.
+ * @param __p A buffer previously allocated by get_temporary_buffer.
* @return None.
*
- * Frees the memory pointed to by p.
+ * Frees the memory pointed to by __p.
*/
template<typename _Tp>
inline void
/**
* @brief Copies the range [first,last) into result.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @return result + (first - last)
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __result An output iterator.
+ * @return __result + (__first - __last)
*
* Like copy(), but does not require an initialized output range.
*/
/**
* @brief Copies the value x into the range [first,last).
- * @param first An input iterator.
- * @param last An input iterator.
- * @param x The source value.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __x The source value.
* @return Nothing.
*
* Like fill(), but does not require an initialized output range.
/**
* @brief Copies the value x into the range [first,first+n).
- * @param first An input iterator.
- * @param n The number of copies to make.
- * @param x The source value.
+ * @param __first An input iterator.
+ * @param __n The number of copies to make.
+ * @param __x The source value.
* @return Nothing.
*
* Like fill_n(), but does not require an initialized output range.
/**
* @brief Copies the range [first,first+n) into result.
- * @param first An input iterator.
- * @param n The number of elements to copy.
- * @param result An output iterator.
- * @return result + n
+ * @param __first An input iterator.
+ * @param __n The number of elements to copy.
+ * @param __result An output iterator.
+ * @return __result + __n
*
* Like copy_n(), but does not require an initialized output range.
*/
/**
* @brief Creates a %vector with no elements.
- * @param a An allocator object.
+ * @param __a An allocator object.
*/
explicit
vector(const allocator_type& __a)
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Creates a %vector with default constructed elements.
- * @param n The number of elements to initially create.
+ * @param __n The number of elements to initially create.
*
- * This constructor fills the %vector with @a n default
+ * This constructor fills the %vector with @a __n default
* constructed elements.
*/
explicit
/**
* @brief Creates a %vector with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator.
*
- * This constructor fills the %vector with @a n copies of @a value.
+ * This constructor fills the %vector with @a __n copies of @a __value.
*/
vector(size_type __n, const value_type& __value,
const allocator_type& __a = allocator_type())
#else
/**
* @brief Creates a %vector with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param a An allocator.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __a An allocator.
*
- * This constructor fills the %vector with @a n copies of @a value.
+ * This constructor fills the %vector with @a __n copies of @a __value.
*/
explicit
vector(size_type __n, const value_type& __value = value_type(),
/**
* @brief %Vector copy constructor.
- * @param x A %vector of identical element and allocator types.
+ * @param __x A %vector of identical element and allocator types.
*
* The newly-created %vector uses a copy of the allocation
- * object used by @a x. All the elements of @a x are copied,
+ * object used by @a __x. All the elements of @a __x are copied,
* but any extra memory in
- * @a x (for fast expansion) will not be copied.
+ * @a __x (for fast expansion) will not be copied.
*/
vector(const vector& __x)
: _Base(__x.size(),
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Vector move constructor.
- * @param x A %vector of identical element and allocator types.
+ * @param __x A %vector of identical element and allocator types.
*
- * The newly-created %vector contains the exact contents of @a x.
- * The contents of @a x are a valid, but unspecified %vector.
+ * The newly-created %vector contains the exact contents of @a __x.
+ * The contents of @a __x are a valid, but unspecified %vector.
*/
vector(vector&& __x) noexcept
: _Base(std::move(__x)) { }
/**
* @brief Builds a %vector from an initializer list.
- * @param l An initializer_list.
- * @param a An allocator.
+ * @param __l An initializer_list.
+ * @param __a An allocator.
*
* Create a %vector consisting of copies of the elements in the
- * initializer_list @a l.
+ * initializer_list @a __l.
*
* This will call the element type's copy constructor N times
- * (where N is @a l.size()) and do no memory reallocation.
+ * (where N is @a __l.size()) and do no memory reallocation.
*/
vector(initializer_list<value_type> __l,
const allocator_type& __a = allocator_type())
/**
* @brief Builds a %vector from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param a An allocator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __a An allocator.
*
* Create a %vector consisting of copies of the elements from
* [first,last).
/**
* @brief %Vector assignment operator.
- * @param x A %vector of identical element and allocator types.
+ * @param __x A %vector of identical element and allocator types.
*
- * All the elements of @a x are copied, but any extra memory in
- * @a x (for fast expansion) will not be copied. Unlike the
+ * All the elements of @a __x are copied, but any extra memory in
+ * @a __x (for fast expansion) will not be copied. Unlike the
* copy constructor, the allocator object is not copied.
*/
vector&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief %Vector move assignment operator.
- * @param x A %vector of identical element and allocator types.
+ * @param __x A %vector of identical element and allocator types.
*
- * The contents of @a x are moved into this %vector (without copying).
- * @a x is a valid, but unspecified %vector.
+ * The contents of @a __x are moved into this %vector (without copying).
+ * @a __x is a valid, but unspecified %vector.
*/
vector&
operator=(vector&& __x) noexcept(_Alloc_traits::_S_nothrow_move())
/**
* @brief %Vector list assignment operator.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %vector with copies of the elements in the
- * initializer list @a l.
+ * initializer list @a __l.
*
* Note that the assignment completely changes the %vector and
* that the resulting %vector's size is the same as the number
/**
* @brief Assigns a given value to a %vector.
- * @param n Number of elements to be assigned.
- * @param val Value to be assigned.
+ * @param __n Number of elements to be assigned.
+ * @param __val Value to be assigned.
*
- * This function fills a %vector with @a n copies of the given
+ * This function fills a %vector with @a __n copies of the given
* value. Note that the assignment completely changes the
* %vector and that the resulting %vector's size is the same as
* the number of elements assigned. Old data may be lost.
/**
* @brief Assigns a range to a %vector.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function fills a %vector with copies of the elements in the
- * range [first,last).
+ * range [__first,__last).
*
* Note that the assignment completely changes the %vector and
* that the resulting %vector's size is the same as the number
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Assigns an initializer list to a %vector.
- * @param l An initializer_list.
+ * @param __l An initializer_list.
*
* This function fills a %vector with copies of the elements in the
- * initializer list @a l.
+ * initializer list @a __l.
*
* Note that the assignment completely changes the %vector and
* that the resulting %vector's size is the same as the number
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Resizes the %vector to the specified number of elements.
- * @param new_size Number of elements the %vector should contain.
+ * @param __new_size Number of elements the %vector should contain.
*
* This function will %resize the %vector to the specified
* number of elements. If the number is smaller than the
/**
* @brief Resizes the %vector to the specified number of elements.
- * @param new_size Number of elements the %vector should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %vector should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %vector to the specified
* number of elements. If the number is smaller than the
#else
/**
* @brief Resizes the %vector to the specified number of elements.
- * @param new_size Number of elements the %vector should contain.
- * @param x Data with which new elements should be populated.
+ * @param __new_size Number of elements the %vector should contain.
+ * @param __x Data with which new elements should be populated.
*
* This function will %resize the %vector to the specified
* number of elements. If the number is smaller than the
/**
* @brief Attempt to preallocate enough memory for specified number of
* elements.
- * @param n Number of elements required.
+ * @param __n Number of elements required.
* @throw std::length_error If @a n exceeds @c max_size().
*
* This function attempts to reserve enough memory for the
// element access
/**
* @brief Subscript access to the data contained in the %vector.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read/write reference to data.
*
/**
* @brief Subscript access to the data contained in the %vector.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read-only (constant) reference to data.
*
public:
/**
* @brief Provides access to the data contained in the %vector.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read/write reference to data.
- * @throw std::out_of_range If @a n is an invalid index.
+ * @throw std::out_of_range If @a __n is an invalid index.
*
* This function provides for safer data access. The parameter
* is first checked that it is in the range of the vector. The
/**
* @brief Provides access to the data contained in the %vector.
- * @param n The index of the element for which data should be
+ * @param __n The index of the element for which data should be
* accessed.
* @return Read-only (constant) reference to data.
- * @throw std::out_of_range If @a n is an invalid index.
+ * @throw std::out_of_range If @a __n is an invalid index.
*
* This function provides for safer data access. The parameter
* is first checked that it is in the range of the vector. The
// [23.2.4.3] modifiers
/**
* @brief Add data to the end of the %vector.
- * @param x Data to be added.
+ * @param __x Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the end of the %vector and assigns the given data
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Inserts an object in %vector before specified iterator.
- * @param position An iterator into the %vector.
- * @param args Arguments.
+ * @param __position An iterator into the %vector.
+ * @param __args Arguments.
* @return An iterator that points to the inserted data.
*
* This function will insert an object of type T constructed
/**
* @brief Inserts given value into %vector before specified iterator.
- * @param position An iterator into the %vector.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %vector.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given value before
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Inserts given rvalue into %vector before specified iterator.
- * @param position An iterator into the %vector.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %vector.
+ * @param __x Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given rvalue before
/**
* @brief Inserts an initializer_list into the %vector.
- * @param position An iterator into the %vector.
- * @param l An initializer_list.
+ * @param __position An iterator into the %vector.
+ * @param __l An initializer_list.
*
* This function will insert copies of the data in the
* initializer_list @a l into the %vector before the location
/**
* @brief Inserts a number of copies of given data into the %vector.
- * @param position An iterator into the %vector.
- * @param n Number of elements to be inserted.
- * @param x Data to be inserted.
+ * @param __position An iterator into the %vector.
+ * @param __n Number of elements to be inserted.
+ * @param __x Data to be inserted.
*
* This function will insert a specified number of copies of
* the given data before the location specified by @a position.
/**
* @brief Inserts a range into the %vector.
- * @param position An iterator into the %vector.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __position An iterator into the %vector.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function will insert copies of the data in the range
- * [first,last) into the %vector before the location specified
+ * [__first,__last) into the %vector before the location specified
* by @a pos.
*
* Note that this kind of operation could be expensive for a
/**
* @brief Remove element at given position.
- * @param position Iterator pointing to element to be erased.
+ * @param __position Iterator pointing to element to be erased.
* @return An iterator pointing to the next element (or end()).
*
* This function will erase the element at the given position and thus
/**
* @brief Remove a range of elements.
- * @param first Iterator pointing to the first element to be erased.
- * @param last Iterator pointing to one past the last element to be
- * erased.
- * @return An iterator pointing to the element pointed to by @a last
+ * @param __first Iterator pointing to the first element to be erased.
+ * @param __last Iterator pointing to one past the last element to be
+ * erased.
+ * @return An iterator pointing to the element pointed to by @a __last
* prior to erasing (or end()).
*
- * This function will erase the elements in the range [first,last) and
- * shorten the %vector accordingly.
+ * This function will erase the elements in the range
+ * [__first,__last) and shorten the %vector accordingly.
*
* Note This operation could be expensive and if it is
* frequently used the user should consider using std::list.
/**
* @brief Swaps data with another %vector.
- * @param x A %vector of the same element and allocator types.
+ * @param __x A %vector of the same element and allocator types.
*
* This exchanges the elements between two vectors in constant time.
* (Three pointers, so it should be quite fast.)
/**
* @brief Vector equality comparison.
- * @param x A %vector.
- * @param y A %vector of the same type as @a x.
+ * @param __x A %vector.
+ * @param __y A %vector of the same type as @a __x.
* @return True iff the size and elements of the vectors are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Vector ordering relation.
- * @param x A %vector.
- * @param y A %vector of the same type as @a x.
- * @return True iff @a x is lexicographically less than @a y.
+ * @param __x A %vector.
+ * @param __y A %vector of the same type as @a __x.
+ * @return True iff @a __x is lexicographically less than @a __y.
*
* This is a total ordering relation. It is linear in the size of the
* vectors. The elements must be comparable with @c <.
* the only type written by this iterator and there must be an
* operator<<(Tp) defined.
*
- * @param Tp The type to write to the ostream.
- * @param CharT The ostream char_type.
- * @param Traits The ostream char_traits.
+ * @tparam _Tp The type to write to the ostream.
+ * @tparam _CharT The ostream char_type.
+ * @tparam _Traits The ostream char_traits.
*/
template<typename _Tp, typename _CharT = char,
typename _Traits = char_traits<_CharT> >
* written to the stream. The delimiter is not copied, and thus must
* not be destroyed while this iterator is in use.
*
- * @param s Underlying ostream to write to.
- * @param c CharT delimiter string to insert.
+ * @param __s Underlying ostream to write to.
+ * @param __c CharT delimiter string to insert.
*/
ostream_iterator(ostream_type& __s, const _CharT* __c)
: _M_stream(&__s), _M_string(__c) { }
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
-/** @file debug/safe_locale_iterator.tcc
+/** @file debug/safe_local_iterator.tcc
* This file is a GNU debug extension to the Standard C++ Library.
*/
* may only be used by deriving from it and passing the name of the
* derived class as its template parameter via the curiously
* recurring template pattern. The derived class must have @c
- * iterator and @const_iterator types that are instantiations of
+ * iterator and @c const_iterator types that are instantiations of
* class template _Safe_iterator for this sequence. Iterators will
* then be tracked automatically.
*/
{
public:
/** Invalidates all iterators @c x that reference this sequence,
- are not singular, and for which @c pred(x) returns @c
- true. @c pred will be invoked with the normal iterators nested
+ are not singular, and for which @c __pred(x) returns @c
+ true. @c __pred will be invoked with the normal iterators nested
in the safe ones. */
template<typename _Predicate>
void
_M_invalidate_if(_Predicate __pred);
/** Transfers all iterators @c x that reference @c from sequence,
- are not singular, and for which @c pred(x) returns @c
- true. @c pred will be invoked with the normal iterators nested
+ are not singular, and for which @c __pred(x) returns @c
+ true. @c __pred will be invoked with the normal iterators nested
in the safe ones. */
template<typename _Predicate>
void
{ }
/** Initialize the iterator to reference the container pointed to
- * by @p__seq. @p __constant is true when we are initializing a
+ * by @p __seq. @p __constant is true when we are initializing a
* constant local iterator, and false if it is a mutable local iterator.
* Note that @p __seq may be NULL, in which case the iterator will be
* singular. Otherwise, the iterator will reference @p __seq and
* template may only be used by deriving from it and passing the name
* of the derived class as its template parameter via the curiously
* recurring template pattern. The derived class must have @c
- * iterator and @const_iterator types that are instantiations of
+ * iterator and @c const_iterator types that are instantiations of
* class template _Safe_iterator for this container and @c local_iterator
- * and @const_local_iterator types that are instantiations of class
+ * and @c const_local_iterator types that are instantiations of class
* template _Safe_local_iterator for this container. Iterators will
* then be tracked automatically.
*/
{
public:
/** Invalidates all iterators @c x that reference this container,
- are not singular, and for which @c pred(x) returns @c
- true. @c pred will be invoked with the normal iterators nested
+ are not singular, and for which @c __pred(x) returns @c
+ true. @c __pred will be invoked with the normal iterators nested
in the safe ones. */
template<typename _Predicate>
void
_M_invalidate_if(_Predicate __pred);
/** Invalidates all local iterators @c x that reference this container,
- are not singular, and for which @c pred(x) returns @c
- true. @c pred will be invoked with the normal ilocal iterators
+ are not singular, and for which @c __pred(x) returns @c
+ true. @c __pred will be invoked with the normal ilocal iterators
nested in the safe ones. */
template<typename _Predicate>
void
/**
* @brief Copies the range [first,first+count) into [result,result+count).
- * @param first An input iterator.
- * @param count The number of elements to copy.
- * @param result An output iterator.
+ * @param __first An input iterator.
+ * @param __count The number of elements to copy.
+ * @param __result An output iterator.
* @return A std::pair composed of first+count and result+count.
*
* This is an SGI extension.
/**
* @brief @c memcmp on steroids.
- * @param first1 An input iterator.
- * @param last1 An input iterator.
- * @param first2 An input iterator.
- * @param last2 An input iterator.
+ * @param __first1 An input iterator.
+ * @param __last1 An input iterator.
+ * @param __first2 An input iterator.
+ * @param __last2 An input iterator.
* @return An int, as with @c memcmp.
*
* The return value will be less than zero if the first range is
/**
* @brief Find the median of three values.
- * @param a A value.
- * @param b A value.
- * @param c A value.
+ * @param __a A value.
+ * @param __b A value.
+ * @param __c A value.
* @return One of @p a, @p b or @p c.
*
* If @c {l,m,n} is some convolution of @p {a,b,c} such that @c l<=m<=n
/**
* @brief Find the median of three values using a predicate for comparison.
- * @param a A value.
- * @param b A value.
- * @param c A value.
- * @param comp A binary predicate.
+ * @param __a A value.
+ * @param __b A value.
+ * @param __c A value.
+ * @param __comp A binary predicate.
* @return One of @p a, @p b or @p c.
*
* If @c {l,m,n} is some convolution of @p {a,b,c} such that @p comp(l,m)
* It is to be used only for built-in types or PODs. Notable
* differences are:
*
- * @detail
* 1. Not all accessor functions are present.
* 2. Used ONLY for PODs.
* 3. No Allocator template argument. Uses ::operator new() to get
* @param __addr The pointer to the memory block to be
* validated.
*
- * @detail Validates the memory block passed to this function and
+ * Validates the memory block passed to this function and
* appropriately performs the action of managing the free list of
* blocks by adding this block to the free list or deleting this
* or larger blocks from the free list.
*
* @throw std::bad_alloc. If memory can not be allocated.
*
- * @detail Complexity: O(1), but internally depends upon the
+ * Complexity: O(1), but internally depends upon the
* complexity of the function free_list::_M_get. The part where
* the bitmap headers are written has complexity: O(X),where X
* is the number of blocks of size sizeof(value_type) within
*
* @throw std::bad_alloc. If memory can not be allocated.
*
- * @detail Complexity: Worst case complexity is O(N), but that
+ * Complexity: Worst case complexity is O(N), but that
* is hardly ever hit. If and when this particular case is
* encountered, the next few cases are guaranteed to have a
* worst case complexity of O(1)! That's why this function
/** @brief Deallocates memory that belongs to a single object of
* size sizeof(_Tp).
*
- * @detail Complexity: O(lg(N)), but the worst case is not hit
+ * Complexity: O(lg(N)), but the worst case is not hit
* often! This is because containers usually deallocate memory
* close to each other and this case is handled in O(1) time by
* the deallocate function.
*
* @c binary_compose is constructed from three functors, @c f, @c g1,
* and @c g2. Its @c operator() returns @c f(g1(x),g2(x)). The function
- * @compose2 takes f, g1, and g2, and constructs the @c binary_compose
+ * compose2 takes f, g1, and g2, and constructs the @c binary_compose
* instance for you. For example, if @c f returns an int, then
* \code
* int answer = (compose2(f,g1,g2))(x);
/**
* @brief Copies the range [first,last) into result.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param result An output iterator.
- * @return result + (first - last)
+ * @param __first An input iterator.
+ * @param __count Length
+ * @param __result An output iterator.
+ * @return __result + (__first + __count)
* @ingroup SGIextensions
*
* Like copy(), but does not require an initialized output range.
* @tparam _ATraits Element access traits.
* @tparam Tag Instantiating data structure type,
* see container_tag.
- * @tparam Node_Update Updates nodes,
+ * @tparam Node_Update Updates trie nodes,
* restores invariants when invalidated.
* XXX See design::tree-based-containers::node invariants.
* @tparam _Alloc Allocator type.
stdio_filebuf() : std::basic_filebuf<_CharT, _Traits>() {}
/**
- * @param fd An open file descriptor.
- * @param mode Same meaning as in a standard filebuf.
- * @param size Optimal or preferred size of internal buffer, in chars.
+ * @param __fd An open file descriptor.
+ * @param __mode Same meaning as in a standard filebuf.
+ * @param __size Optimal or preferred size of internal buffer,
+ * in chars.
*
* This constructor associates a file stream buffer with an open
* POSIX file descriptor. The file descriptor will be automatically
size_t __size = static_cast<size_t>(BUFSIZ));
/**
- * @param f An open @c FILE*.
- * @param mode Same meaning as in a standard filebuf.
- * @param size Optimal or preferred size of internal buffer, in chars.
- * Defaults to system's @c BUFSIZ.
+ * @param __f An open @c FILE*.
+ * @param __mode Same meaning as in a standard filebuf.
+ * @param __size Optimal or preferred size of internal buffer,
+ * in chars. Defaults to system's @c BUFSIZ.
*
* This constructor associates a file stream buffer with an open
* C @c FILE*. The @c FILE* will not be automatically closed when the
// NB: per LWG issue 42, semantics different from IS:
/**
- * @brief Construct string with copy of value of @a str.
+ * @brief Construct string with copy of value of @a __str.
* @param __str Source string.
*/
__versa_string(const __versa_string& __str)
* @param __str Source string.
*
* The newly-constructed %string contains the exact contents of
- * @a str. The contents of @a str are a valid, but unspecified
+ * @a __str. The contents of @a __str are a valid, but unspecified
* string.
*/
__versa_string(__versa_string&& __str) noexcept
/**
* @brief Compare substring against a character array.
- * @param __pos1 Index of first character of substring.
+ * @param __pos Index of first character of substring.
* @param __n1 Number of characters in substring.
* @param __s character array to compare against.
* @param __n2 Number of characters of s.
* @return Integer < 0, 0, or > 0.
*
* Form the substring of this string from the @a __n1
- * characters starting at @a __pos1. Form a string from the
+ * characters starting at @a __pos. Form a string from the
* first @a __n2 characters of @a __s. Returns an integer < 0
* if this substring is ordered before the string from @a __s,
* 0 if their values are equivalent, or > 0 if this substring
* effective length rlen of the strings to compare as the
* smallest of the length of the substring and @a __n2. The
* function then compares the two strings by calling
- * traits::compare(substring.data(),s,rlen). If the result of
+ * traits::compare(substring.data(),__s,rlen). If the result of
* the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
- * NB: s must have at least n2 characters, <em>\\0</em> has no special
+ * NB: __s must have at least n2 characters, <em>\\0</em> has no special
* meaning.
*/
int
typedef _PseudoSequenceIterator<_Tp, uint64_t> iterator;
/** @brief Constructor.
- * @param _M_val Element of the sequence.
+ * @param __val Element of the sequence.
* @param __count Number of (virtual) copies.
*/
_PseudoSequence(const _Tp& __val, _DifferenceType __count)
_It2 __begin2_iterator;
/** @brief Constructor.
- * @param b1 Begin iterator of first sequence.
- * @param b2 Begin iterator of second sequence. */
+ * @param __b1 Begin iterator of first sequence.
+ * @param __b2 Begin iterator of second sequence. */
explicit
__inner_product_selector(_It __b1, _It2 __b2)
: __begin1_iterator(__b1), __begin2_iterator(__b2) { }
* @param __i iterator referencing object. */
template<typename _It>
void
- operator()(_It) { }
+ operator()(_It __i) { }
};
/** @brief Reduction function doing nothing. */
/** @brief Multi-way merging procedure for a high branching factor,
* requiring sentinels to exist.
*
- * @param __stable The value must the same as for the used LoserTrees.
- * @param UnguardedLoserTree _Loser Tree variant to use for the unguarded
- * merging.
- * @param GuardedLoserTree _Loser Tree variant to use for the guarded
+ * @tparam UnguardedLoserTree _Loser Tree variant to use for the unguarded
* merging.
*
* @param __seqs_begin Begin iterator of iterator pair input sequence.
* @param __comp Comparator.
* @param __length Maximum length to merge, possibly larger than the
* number of elements available.
- * @param __stable Stable merging incurs a performance penalty.
* @param __sentinel The sequences have __a __sentinel element.
* @return End iterator of output sequence. */
template<bool __stable,
*
* Must not be called if the number of sequences is 1.
*
- * @param _Splitter functor to split input (either __exact or sampling based)
+ * @tparam _Splitter functor to split input (either __exact or sampling based)
+ * @tparam __stable Stable merging incurs a performance penalty.
+ * @tparam __sentinel Ignored.
*
* @param __seqs_begin Begin iterator of iterator pair input sequence.
* @param __seqs_end End iterator of iterator pair input sequence.
* @param __comp Comparator.
* @param __length Maximum length to merge, possibly larger than the
* number of elements available.
- * @param __stable Stable merging incurs a performance penalty.
- * @param __sentinel Ignored.
* @return End iterator of output sequence.
*/
template<bool __stable,
* @post return __value - __target = min(__length, number of elements in all
* sequences).
*
- * @param _RAIterPairIterator iterator over sequence
+ * @tparam _RAIterPairIterator iterator over sequence
* of pairs of iterators
- * @param _RAIterOut iterator over target sequence
- * @param _DifferenceTp difference type for the sequence
- * @param _Compare strict weak ordering type to compare elements
+ * @tparam _RAIterOut iterator over target sequence
+ * @tparam _DifferenceTp difference type for the sequence
+ * @tparam _Compare strict weak ordering type to compare elements
* in sequences
*
* @param __seqs_begin __begin of sequence __sequence
*
* @see stable_multiway_merge_sentinels
*
- * @param _RAIterPairIterator iterator over sequence
+ * @tparam _RAIterPairIterator iterator over sequence
* of pairs of iterators
- * @param _RAIterOut iterator over target sequence
- * @param _DifferenceTp difference type for the sequence
- * @param _Compare strict weak ordering type to compare elements
+ * @tparam _RAIterOut iterator over target sequence
+ * @tparam _DifferenceTp difference type for the sequence
+ * @tparam _Compare strict weak ordering type to compare elements
* in sequences
*
* @param __seqs_begin __begin of sequence __sequence
* @param __begin Begin iterator of sequence.
* @param __end End iterator of sequence.
* @param __comp Comparator.
- * @param __n Length of sequence.
* @param __num_threads Number of threads to use.
*/
template<bool __stable, bool __exact, typename _RAIter,
* @param __result Begin iterator of output sequence.
* @param __bin_op Associative binary function.
* @param __n Length of sequence.
- * @param __num_threads Number of threads to use.
* @return End iterator of output sequence.
*/
template<typename _IIter,
public:
/** @brief Constructor. Not to be called concurrent, of course.
- * @param _M_max_size Maximal number of elements to be contained. */
+ * @param __max_size Maximal number of elements to be contained. */
_RestrictedBoundedConcurrentQueue(_SequenceIndex __max_size)
{
_M_max_size = __max_size;
}
/** @brief Generate a number of random bits, run-time parameter.
- * @param bits Number of bits to generate. */
+ * @param __bits Number of bits to generate. */
unsigned long
__genrand_bits(int __bits)
{
* @brief Precalculate __advances for Knuth-Morris-Pratt algorithm.
* @param __elements Begin iterator of sequence to search for.
* @param __length Length of sequence to search for.
- * @param __advances Returned __offsets.
+ * @param __off Returned __offsets.
*/
template<typename _RAIter, typename _DifferenceTp>
void
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
- * @param __stable Sort __stable.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
* @param __begin Begin iterator of input sequence.
* @param __end End iterator of input sequence.
* @param __comp Comparator.
- * @param __stable Sort __stable.
+ * @tparam __stable Sort stable.
* @callgraph
*/
template<bool __stable, typename _RAIter, typename _Compare>
/**
* @brief Use a subset of a string.
- * @param s A string of @a 0 and @a 1 characters.
- * @param position Index of the first character in @a s to use;
+ * @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::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 @a 0 nor @a 1.
*/
/**
* @brief Use a subset of a string.
- * @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.
+ * @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 __position is bigger the size
+ * of @a __s.
* @throw std::invalid_argument If a character appears in the string
* which is neither @a 0 nor @a 1.
*/
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Construct from a character %array.
- * @param str An %array of characters @a zero and @a one.
- * @param n The number of characters to use.
- * @param zero The character corresponding to the value 0.
- * @param one The character corresponding to the value 1.
- * @throw std::invalid_argument If a character appears in the string
- * which is neither @a zero nor @a one.
+ * @param __str An %array of characters @a zero and @a one.
+ * @param __n The number of characters to use.
+ * @param __zero The character corresponding to the value 0.
+ * @param __one The character corresponding to the value 1.
+ * @throw std::invalid_argument If a character appears in the string
+ * which is neither @a __zero nor @a __one.
*/
template<typename _CharT>
explicit
//@{
/**
* @brief Operations on bitsets.
- * @param rhs A same-sized bitset.
+ * @param __rhs A same-sized bitset.
*
* These should be self-explanatory.
*/
//@{
/**
* @brief Operations on bitsets.
- * @param position The number of places to shift.
+ * @param __position The number of places to shift.
*
* These should be self-explanatory.
*/
/**
* @brief Sets a given bit to a particular value.
- * @param position The index of the bit.
- * @param val Either true or false, defaults to true.
+ * @param __position The index of the bit.
+ * @param __val Either true or false, defaults to true.
* @throw std::out_of_range If @a pos is bigger the size of the %set.
*/
bitset<_Nb>&
/**
* @brief Sets a given bit to false.
- * @param position The index of the bit.
+ * @param __position The index of the bit.
* @throw std::out_of_range If @a pos is bigger the size of the %set.
*
* Same as writing @c set(pos,false).
/**
* @brief Toggles a given bit to its opposite value.
- * @param position The index of the bit.
+ * @param __position The index of the bit.
* @throw std::out_of_range If @a pos is bigger the size of the %set.
*/
bitset<_Nb>&
//@{
/**
* @brief Array-indexing support.
- * @param position Index into the %bitset.
+ * @param __position Index into the %bitset.
* @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,
/**
* @brief Tests the value of a bit.
- * @param position The index of a bit.
+ * @param __position The index of a bit.
* @return The value at @a pos.
* @throw std::out_of_range If @a pos is bigger the size of the %set.
*/
/**
* @brief Finds the index of the next "on" bit after prev.
* @return The index of the next bit set, or size() if not found.
- * @param prev Where to start searching.
+ * @param __prev Where to start searching.
* @ingroup SGIextensions
* @sa _Find_first
*/
//@{
/**
* @brief Global bitwise operations on bitsets.
- * @param x A bitset.
- * @param y A bitset of the same size as @a x.
+ * @param __x A bitset.
+ * @param __y A bitset of the same size as @a __x.
* @return A new bitset.
*
* These should be self-explanatory.
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
* @return @c this on success, NULL on failure
*
* If a file is already open, this function immediately fails.
- * Otherwise it tries to open the file named @a s using the flags
+ * Otherwise it tries to open the file named @a __s using the flags
* given in @a mode.
*
* Table 92, adapted here, gives the relation between openmode
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
* @return @c this on success, NULL on failure
*/
__filebuf_type*
/**
* @brief Manipulates the buffer.
- * @param s Pointer to a buffer area.
- * @param n Size of @a s.
+ * @param __s Pointer to a buffer area.
+ * @param __n Size of @a __s.
* @return @c this
*
- * If no file has been opened, and both @a s and @a n are zero, then
- * the stream becomes unbuffered. Otherwise, @c s is used as a
+ * If no file has been opened, and both @a __s and @a __n are zero, then
+ * the stream becomes unbuffered. Otherwise, @c __s is used as a
* buffer; see
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25s02.html
* for more.
/**
* @brief Create an input file stream.
- * @param s Null terminated string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s Null terminated string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*
- * @c ios_base::in is automatically included in @a mode.
+ * @c ios_base::in is automatically included in @a __mode.
*
* Tip: When using std::string to hold the filename, you must use
* .c_str() before passing it to this constructor.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Create an input file stream.
- * @param s std::string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s std::string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*
- * @c ios_base::in is automatically included in @a mode.
+ * @c ios_base::in is automatically included in @a __mode.
*/
explicit
basic_ifstream(const std::string& __s,
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
- * Calls @c std::basic_filebuf::open(s,mode|in). If that function
+ * Calls @c std::basic_filebuf::open(s,__mode|in). If that function
* fails, @c failbit is set in the stream's error state.
*
* Tip: When using std::string to hold the filename, you must use
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
- * Calls @c std::basic_filebuf::open(s,mode|in). If that function
+ * Calls @c std::basic_filebuf::open(__s,__mode|in). If that function
* fails, @c failbit is set in the stream's error state.
*/
void
/**
* @brief Create an output file stream.
- * @param s Null terminated string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s Null terminated string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*
* @c ios_base::out|ios_base::trunc is automatically included in
- * @a mode.
+ * @a __mode.
*
* Tip: When using std::string to hold the filename, you must use
* .c_str() before passing it to this constructor.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Create an output file stream.
- * @param s std::string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s std::string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*
* @c ios_base::out|ios_base::trunc is automatically included in
- * @a mode.
+ * @a __mode.
*/
explicit
basic_ofstream(const std::string& __s,
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
- * Calls @c std::basic_filebuf::open(s,mode|out|trunc). If that
+ * Calls @c std::basic_filebuf::open(__s,__mode|out|trunc). If that
* function fails, @c failbit is set in the stream's error state.
*
* Tip: When using std::string to hold the filename, you must use
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
* Calls @c std::basic_filebuf::open(s,mode|out|trunc). If that
* function fails, @c failbit is set in the stream's error state.
/**
* @brief Create an input/output file stream.
- * @param s Null terminated string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s Null terminated string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*
* Tip: When using std::string to hold the filename, you must use
* .c_str() before passing it to this constructor.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Create an input/output file stream.
- * @param s Null terminated string specifying the filename.
- * @param mode Open file in specified mode (see std::ios_base).
+ * @param __s Null terminated string specifying the filename.
+ * @param __mode Open file in specified mode (see std::ios_base).
*/
explicit
basic_fstream(const std::string& __s,
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
- * Calls @c std::basic_filebuf::open(s,mode). If that
+ * Calls @c std::basic_filebuf::open(__s,__mode). If that
* function fails, @c failbit is set in the stream's error state.
*
* Tip: When using std::string to hold the filename, you must use
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Opens an external file.
- * @param s The name of the file.
- * @param mode The open mode flags.
+ * @param __s The name of the file.
+ * @param __mode The open mode flags.
*
- * Calls @c std::basic_filebuf::open(s,mode). If that
+ * Calls @c std::basic_filebuf::open(__s,__mode). If that
* function fails, @c failbit is set in the stream's error state.
*/
void
/**
* @brief %Function copy constructor.
- * @param x A %function object with identical call signature.
- * @post @c (bool)*this == (bool)x
+ * @param __x A %function object with identical call signature.
+ * @post @c bool(*this) == bool(__x)
*
* The newly-created %function contains a copy of the target of @a
- * x (if it has one).
+ * __x (if it has one).
*/
function(const function& __x);
/**
* @brief %Function move constructor.
- * @param x A %function object rvalue with identical call signature.
+ * @param __x A %function object rvalue with identical call signature.
*
- * The newly-created %function contains the target of @a x
+ * The newly-created %function contains the target of @a __x
* (if it has one).
*/
function(function&& __x) : _Function_base()
/**
* @brief Builds a %function that targets a copy of the incoming
* function object.
- * @param f A %function object that is callable with parameters of
+ * @param __f A %function object that is callable with parameters of
* type @c T1, @c T2, ..., @c TN and returns a value convertible
* to @c Res.
*
- * The newly-created %function object will target a copy of @a
- * f. If @a f is @c reference_wrapper<F>, then this function
+ * The newly-created %function object will target a copy of
+ * @a __f. If @a __f is @c reference_wrapper<F>, then this function
* object will contain a reference to the function object @c
- * f.get(). If @a f is a NULL function pointer or NULL
+ * __f.get(). If @a __f is a NULL function pointer or NULL
* pointer-to-member, the newly-created object will be empty.
*
- * If @a f is a non-NULL function pointer or an object of type @c
+ * If @a __f is a non-NULL function pointer or an object of type @c
* reference_wrapper<F>, this function will not throw.
*/
template<typename _Functor>
/**
* @brief %Function assignment operator.
- * @param x A %function with identical call signature.
+ * @param __x A %function with identical call signature.
* @post @c (bool)*this == (bool)x
* @returns @c *this
*
- * The target of @a x is copied to @c *this. If @a x has no
+ * The target of @a __x is copied to @c *this. If @a __x has no
* target, then @c *this will be empty.
*
- * If @a x targets a function pointer or a reference to a function
+ * If @a __x targets a function pointer or a reference to a function
* object, then this operation will not throw an %exception.
*/
function&
/**
* @brief %Function move-assignment operator.
- * @param x A %function rvalue with identical call signature.
+ * @param __x A %function rvalue with identical call signature.
* @returns @c *this
*
- * The target of @a x is moved to @c *this. If @a x has no
+ * The target of @a __x is moved to @c *this. If @a __x has no
* target, then @c *this will be empty.
*
- * If @a x targets a function pointer or a reference to a function
+ * If @a __x targets a function pointer or a reference to a function
* object, then this operation will not throw an %exception.
*/
function&
/**
* @brief %Function assignment to a new target.
- * @param f A %function object that is callable with parameters of
+ * @param __f A %function object that is callable with parameters of
* type @c T1, @c T2, ..., @c TN and returns a value convertible
* to @c Res.
* @return @c *this
*
* This %function object wrapper will target a copy of @a
- * f. If @a f is @c reference_wrapper<F>, then this function
+ * __f. If @a __f is @c reference_wrapper<F>, then this function
* object will contain a reference to the function object @c
- * f.get(). If @a f is a NULL function pointer or NULL
+ * __f.get(). If @a __f is a NULL function pointer or NULL
* pointer-to-member, @c this object will be empty.
*
- * If @a f is a non-NULL function pointer or an object of type @c
+ * If @a __f is a non-NULL function pointer or an object of type @c
* reference_wrapper<F>, this function will not throw.
*/
template<typename _Functor>
/**
* @brief Swap the targets of two %function objects.
- * @param f A %function with identical call signature.
+ * @param __x A %function with identical call signature.
*
- * Swap the targets of @c this function object and @a f. This
+ * Swap the targets of @c this function object and @a __f. This
* function will not throw an %exception.
*/
void swap(function& __x)
/**
* @brief Manipulator for @c setf.
- * @param mask A format flags mask.
+ * @param __mask A format flags mask.
*
* Sent to a stream object, this manipulator resets the specified flags,
- * via @e stream.setf(0,mask).
+ * via @e stream.setf(0,__mask).
*/
inline _Resetiosflags
resetiosflags(ios_base::fmtflags __mask)
/**
* @brief Manipulator for @c setf.
- * @param mask A format flags mask.
+ * @param __mask A format flags mask.
*
* Sent to a stream object, this manipulator sets the format flags
- * to @a mask.
+ * to @a __mask.
*/
inline _Setiosflags
setiosflags(ios_base::fmtflags __mask)
/**
* @brief Manipulator for @c setf.
- * @param base A numeric base.
+ * @param __base A numeric base.
*
* Sent to a stream object, this manipulator changes the
* @c ios_base::basefield flags to @c oct, @c dec, or @c hex when @a base
- * is 8, 10, or 16, accordingly, and to 0 if @a base is any other value.
+ * is 8, 10, or 16, accordingly, and to 0 if @a __base is any other value.
*/
inline _Setbase
setbase(int __base)
/**
* @brief Manipulator for @c fill.
- * @param c The new fill character.
+ * @param __c The new fill character.
*
- * Sent to a stream object, this manipulator calls @c fill(c) for that
+ * Sent to a stream object, this manipulator calls @c fill(__c) for that
* object.
*/
template<typename _CharT>
/**
* @brief Manipulator for @c precision.
- * @param n The new precision.
+ * @param __n The new precision.
*
- * Sent to a stream object, this manipulator calls @c precision(n) for
+ * Sent to a stream object, this manipulator calls @c precision(__n) for
* that object.
*/
inline _Setprecision
/**
* @brief Manipulator for @c width.
- * @param n The new width.
+ * @param __n The new width.
*
- * Sent to a stream object, this manipulator calls @c width(n) for
+ * Sent to a stream object, this manipulator calls @c width(__n) for
* that object.
*/
inline _Setw
/**
* @brief Extended manipulator for extracting money.
- * @param mon Either long double or a specialization of @c basic_string.
- * @param intl A bool indicating whether international format
- * is to be used.
+ * @param __mon Either long double or a specialization of @c basic_string.
+ * @param __intl A bool indicating whether international format
+ * is to be used.
*
- * Sent to a stream object, this manipulator extracts @a mon.
+ * Sent to a stream object, this manipulator extracts @a __mon.
*/
template<typename _MoneyT>
inline _Get_money<_MoneyT>
/**
* @brief Extended manipulator for inserting money.
- * @param mon Either long double or a specialization of @c basic_string.
- * @param intl A bool indicating whether international format
- * is to be used.
+ * @param __mon Either long double or a specialization of @c basic_string.
+ * @param __intl A bool indicating whether international format
+ * is to be used.
*
- * Sent to a stream object, this manipulator inserts @a mon.
+ * Sent to a stream object, this manipulator inserts @a __mon.
*/
template<typename _MoneyT>
inline _Put_money<_MoneyT>
//@{
/**
* @brief Basic arithmetic extractors
- * @param A variable of builtin type.
+ * @param __n, __f, __p: A variable of builtin type.
* @return @c *this if successful
*
* These functions use the stream's current locale (specifically, the
/**
* @brief Extracting into another streambuf.
- * @param sb A pointer to a streambuf
+ * @param __sb A pointer to a streambuf
*
* This function behaves like one of the basic arithmetic extractors,
* in that it also constructs a sentry object and has the same error
* handling behavior.
*
- * If @a sb is NULL, the stream will set failbit in its error state.
+ * If @a __sb is NULL, the stream will set failbit in its error state.
*
* Characters are extracted from this stream and inserted into the
* @a sb streambuf until one of the following occurs:
/**
* @brief Simple extraction.
- * @param c The character in which to store data.
+ * @param __c The character in which to store data.
* @return *this
*
- * Tries to extract a character and store it in @a c. If none are
+ * Tries to extract a character and store it in @a __c. If none are
* available, sets failbit and returns traits::eof().
*
* @note This function is not overloaded on signed char and
/**
* @brief Simple multiple-character extraction.
- * @param s Pointer to an array.
- * @param n Maximum number of characters to store in @a s.
- * @param delim A "stop" character.
+ * @param __s Pointer to an array.
+ * @param __n Maximum number of characters to store in @a __s.
+ * @param __delim A "stop" character.
* @return *this
*
- * Characters are extracted and stored into @a s until one of the
+ * Characters are extracted and stored into @a __s until one of the
* following happens:
*
- * - @c n-1 characters are stored
+ * - @c __n-1 characters are stored
* - the input sequence reaches EOF
- * - the next character equals @a delim, in which case the character
+ * - the next character equals @a __delim, in which case the character
* is not extracted
*
* If no characters are stored, failbit is set in the stream's error
/**
* @brief Simple multiple-character extraction.
- * @param s Pointer to an array.
- * @param n Maximum number of characters to store in @a s.
+ * @param __s Pointer to an array.
+ * @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)
/**
* @brief Extraction into another streambuf.
- * @param sb A streambuf in which to store data.
- * @param delim A "stop" character.
+ * @param __sb A streambuf in which to store data.
+ * @param __delim A "stop" character.
* @return *this
*
- * Characters are extracted and inserted into @a sb until one of the
+ * Characters are extracted and inserted into @a __sb until one of the
* following happens:
*
* - the input sequence reaches EOF
* - insertion into the output buffer fails (in this case, the
* character that would have been inserted is not extracted)
- * - the next character equals @a delim (in this case, the character
+ * - the next character equals @a __delim (in this case, the character
* is not extracted)
* - an exception occurs (and in this case is caught)
*
/**
* @brief Extraction into another streambuf.
- * @param sb A streambuf in which to store data.
+ * @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)
/**
* @brief String extraction.
- * @param s A character array in which to store the data.
- * @param n Maximum number of characters to extract.
- * @param delim A "stop" character.
+ * @param __s A character array in which to store the data.
+ * @param __n Maximum number of characters to extract.
+ * @param __delim A "stop" character.
* @return *this
*
- * Extracts and stores characters into @a s until one of the
+ * Extracts and stores characters into @a __s until one of the
* following happens. Note that these criteria are required to be
* tested in the order listed here, to allow an input line to exactly
- * fill the @a s array without setting failbit.
+ * fill the @a __s array without setting failbit.
*
* -# the input sequence reaches end-of-file, in which case eofbit
* is set in the stream error state
- * -# the next character equals @c delim, in which case the character
+ * -# the next character equals @c __delim, in which case the character
* is extracted (and therefore counted in @c gcount()) but not stored
- * -# @c n-1 characters are stored, in which case failbit is set
+ * -# @c __n-1 characters are stored, in which case failbit is set
* in the stream error state
*
* If no characters are extracted, failbit is set. (An empty line of
/**
* @brief String extraction.
- * @param s A character array in which to store the data.
- * @param n Maximum number of characters to extract.
+ * @param __s A character array in which to store the data.
+ * @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 Discarding characters
- * @param n Number of characters to discard.
- * @param delim A "stop" character.
+ * @param __n Number of characters to discard.
+ * @param __delim A "stop" character.
* @return *this
*
* Extracts characters and throws them away until one of the
* following happens:
- * - if @a n @c != @c std::numeric_limits<int>::max(), @a n
+ * - if @a __n @c != @c std::numeric_limits<int>::max(), @a __n
* characters are extracted
* - the input sequence reaches end-of-file
- * - the next character equals @a delim (in this case, the character
+ * - the next character equals @a __delim (in this case, the character
* is extracted); note that this condition will never occur if
- * @a delim equals @c traits::eof().
+ * @a __delim equals @c traits::eof().
*
* NB: Provide three overloads, instead of the single function
* (with defaults) mandated by the Standard: this leads to a
* the Standard.
*/
__istream_type&
- ignore();
+ ignore(streamsize __n, int_type __delim);
__istream_type&
ignore(streamsize __n);
__istream_type&
- ignore(streamsize __n, int_type __delim);
-
+ ignore();
+
/**
* @brief Looking ahead in the stream
* @return The next character, or eof().
/**
* @brief Extraction without delimiters.
- * @param s A character array.
- * @param n Maximum number of characters to store.
+ * @param __s A character array.
+ * @param __n Maximum number of characters to store.
* @return *this
*
* If the stream state is @c good(), extracts characters and stores
- * them into @a s until one of the following happens:
- * - @a n characters are stored
+ * them into @a __s until one of the following happens:
+ * - @a __n characters are stored
* - the input sequence reaches end-of-file, in which case the error
* state is set to @c failbit|eofbit.
*
/**
* @brief Extraction until the buffer is exhausted, but no more.
- * @param s A character array.
- * @param n Maximum number of characters to store.
+ * @param __s A character array.
+ * @param __n Maximum number of characters to store.
* @return The number of characters extracted.
*
- * Extracts characters and stores them into @a s depending on the
+ * Extracts characters and stores them into @a __s depending on the
* number of characters remaining in the streambuf's buffer,
* @c rdbuf()->in_avail(), called @c A here:
* - if @c A @c == @c -1, sets eofbit and extracts no characters
/**
* @brief Unextracting a single character.
- * @param c The character to push back into the input stream.
+ * @param __c The character to push back into the input stream.
* @return *this
*
* If @c rdbuf() is not null, calls @c rdbuf()->sputbackc(c).
/**
* @brief Changing the current read position.
- * @param pos A file position object.
+ * @param __pos A file position object.
* @return *this
*
- * If @c fail() is not true, calls @c rdbuf()->pubseekpos(pos). If
+ * If @c fail() is not true, calls @c rdbuf()->pubseekpos(__pos). If
* that function fails, sets failbit.
*
* @note This function first clears eofbit. It does not count the
/**
* @brief Changing the current read position.
- * @param off A file offset object.
- * @param dir The direction in which to seek.
+ * @param __off A file offset object.
+ * @param __dir The direction in which to seek.
* @return *this
*
- * If @c fail() is not true, calls @c rdbuf()->pubseekoff(off,dir).
+ * If @c fail() is not true, calls @c rdbuf()->pubseekoff(__off,__dir).
* If that function fails, sets failbit.
*
* @note This function first clears eofbit. It does not count the
/**
* @brief The constructor performs all the work.
- * @param is The input stream to guard.
- * @param noskipws Whether to consume whitespace or not.
+ * @param __is The input stream to guard.
+ * @param __noskipws Whether to consume whitespace or not.
*
- * If the stream state is good (@a is.good() is true), then the
+ * If the stream state is good (@a __is.good() is true), then the
* following actions are performed, otherwise the sentry state
* is false (<em>not okay</em>) and failbit is set in the
* stream state.
*
* -# if the stream is tied to an output stream, @c is.tie()->flush()
* is called to synchronize the output sequence
- * -# if @a noskipws is false, and @c ios_base::skipws is set in
+ * -# if @a __noskipws is false, and @c ios_base::skipws is set in
* @c is.flags(), the sentry extracts and discards whitespace
* characters from the stream. The currently imbued locale is
* used to determine whether each character is whitespace.
//@{
/**
* @brief Character extractors
- * @param in An input stream.
- * @param c A character reference.
+ * @param __in An input stream.
+ * @param __c A character reference.
* @return in
*
* Behaves like one of the formatted arithmetic extractors described in
* std::basic_istream. After constructing a sentry object with good
* status, this function extracts a character (if one is available) and
- * stores it in @a c. Otherwise, sets failbit in the input stream.
+ * stores it in @a __c. Otherwise, sets failbit in the input stream.
*/
template<typename _CharT, typename _Traits>
basic_istream<_CharT, _Traits>&
//@{
/**
* @brief Character string extractors
- * @param in An input stream.
- * @param s A pointer to a character array.
- * @return in
+ * @param __in An input stream.
+ * @param __s A pointer to a character array.
+ * @return __in
*
* Behaves like one of the formatted arithmetic extractors described in
* std::basic_istream. After constructing a sentry object with good
* status, this function extracts up to @c n characters and stores them
- * into the array starting at @a s. @c n is defined as:
+ * 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 <em>the number of elements of the largest array of *
// [27.7.1.6] Rvalue stream extraction
/**
* @brief Generic extractor for rvalue stream
- * @param is An input stream.
- * @param x A reference to the extraction target.
+ * @param __is An input stream.
+ * @param __x A reference to the extraction target.
* @return is
*
* This is just a forwarding function to allow extraction from
//@{
/**
* @brief Basic arithmetic inserters
- * @param A variable of builtin type.
+ * @param __n, __f, __p A variable of builtin type.
* @return @c *this if successful
*
* These functions use the stream's current locale (specifically, the
/**
* @brief Extracting from another streambuf.
- * @param sb A pointer to a streambuf
+ * @param __sb A pointer to a streambuf
*
* This function behaves like one of the basic arithmetic extractors,
* in that it also constructs a sentry object and has the same error
* handling behavior.
*
- * If @a sb is NULL, the stream will set failbit in its error state.
+ * If @a __sb is NULL, the stream will set failbit in its error state.
*
- * Characters are extracted from @a sb and inserted into @c *this
+ * Characters are extracted from @a __sb and inserted into @c *this
* until one of the following occurs:
*
* - the input stream reaches end-of-file,
* - insertion into the output sequence fails (in this case, the
* character that would have been inserted is not extracted), or
- * - an exception occurs while getting a character from @a sb, which
+ * - an exception occurs while getting a character from @a __sb, which
* sets failbit in the error state
*
* If the function inserts no characters, failbit is set.
//@{
/**
* @brief Simple insertion.
- * @param c The character to insert.
+ * @param __c The character to insert.
* @return *this
*
* Tries to insert @a c.
/**
* @brief Character string insertion.
- * @param s The array to insert.
- * @param n Maximum number of characters to insert.
+ * @param __s The array to insert.
+ * @param __n Maximum number of characters to insert.
* @return *this
*
- * Characters are copied from @a s and inserted into the stream until
+ * Characters are copied from @a __s and inserted into the stream until
* one of the following happens:
*
- * - @a n characters are inserted
+ * - @a __n characters are inserted
* - inserting into the output sequence fails (in this case, badbit
* will be set in the stream's error state)
*
/**
* @brief Changing the current write position.
- * @param pos A file position object.
+ * @param __pos A file position object.
* @return *this
*
* If @c fail() is not true, calls @c rdbuf()->pubseekpos(pos). If
/**
* @brief Changing the current write position.
- * @param off A file offset object.
- * @param dir The direction in which to seek.
+ * @param __off A file offset object.
+ * @param __dir The direction in which to seek.
* @return *this
*
* If @c fail() is not true, calls @c rdbuf()->pubseekoff(off,dir).
public:
/**
* @brief The constructor performs preparatory work.
- * @param os The output stream to guard.
+ * @param __os The output stream to guard.
*
- * If the stream state is good (@a os.good() is true), then if the
+ * If the stream state is good (@a __os.good() is true), then if the
* stream is tied to another output stream, @c is.tie()->flush()
* is called to synchronize the output sequences.
*
//@{
/**
* @brief Character inserters
- * @param out An output stream.
- * @param c A character.
+ * @param __out An output stream.
+ * @param __c A character.
* @return out
*
* Behaves like one of the formatted arithmetic inserters described in
* std::basic_ostream. After constructing a sentry object with good
* status, this function inserts a single character and any required
- * padding (as determined by [22.2.2.2.2]). @c out.width(0) is then
+ * padding (as determined by [22.2.2.2.2]). @c __out.width(0) is then
* called.
*
- * If @a c is of type @c char and the character type of the stream is not
+ * If @a __c is of type @c char and the character type of the stream is not
* @c char, the character is widened before insertion.
*/
template<typename _CharT, typename _Traits>
//@{
/**
* @brief String inserters
- * @param out An output stream.
- * @param s A character string.
+ * @param __out An output stream.
+ * @param __s A character string.
* @return out
* @pre @a s must be a non-NULL pointer
*
* Behaves like one of the formatted arithmetic inserters described in
* std::basic_ostream. After constructing a sentry object with good
- * status, this function inserts @c traits::length(s) characters starting
- * at @a s, widened if necessary, followed by any required padding (as
- * determined by [22.2.2.2.2]). @c out.width(0) is then called.
+ * status, this function inserts @c traits::length(__s) characters starting
+ * at @a __s, widened if necessary, followed by any required padding (as
+ * determined by [22.2.2.2.2]). @c __out.width(0) is then called.
*/
template<typename _CharT, typename _Traits>
inline basic_ostream<_CharT, _Traits>&
// [27.7.2.9] Rvalue stream insertion
/**
* @brief Generic inserter for rvalue stream
- * @param os An input stream.
- * @param x A reference to the object being inserted.
+ * @param __os An input stream.
+ * @param __x A reference to the object being inserted.
* @return os
*
* This is just a forwarding function to allow insertion to
template<typename _OuterAlloc, typename... _InnerAllocs>
class scoped_allocator_adaptor;
- template<typename...> struct __inner_type_impl;
+ template<typename...>
+ struct __inner_type_impl;
- template<typename _Outer>
- struct __inner_type_impl<_Outer>
- {
- typedef scoped_allocator_adaptor<_Outer> __type;
-
- __inner_type_impl() = default;
- __inner_type_impl(const __inner_type_impl&) = default;
- __inner_type_impl(__inner_type_impl&&) = default;
-
- template<typename _Alloc>
- __inner_type_impl(const __inner_type_impl<_Alloc>& __other)
- { }
-
- template<typename _Alloc>
- __inner_type_impl(__inner_type_impl<_Alloc>&& __other)
- { }
-
- __type& _M_get(__type* __p) noexcept { return *__p; }
- const __type& _M_get(const __type* __p) const noexcept { return *__p; }
-
- tuple<> _M_tie() const noexcept { return tuple<>(); }
-
- bool operator==(const __inner_type_impl&) const noexcept
- { return true; }
- };
-
- template<typename _Outer, typename _InnerHead, typename... _InnerTail>
- struct __inner_type_impl<_Outer, _InnerHead, _InnerTail...>
- {
- typedef scoped_allocator_adaptor<_InnerHead, _InnerTail...> __type;
-
- __inner_type_impl() = default;
- __inner_type_impl(const __inner_type_impl&) = default;
- __inner_type_impl(__inner_type_impl&&) = default;
-
- template<typename... _Allocs>
- __inner_type_impl(const __inner_type_impl<_Allocs...>& __other)
- : _M_inner(__other._M_inner) { }
-
- template<typename... _Allocs>
- __inner_type_impl(__inner_type_impl<_Allocs...>&& __other)
- : _M_inner(std::move(__other._M_inner)) { }
-
- template<typename... _Args>
- explicit
- __inner_type_impl(_Args&&... __args)
- : _M_inner(std::forward<_Args>(__args)...) { }
+ template<typename _Outer>
+ struct __inner_type_impl<_Outer>
+ {
+ typedef scoped_allocator_adaptor<_Outer> __type;
- __type& _M_get(void*) noexcept { return _M_inner; }
- const __type& _M_get(const void*) const noexcept { return _M_inner; }
+ __inner_type_impl() = default;
+ __inner_type_impl(const __inner_type_impl&) = default;
+ __inner_type_impl(__inner_type_impl&&) = default;
+
+ template<typename _Alloc>
+ __inner_type_impl(const __inner_type_impl<_Alloc>& __other)
+ { }
+
+ template<typename _Alloc>
+ __inner_type_impl(__inner_type_impl<_Alloc>&& __other)
+ { }
+
+ __type&
+ _M_get(__type* __p) noexcept { return *__p; }
- tuple<const _InnerHead&, const _InnerTail&...> _M_tie() const noexcept
- { return _M_inner._M_tie(); }
+ const __type&
+ _M_get(const __type* __p) const noexcept { return *__p; }
+
+ tuple<>
+ _M_tie() const noexcept { return tuple<>(); }
+
+ bool
+ operator==(const __inner_type_impl&) const noexcept
+ { return true; }
+ };
- bool operator==(const __inner_type_impl& __other) const noexcept
- { return _M_inner == __other._M_inner; }
+ template<typename _Outer, typename _InnerHead, typename... _InnerTail>
+ struct __inner_type_impl<_Outer, _InnerHead, _InnerTail...>
+ {
+ typedef scoped_allocator_adaptor<_InnerHead, _InnerTail...> __type;
+
+ __inner_type_impl() = default;
+ __inner_type_impl(const __inner_type_impl&) = default;
+ __inner_type_impl(__inner_type_impl&&) = default;
+
+ template<typename... _Allocs>
+ __inner_type_impl(const __inner_type_impl<_Allocs...>& __other)
+ : _M_inner(__other._M_inner) { }
+
+ template<typename... _Allocs>
+ __inner_type_impl(__inner_type_impl<_Allocs...>&& __other)
+ : _M_inner(std::move(__other._M_inner)) { }
- private:
- template<typename...> friend class __inner_type_impl;
- template<typename, typename...> friend class scoped_allocator_adaptor;
+ template<typename... _Args>
+ explicit
+ __inner_type_impl(_Args&&... __args)
+ : _M_inner(std::forward<_Args>(__args)...) { }
- __type _M_inner;
- };
+ __type&
+ _M_get(void*) noexcept { return _M_inner; }
+
+ const __type&
+ _M_get(const void*) const noexcept { return _M_inner; }
+
+ tuple<const _InnerHead&, const _InnerTail&...>
+ _M_tie() const noexcept
+ { return _M_inner._M_tie(); }
+
+ bool
+ operator==(const __inner_type_impl& __other) const noexcept
+ { return _M_inner == __other._M_inner; }
+
+ private:
+ template<typename...> friend class __inner_type_impl;
+ template<typename, typename...> friend class scoped_allocator_adaptor;
+
+ __type _M_inner;
+ };
+ /// Primary class template.
template<typename _OuterAlloc, typename... _InnerAllocs>
class scoped_allocator_adaptor
: public _OuterAlloc
template<typename _Tp, typename... _Args>
- void _M_construct(__uses_alloc0, _Tp* __p, _Args&&... __args)
+ void
+ _M_construct(__uses_alloc0, _Tp* __p, _Args&&... __args)
{
auto& __outer = __outermost(*this);
typedef typename std::decay<decltype(__outer)>::type __outer_type;
typedef __uses_alloc2<typename __inner_type::__type> __uses_alloc2_;
template<typename _Tp, typename... _Args>
- void _M_construct(__uses_alloc1_, _Tp* __p, _Args&&... __args)
+ void
+ _M_construct(__uses_alloc1_, _Tp* __p, _Args&&... __args)
{
auto& __outer = __outermost(*this);
typedef typename std::decay<decltype(__outer)>::type __outer_type;
}
template<typename _Tp, typename... _Args>
- void _M_construct(__uses_alloc2_, _Tp* __p, _Args&&... __args)
+ void
+ _M_construct(__uses_alloc2_, _Tp* __p, _Args&&... __args)
{
auto& __outer = __outermost(*this);
typedef typename std::decay<decltype(__outer)>::type __outer_type;
// Constructors:
/**
* @brief Starts with an empty string buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __mode Whether the buffer can read, or write, or both.
*
* The default constructor initializes the parent class using its
* own default ctor.
/**
* @brief Starts with an existing string buffer.
- * @param str A string to copy as a starting buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __str A string to copy as a starting buffer.
+ * @param __mode Whether the buffer can read, or write, or both.
*
* This constructor initializes the parent class using its
* own default ctor.
/**
* @brief Setting a new buffer.
- * @param s The string to use as a new sequence.
+ * @param __s The string to use as a new sequence.
*
* Deallocates any previous stored sequence, then copies @a s to
* use as a new one.
/**
* @brief Manipulates the buffer.
- * @param s Pointer to a buffer area.
- * @param n Size of @a s.
+ * @param __s Pointer to a buffer area.
+ * @param __n Size of @a __s.
* @return @c this
*
- * If no buffer has already been created, and both @a s and @a n are
- * non-zero, then @c s is used as a buffer; see
+ * If no buffer has already been created, and both @a __s and @a __n are
+ * non-zero, then @c __s is used as a buffer; see
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch25s02.html
* for more.
*/
// Constructors:
/**
* @brief Default constructor starts with an empty string buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __mode Whether the buffer can read, or write, or both.
*
- * @c ios_base::in is automatically included in @a mode.
+ * @c ios_base::in is automatically included in @a __mode.
*
- * Initializes @c sb using @c mode|in, and passes @c &sb to the base
+ * Initializes @c sb using @c __mode|in, and passes @c &sb to the base
* class initializer. Does not allocate any buffer.
*
* That's a lie. We initialize the base class with NULL, because the
/**
* @brief Starts with an existing string buffer.
- * @param str A string to copy as a starting buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __str A string to copy as a starting buffer.
+ * @param __mode Whether the buffer can read, or write, or both.
*
* @c ios_base::in is automatically included in @a mode.
*
/**
* @brief Setting a new buffer.
- * @param s The string to use as a new sequence.
+ * @param __s The string to use as a new sequence.
*
* Calls @c rdbuf()->str(s).
*/
// Constructors/destructor:
/**
* @brief Default constructor starts with an empty string buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __mode Whether the buffer can read, or write, or both.
*
* @c ios_base::out is automatically included in @a mode.
*
/**
* @brief Starts with an existing string buffer.
- * @param str A string to copy as a starting buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __str A string to copy as a starting buffer.
+ * @param __mode Whether the buffer can read, or write, or both.
*
* @c ios_base::out is automatically included in @a mode.
*
/**
* @brief Setting a new buffer.
- * @param s The string to use as a new sequence.
+ * @param __s The string to use as a new sequence.
*
* Calls @c rdbuf()->str(s).
*/
// Constructors/destructors
/**
* @brief Default constructor starts with an empty string buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __m Whether the buffer can read, or write, or both.
*
- * Initializes @c sb using @c mode, and passes @c &sb to the base
- * class initializer. Does not allocate any buffer.
+ * Initializes @c sb using the mode from @c __m, and passes @c
+ * &sb to the base class initializer. Does not allocate any
+ * buffer.
*
* That's a lie. We initialize the base class with NULL, because the
* string class does its own memory management.
/**
* @brief Starts with an existing string buffer.
- * @param str A string to copy as a starting buffer.
- * @param mode Whether the buffer can read, or write, or both.
+ * @param __str A string to copy as a starting buffer.
+ * @param __m Whether the buffer can read, or write, or both.
*
- * Initializes @c sb using @a str and @c mode, and passes @c &sb
+ * Initializes @c sb using @a __str and @c __m, and passes @c &sb
* to the base class initializer.
*
* That's a lie. We initialize the base class with NULL, because the
/**
* @brief Setting a new buffer.
- * @param s The string to use as a new sequence.
+ * @param __s The string to use as a new sequence.
*
* Calls @c rdbuf()->str(s).
*/
// [27.5.2.2.1] locales
/**
* @brief Entry point for imbue().
- * @param loc The new locale.
+ * @param __loc The new locale.
* @return The previous locale.
*
- * Calls the derived imbue(loc).
+ * Calls the derived imbue(__loc).
*/
locale
- pubimbue(const locale &__loc)
+ pubimbue(const locale& __loc)
{
locale __tmp(this->getloc());
this->imbue(__loc);
pubsetbuf(char_type* __s, streamsize __n)
{ return this->setbuf(__s, __n); }
+ /**
+ * @brief Alters the stream position.
+ * @param __off Offset.
+ * @param __way Value for ios_base::seekdir.
+ * @param __mode Value for ios_base::openmode.
+ *
+ * Calls virtual seekoff function.
+ */
pos_type
pubseekoff(off_type __off, ios_base::seekdir __way,
ios_base::openmode __mode = ios_base::in | ios_base::out)
{ return this->seekoff(__off, __way, __mode); }
+ /**
+ * @brief Alters the stream position.
+ * @param __sp Position
+ * @param __mode Value for ios_base::openmode.
+ *
+ * Calls virtual seekpos function.
+ */
pos_type
pubseekpos(pos_type __sp,
ios_base::openmode __mode = ios_base::in | ios_base::out)
{ return this->seekpos(__sp, __mode); }
+ /**
+ * @brief Calls virtual sync function.
+ */
int
pubsync() { return this->sync(); }
//@}
/**
* @brief Entry point for xsgetn.
- * @param s A buffer area.
- * @param n A count.
+ * @param __s A buffer area.
+ * @param __n A count.
*
- * Returns xsgetn(s,n). The effect is to fill @a s[0] through
- * @a s[n-1] with characters from the input sequence, if possible.
+ * Returns xsgetn(__s,__n). The effect is to fill @a __s[0] through
+ * @a __s[__n-1] with characters from the input sequence, if possible.
*/
streamsize
sgetn(char_type* __s, streamsize __n)
// [27.5.2.2.4] putback
/**
* @brief Pushing characters back into the input stream.
- * @param c The character to push back.
+ * @param __c The character to push back.
* @return The previous character, if possible.
*
- * Similar to sungetc(), but @a c is pushed onto the stream
+ * 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.
+ * __c.
*/
int_type
sputbackc(char_type __c)
// [27.5.2.2.5] put area
/**
* @brief Entry point for all single-character output functions.
- * @param c A character to output.
- * @return @a c, if possible.
+ * @param __c A character to output.
+ * @return @a __c, if possible.
*
* One of two public output functions.
*
* If a write position is available for the output sequence (i.e.,
- * the buffer is not full), stores @a c in that position, increments
- * the position, and returns @c traits::to_int_type(c). If a write
- * position is not available, returns @c overflow(c).
+ * the buffer is not full), stores @a __c in that position, increments
+ * the position, and returns @c traits::to_int_type(__c). If a write
+ * position is not available, returns @c overflow(__c).
*/
int_type
sputc(char_type __c)
/**
* @brief Entry point for all single-character output functions.
- * @param s A buffer read area.
- * @param n A count.
+ * @param __s A buffer read area.
+ * @param __n A count.
*
* One of two public output functions.
*
*
- * Returns xsputn(s,n). The effect is to write @a s[0] through
- * @a s[n-1] to the output sequence, if possible.
+ * Returns xsputn(__s,__n). The effect is to write @a __s[0] through
+ * @a __s[__n-1] to the output sequence, if possible.
*/
streamsize
sputn(const char_type* __s, streamsize __n)
/**
* @brief Moving the read position.
- * @param n The delta by which to move.
+ * @param __n The delta by which to move.
*
* This just advances the read position without returning any data.
*/
/**
* @brief Setting the three read area pointers.
- * @param gbeg A pointer.
- * @param gnext A pointer.
- * @param gend A pointer.
- * @post @a gbeg == @c eback(), @a gnext == @c gptr(), and
- * @a gend == @c egptr()
+ * @param __gbeg A pointer.
+ * @param __gnext A pointer.
+ * @param __gend A pointer.
+ * @post @a __gbeg == @c eback(), @a __gnext == @c gptr(), and
+ * @a __gend == @c egptr()
*/
void
setg(char_type* __gbeg, char_type* __gnext, char_type* __gend)
/**
* @brief Moving the write position.
- * @param n The delta by which to move.
+ * @param __n The delta by which to move.
*
* This just advances the write position without returning any data.
*/
/**
* @brief Setting the three write area pointers.
- * @param pbeg A pointer.
- * @param pend A pointer.
- * @post @a pbeg == @c pbase(), @a pbeg == @c pptr(), and
- * @a pend == @c epptr()
+ * @param __pbeg A pointer.
+ * @param __pend A pointer.
+ * @post @a __pbeg == @c pbase(), @a __pbeg == @c pptr(), and
+ * @a __pend == @c epptr()
*/
void
setp(char_type* __pbeg, char_type* __pend)
// [27.5.2.4.1] locales
/**
* @brief Changes translations.
- * @param loc A new locale.
+ * @param __loc A new locale.
*
* Translations done during I/O which depend on the current
* locale are changed by this call. The standard adds,
* @note Base class version does nothing.
*/
virtual void
- imbue(const locale&)
+ imbue(const locale& __loc)
{ }
// [27.5.2.4.2] buffer management and positioning
/**
* @brief Multiple character extraction.
- * @param s A buffer area.
- * @param n Maximum number of characters to assign.
+ * @param __s A buffer area.
+ * @param __n Maximum number of characters to assign.
* @return The number of characters assigned.
*
- * Fills @a s[0] through @a s[n-1] with characters from the input
- * sequence, as if by @c sbumpc(). Stops when either @a n characters
+ * Fills @a __s[0] through @a __s[__n-1] with characters from the input
+ * sequence, as if by @c sbumpc(). Stops when either @a __n characters
* have been copied, or when @c traits::eof() would be copied.
*
* It is expected that derived classes provide a more efficient
// [27.5.2.4.4] putback
/**
* @brief Tries to back up the input sequence.
- * @param c The character to be inserted back into the sequence.
+ * @param __c The character to be inserted back into the sequence.
* @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().
* @note Base class version does nothing, returns eof().
*/
virtual int_type
- pbackfail(int_type /* __c */ = traits_type::eof())
+ pbackfail(int_type __c = traits_type::eof())
{ return traits_type::eof(); }
// Put area:
/**
* @brief Multiple character insertion.
- * @param s A buffer area.
- * @param n Maximum number of characters to write.
+ * @param __s A buffer area.
+ * @param __n Maximum number of characters to write.
* @return The number of characters written.
*
- * Writes @a s[0] through @a s[n-1] to the output sequence, as if
+ * Writes @a __s[0] through @a __s[__n-1] to the output sequence, as if
* by @c sputc(). Stops when either @a n characters have been
* copied, or when @c sputc() would return @c traits::eof().
*
/**
* @brief Consumes data from the buffer; writes to the
* controlled sequence.
- * @param c An additional character to consume.
+ * @param __c An additional character to consume.
* @return eof() to indicate failure, something else (usually
- * @a c, or not_eof())
+ * @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
* <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().
+ * written out, if @a __c is not @c eof().
*
* For a formal definition of this function, see a good text
* such as Langer & Kreft, or [27.5.2.4.5]/3-7.
* @note Base class version does nothing, returns eof().
*/
virtual int_type
- overflow(int_type /* __c */ = traits_type::eof())
+ overflow(int_type __c = traits_type::eof())
{ return traits_type::eof(); }
#if _GLIBCXX_USE_DEPRECATED
* one-dimensional array from which different multidimensional subsets can
* be accessed and modified.
*
- * @param Tp Type of object in the array.
+ * @tparam _Tp Type of object in the array.
*/
template<class _Tp>
class valarray
*
* Assign elements of array to values in @a v.
*
- * @param v Valarray to get values from.
+ * @param __v Valarray to get values from.
*/
- valarray<_Tp>& operator=(const valarray<_Tp>&);
+ valarray<_Tp>& operator=(const valarray<_Tp>& __v);
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
*
* Move assign elements of array to values in @a v.
*
- * @param v Valarray to get values from.
+ * @param __v Valarray to get values from.
*/
- valarray<_Tp>& operator=(valarray<_Tp>&&) noexcept;
+ valarray<_Tp>& operator=(valarray<_Tp>&& __v) noexcept;
#endif
/**
*
* Assign all elements of array to @a t.
*
- * @param t Value for elements.
+ * @param __t Value for elements.
*/
- valarray<_Tp>& operator=(const _Tp&);
+ valarray<_Tp>& operator=(const _Tp& __t);
/**
* @brief Assign elements to an array subset.
* Assign elements of array to values in @a sa. Results are undefined
* if @a sa does not have the same size as this array.
*
- * @param sa Array slice to get values from.
+ * @param __sa Array slice to get values from.
*/
- valarray<_Tp>& operator=(const slice_array<_Tp>&);
+ valarray<_Tp>& operator=(const slice_array<_Tp>& __sa);
/**
* @brief Assign elements to an array subset.
* Assign elements of array to values in @a ga. Results are undefined
* if @a ga does not have the same size as this array.
*
- * @param ga Array slice to get values from.
+ * @param __ga Array slice to get values from.
*/
- valarray<_Tp>& operator=(const gslice_array<_Tp>&);
+ valarray<_Tp>& operator=(const gslice_array<_Tp>& __ga);
/**
* @brief Assign elements to an array subset.
* Assign elements of array to values in @a ma. Results are undefined
* if @a ma does not have the same size as this array.
*
- * @param ma Array slice to get values from.
+ * @param __ma Array slice to get values from.
*/
- valarray<_Tp>& operator=(const mask_array<_Tp>&);
+ valarray<_Tp>& operator=(const mask_array<_Tp>& __ma);
/**
* @brief Assign elements to an array subset.
* Assign elements of array to values in @a ia. Results are undefined
* if @a ia does not have the same size as this array.
*
- * @param ia Array slice to get values from.
+ * @param __ia Array slice to get values from.
*/
- valarray<_Tp>& operator=(const indirect_array<_Tp>&);
+ valarray<_Tp>& operator=(const indirect_array<_Tp>& __ia);
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Assign elements to an initializer_list.
*
- * Assign elements of array to values in @a l. Results are undefined
- * if @a l does not have the same size as this array.
+ * Assign elements of array to values in @a __l. Results are undefined
+ * if @a __l does not have the same size as this array.
*
- * @param l initializer_list to get values from.
+ * @param __l initializer_list to get values from.
*/
- valarray& operator=(initializer_list<_Tp>);
+ valarray& operator=(initializer_list<_Tp> __l);
#endif
template<class _Dom> valarray<_Tp>&
/**
* Return a reference to the i'th array element.
*
- * @param i Index of element to return.
+ * @param __i Index of element to return.
* @return Reference to the i'th element.
*/
- _Tp& operator[](size_t);
+ _Tp& operator[](size_t __i);
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// 389. Const overload of valarray::operator[] returns by value.
* indicated by the slice argument. The new valarray has the same size
* as the input slice. @see slice.
*
- * @param s The source slice.
- * @return New valarray containing elements in @a s.
+ * @param __s The source slice.
+ * @return New valarray containing elements in @a __s.
*/
- _Expr<_SClos<_ValArray, _Tp>, _Tp> operator[](slice) const;
+ _Expr<_SClos<_ValArray, _Tp>, _Tp> operator[](slice __s) const;
/**
* @brief Return a reference to an array subset.
* indicated by the slice argument. The new valarray has the same size
* as the input slice. @see slice.
*
- * @param s The source slice.
- * @return New valarray containing elements in @a s.
+ * @param __s The source slice.
+ * @return New valarray containing elements in @a __s.
*/
- slice_array<_Tp> operator[](slice);
+ slice_array<_Tp> operator[](slice __s);
/**
* @brief Return an array subset.
* Returns a slice_array referencing the elements of the array
* indicated by the slice argument. @see gslice.
*
- * @param s The source slice.
- * @return Slice_array referencing elements indicated by @a s.
+ * @param __s The source slice.
+ * @return Slice_array referencing elements indicated by @a __s.
*/
- _Expr<_GClos<_ValArray, _Tp>, _Tp> operator[](const gslice&) const;
+ _Expr<_GClos<_ValArray, _Tp>, _Tp> operator[](const gslice& __s) const;
/**
* @brief Return a reference to an array subset.
* indicated by the gslice argument. The new valarray has
* the same size as the input gslice. @see gslice.
*
- * @param s The source gslice.
- * @return New valarray containing elements in @a s.
+ * @param __s The source gslice.
+ * @return New valarray containing elements in @a __s.
*/
- gslice_array<_Tp> operator[](const gslice&);
+ gslice_array<_Tp> operator[](const gslice& __s);
/**
* @brief Return an array subset.
* the new valarray. Each element of the array is added to the return
* valarray if the corresponding element of the argument is true.
*
- * @param m The valarray bitmask.
- * @return New valarray containing elements indicated by @a m.
+ * @param __m The valarray bitmask.
+ * @return New valarray containing elements indicated by @a __m.
*/
- valarray<_Tp> operator[](const valarray<bool>&) const;
+ valarray<_Tp> operator[](const valarray<bool>& __m) const;
/**
* @brief Return a reference to an array subset.
* subset. Elements of the array are part of the subset if the
* corresponding element of the argument is true.
*
- * @param m The valarray bitmask.
- * @return New valarray containing elements indicated by @a m.
+ * @param __m The valarray bitmask.
+ * @return New valarray containing elements indicated by @a __m.
*/
- mask_array<_Tp> operator[](const valarray<bool>&);
+ mask_array<_Tp> operator[](const valarray<bool>& __m);
/**
* @brief Return an array subset.
* interpreted as the indices of elements of this valarray to copy to
* the return valarray.
*
- * @param i The valarray element index list.
- * @return New valarray containing elements in @a s.
+ * @param __i The valarray element index list.
+ * @return New valarray containing elements in @a __s.
*/
_Expr<_IClos<_ValArray, _Tp>, _Tp>
- operator[](const valarray<size_t>&) const;
+ operator[](const valarray<size_t>& __i) const;
/**
* @brief Return a reference to an array subset.
* in the subset. The returned indirect_array refers to these
* elements.
*
- * @param i The valarray element index list.
- * @return Indirect_array referencing elements in @a i.
+ * @param __i The valarray element index list.
+ * @return Indirect_array referencing elements in @a __i.
*/
- indirect_array<_Tp> operator[](const valarray<size_t>&);
+ indirect_array<_Tp> operator[](const valarray<size_t>& __i);
// _lib.valarray.unary_ unary operators:
/// Return a new valarray by applying unary + to each element.
* Positive arguments shift toward index 0, discarding elements [0, n).
* Negative arguments discard elements from the top of the array.
*
- * @param n Number of element positions to shift.
+ * @param __n Number of element positions to shift.
* @return New valarray with elements in shifted positions.
*/
- valarray<_Tp> shift (int) const;
+ valarray<_Tp> shift (int __n) const;
/**
* @brief Return a rotated array.
* Positive arguments shift toward index 0, wrapping around the top.
* Negative arguments shift towards the top, wrapping around to 0.
*
- * @param n Number of element positions to rotate.
+ * @param __n Number of element positions to rotate.
* @return New valarray with elements in shifted positions.
*/
- valarray<_Tp> cshift(int) const;
+ valarray<_Tp> cshift(int __n) const;
/**
* @brief Apply a function to the array.
* Resize this array to @a size and set all elements to @a c. All
* references and iterators are invalidated.
*
- * @param size New array size.
- * @param c New value for all elements.
+ * @param __size New array size.
+ * @param __c New value for all elements.
*/
void resize(size_t __size, _Tp __c = _Tp());
/**
* @brief Return an iterator pointing to the first element of
* the valarray.
- * @param va valarray.
+ * @param __va valarray.
*/
template<class _Tp>
inline _Tp*
/**
* @brief Return an iterator pointing to the first element of
* the const valarray.
- * @param va valarray.
+ * @param __va valarray.
*/
template<class _Tp>
inline const _Tp*
/**
* @brief Return an iterator pointing to one past the last element of
* the valarray.
- * @param va valarray.
+ * @param __va valarray.
*/
template<class _Tp>
inline _Tp*
/**
* @brief Return an iterator pointing to one past the last element of
* the const valarray.
- * @param va valarray.
+ * @param __va valarray.
*/
template<class _Tp>
inline const _Tp*
/**
* @brief Return an iterator pointing to the first element of
* the initilizer_list.
- * @param il Initializer list.
+ * @param __ils Initializer list.
*/
template<class _Tp>
constexpr const _Tp*
/**
* @brief Return an iterator pointing to one past the last element
* of the initilizer_list.
- * @param il Initializer list.
+ * @param __ils Initializer list.
*/
template<class _Tp>
constexpr const _Tp*
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1497 }
+// { dg-error "no matching" "" { target *-*-* } 1498 }
#include <list>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1453 }
+// { dg-error "no matching" "" { target *-*-* } 1454 }
#include <list>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1453 }
+// { dg-error "no matching" "" { target *-*-* } 1454 }
#include <list>
#include <utility>
// <http://www.gnu.org/licenses/>.
// { dg-do compile }
-// { dg-error "no matching" "" { target *-*-* } 1453 }
+// { dg-error "no matching" "" { target *-*-* } 1454 }
#include <list>
projects / gcc.git / commitdiff