libstdc++-v3/include/bits/stl_algo.h

   1 // Algorithm implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  35  * Permission to use, copy, modify, distribute and sell this software
  36  * and its documentation for any purpose is hereby granted without fee,
  37  * provided that the above copyright notice appear in all copies and
  38  * that both that copyright notice and this permission notice appear
  39  * in supporting documentation.  Hewlett-Packard Company makes no
  40  * representations about the suitability of this software for any
  41  * purpose.  It is provided "as is" without express or implied warranty.
  42  *
  43  *
  44  * Copyright (c) 1996
  45  * Silicon Graphics Computer Systems, Inc.
  46  *
  47  * Permission to use, copy, modify, distribute and sell this software
  48  * and its documentation for any purpose is hereby granted without fee,
  49  * provided that the above copyright notice appear in all copies and
  50  * that both that copyright notice and this permission notice appear
  51  * in supporting documentation.  Silicon Graphics makes no
  52  * representations about the suitability of this software for any
  53  * purpose.  It is provided "as is" without express or implied warranty.
  54  */
  55
  56 /** @file stl_algo.h
  57  *  This is an internal header file, included by other library headers.
  58  *  You should not attempt to use it directly.
  59  */
  60
  61 #ifndef _ALGO_H
  62 #define _ALGO_H 1
  63
  64 #include <bits/stl_heap.h>
  65 #include <bits/stl_tempbuf.h>     // for _Temporary_buffer
  66 #include <debug/debug.h>
  67
  68 // See concept_check.h for the __glibcxx_*_requires macros.
  69
  70 namespace std
  71 {
  72   /**
  73    *  @brief Find the median of three values.
  74    *  @param  a  A value.
  75    *  @param  b  A value.
  76    *  @param  c  A value.
  77    *  @return One of @p a, @p b or @p c.
  78    *
  79    *  If @c {l,m,n} is some convolution of @p {a,b,c} such that @c l<=m<=n
  80    *  then the value returned will be @c m.
  81    *  This is an SGI extension.
  82    *  @ingroup SGIextensions
  83   */
  84   template<typename _Tp>
  85     inline const _Tp&
  86     __median(const _Tp& __a, const _Tp& __b, const _Tp& __c)
  87     {
  88       // concept requirements
  89       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
  90       if (__a < __b)
  91         if (__b < __c)
  92           return __b;
  93         else if (__a < __c)
  94           return __c;
  95         else
  96           return __a;
  97       else if (__a < __c)
  98         return __a;
  99       else if (__b < __c)
 100         return __c;
 101       else
 102         return __b;
 103     }
 104
 105   /**
 106    *  @brief Find the median of three values using a predicate for comparison.
 107    *  @param  a     A value.
 108    *  @param  b     A value.
 109    *  @param  c     A value.
 110    *  @param  comp  A binary predicate.
 111    *  @return One of @p a, @p b or @p c.
 112    *
 113    *  If @c {l,m,n} is some convolution of @p {a,b,c} such that @p comp(l,m)
 114    *  and @p comp(m,n) are both true then the value returned will be @c m.
 115    *  This is an SGI extension.
 116    *  @ingroup SGIextensions
 117   */
 118   template<typename _Tp, typename _Compare>
 119     inline const _Tp&
 120     __median(const _Tp& __a, const _Tp& __b, const _Tp& __c, _Compare __comp)
 121     {
 122       // concept requirements
 123       __glibcxx_function_requires(_BinaryFunctionConcept<_Compare,bool,_Tp,_Tp>)
 124       if (__comp(__a, __b))
 125         if (__comp(__b, __c))
 126           return __b;
 127         else if (__comp(__a, __c))
 128           return __c;
 129         else
 130           return __a;
 131       else if (__comp(__a, __c))
 132         return __a;
 133       else if (__comp(__b, __c))
 134         return __c;
 135       else
 136         return __b;
 137     }
 138
 139   /**
 140    *  @brief Apply a function to every element of a sequence.
 141    *  @param  first  An input iterator.
 142    *  @param  last   An input iterator.
 143    *  @param  f      A unary function object.
 144    *  @return   @p f.
 145    *
 146    *  Applies the function object @p f to each element in the range
 147    *  @p [first,last).  @p f must not modify the order of the sequence.
 148    *  If @p f has a return value it is ignored.
 149   */
 150   template<typename _InputIterator, typename _Function>
 151     _Function
 152     for_each(_InputIterator __first, _InputIterator __last, _Function __f)
 153     {
 154       // concept requirements
 155       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 156       __glibcxx_requires_valid_range(__first, __last);
 157       for ( ; __first != __last; ++__first)
 158         __f(*__first);
 159       return __f;
 160     }
 161
 162   /**
 163    *  @if maint
 164    *  This is an overload used by find() for the Input Iterator case.
 165    *  @endif
 166   */
 167   template<typename _InputIterator, typename _Tp>
 168     inline _InputIterator
 169     find(_InputIterator __first, _InputIterator __last,
 170          const _Tp& __val, input_iterator_tag)
 171     {
 172       while (__first != __last && !(*__first == __val))
 173         ++__first;
 174       return __first;
 175     }
 176
 177   /**
 178    *  @if maint
 179    *  This is an overload used by find_if() for the Input Iterator case.
 180    *  @endif
 181   */
 182   template<typename _InputIterator, typename _Predicate>
 183     inline _InputIterator
 184     find_if(_InputIterator __first, _InputIterator __last,
 185             _Predicate __pred, input_iterator_tag)
 186     {
 187       while (__first != __last && !__pred(*__first))
 188         ++__first;
 189       return __first;
 190     }
 191
 192   /**
 193    *  @if maint
 194    *  This is an overload used by find() for the RAI case.
 195    *  @endif
 196   */
 197   template<typename _RandomAccessIterator, typename _Tp>
 198     _RandomAccessIterator
 199     find(_RandomAccessIterator __first, _RandomAccessIterator __last,
 200          const _Tp& __val, random_access_iterator_tag)
 201     {
 202       typename iterator_traits<_RandomAccessIterator>::difference_type
 203         __trip_count = (__last - __first) >> 2;
 204
 205       for ( ; __trip_count > 0 ; --__trip_count)
 206         {
 207           if (*__first == __val)
 208             return __first;
 209           ++__first;
 210
 211           if (*__first == __val)
 212             return __first;
 213           ++__first;
 214
 215           if (*__first == __val)
 216             return __first;
 217           ++__first;
 218
 219           if (*__first == __val)
 220             return __first;
 221           ++__first;
 222         }
 223
 224       switch (__last - __first)
 225         {
 226         case 3:
 227           if (*__first == __val)
 228             return __first;
 229           ++__first;
 230         case 2:
 231           if (*__first == __val)
 232             return __first;
 233           ++__first;
 234         case 1:
 235           if (*__first == __val)
 236             return __first;
 237           ++__first;
 238         case 0:
 239         default:
 240           return __last;
 241         }
 242     }
 243
 244   /**
 245    *  @if maint
 246    *  This is an overload used by find_if() for the RAI case.
 247    *  @endif
 248   */
 249   template<typename _RandomAccessIterator, typename _Predicate>
 250     _RandomAccessIterator
 251     find_if(_RandomAccessIterator __first, _RandomAccessIterator __last,
 252             _Predicate __pred, random_access_iterator_tag)
 253     {
 254       typename iterator_traits<_RandomAccessIterator>::difference_type
 255         __trip_count = (__last - __first) >> 2;
 256
 257       for ( ; __trip_count > 0 ; --__trip_count)
 258         {
 259           if (__pred(*__first))
 260             return __first;
 261           ++__first;
 262
 263           if (__pred(*__first))
 264             return __first;
 265           ++__first;
 266
 267           if (__pred(*__first))
 268             return __first;
 269           ++__first;
 270
 271           if (__pred(*__first))
 272             return __first;
 273           ++__first;
 274         }
 275
 276       switch (__last - __first)
 277         {
 278         case 3:
 279           if (__pred(*__first))
 280             return __first;
 281           ++__first;
 282         case 2:
 283           if (__pred(*__first))
 284             return __first;
 285           ++__first;
 286         case 1:
 287           if (__pred(*__first))
 288             return __first;
 289           ++__first;
 290         case 0:
 291         default:
 292           return __last;
 293         }
 294     }
 295
 296   /**
 297    *  @brief Find the first occurrence of a value in a sequence.
 298    *  @param  first  An input iterator.
 299    *  @param  last   An input iterator.
 300    *  @param  val    The value to find.
 301    *  @return   The first iterator @c i in the range @p [first,last)
 302    *  such that @c *i == @p val, or @p last if no such iterator exists.
 303   */
 304   template<typename _InputIterator, typename _Tp>
 305     inline _InputIterator
 306     find(_InputIterator __first, _InputIterator __last,
 307          const _Tp& __val)
 308     {
 309       // concept requirements
 310       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 311       __glibcxx_function_requires(_EqualOpConcept<
 312                 typename iterator_traits<_InputIterator>::value_type, _Tp>)
 313       __glibcxx_requires_valid_range(__first, __last);
 314       return std::find(__first, __last, __val,
 315                        std::__iterator_category(__first));
 316     }
 317
 318   /**
 319    *  @brief Find the first element in a sequence for which a predicate is true.
 320    *  @param  first  An input iterator.
 321    *  @param  last   An input iterator.
 322    *  @param  pred   A predicate.
 323    *  @return   The first iterator @c i in the range @p [first,last)
 324    *  such that @p pred(*i) is true, or @p last if no such iterator exists.
 325   */
 326   template<typename _InputIterator, typename _Predicate>
 327     inline _InputIterator
 328     find_if(_InputIterator __first, _InputIterator __last,
 329             _Predicate __pred)
 330     {
 331       // concept requirements
 332       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 333       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
 334               typename iterator_traits<_InputIterator>::value_type>)
 335       __glibcxx_requires_valid_range(__first, __last);
 336       return std::find_if(__first, __last, __pred,
 337                           std::__iterator_category(__first));
 338     }
 339
 340   /**
 341    *  @brief Find two adjacent values in a sequence that are equal.
 342    *  @param  first  A forward iterator.
 343    *  @param  last   A forward iterator.
 344    *  @return   The first iterator @c i such that @c i and @c i+1 are both
 345    *  valid iterators in @p [first,last) and such that @c *i == @c *(i+1),
 346    *  or @p last if no such iterator exists.
 347   */
 348   template<typename _ForwardIterator>
 349     _ForwardIterator
 350     adjacent_find(_ForwardIterator __first, _ForwardIterator __last)
 351     {
 352       // concept requirements
 353       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
 354       __glibcxx_function_requires(_EqualityComparableConcept<
 355             typename iterator_traits<_ForwardIterator>::value_type>)
 356       __glibcxx_requires_valid_range(__first, __last);
 357       if (__first == __last)
 358         return __last;
 359       _ForwardIterator __next = __first;
 360       while(++__next != __last)
 361         {
 362           if (*__first == *__next)
 363             return __first;
 364           __first = __next;
 365         }
 366       return __last;
 367     }
 368
 369   /**
 370    *  @brief Find two adjacent values in a sequence using a predicate.
 371    *  @param  first         A forward iterator.
 372    *  @param  last          A forward iterator.
 373    *  @param  binary_pred   A binary predicate.
 374    *  @return   The first iterator @c i such that @c i and @c i+1 are both
 375    *  valid iterators in @p [first,last) and such that
 376    *  @p binary_pred(*i,*(i+1)) is true, or @p last if no such iterator
 377    *  exists.
 378   */
 379   template<typename _ForwardIterator, typename _BinaryPredicate>
 380     _ForwardIterator
 381     adjacent_find(_ForwardIterator __first, _ForwardIterator __last,
 382                   _BinaryPredicate __binary_pred)
 383     {
 384       // concept requirements
 385       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
 386       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
 387             typename iterator_traits<_ForwardIterator>::value_type,
 388             typename iterator_traits<_ForwardIterator>::value_type>)
 389       __glibcxx_requires_valid_range(__first, __last);
 390       if (__first == __last)
 391         return __last;
 392       _ForwardIterator __next = __first;
 393       while(++__next != __last)
 394         {
 395           if (__binary_pred(*__first, *__next))
 396             return __first;
 397           __first = __next;
 398         }
 399       return __last;
 400     }
 401
 402   /**
 403    *  @brief Count the number of copies of a value in a sequence.
 404    *  @param  first  An input iterator.
 405    *  @param  last   An input iterator.
 406    *  @param  value  The value to be counted.
 407    *  @return   The number of iterators @c i in the range @p [first,last)
 408    *  for which @c *i == @p value
 409   */
 410   template<typename _InputIterator, typename _Tp>
 411     typename iterator_traits<_InputIterator>::difference_type
 412     count(_InputIterator __first, _InputIterator __last, const _Tp& __value)
 413     {
 414       // concept requirements
 415       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 416       __glibcxx_function_requires(_EqualOpConcept<
 417         typename iterator_traits<_InputIterator>::value_type, _Tp>)
 418       __glibcxx_requires_valid_range(__first, __last);
 419       typename iterator_traits<_InputIterator>::difference_type __n = 0;
 420       for ( ; __first != __last; ++__first)
 421         if (*__first == __value)
 422           ++__n;
 423       return __n;
 424     }
 425
 426   /**
 427    *  @brief Count the elements of a sequence for which a predicate is true.
 428    *  @param  first  An input iterator.
 429    *  @param  last   An input iterator.
 430    *  @param  pred   A predicate.
 431    *  @return   The number of iterators @c i in the range @p [first,last)
 432    *  for which @p pred(*i) is true.
 433   */
 434   template<typename _InputIterator, typename _Predicate>
 435     typename iterator_traits<_InputIterator>::difference_type
 436     count_if(_InputIterator __first, _InputIterator __last, _Predicate __pred)
 437     {
 438       // concept requirements
 439       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 440       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
 441             typename iterator_traits<_InputIterator>::value_type>)
 442       __glibcxx_requires_valid_range(__first, __last);
 443       typename iterator_traits<_InputIterator>::difference_type __n = 0;
 444       for ( ; __first != __last; ++__first)
 445         if (__pred(*__first))
 446           ++__n;
 447       return __n;
 448     }
 449
 450   /**
 451    *  @brief Search a sequence for a matching sub-sequence.
 452    *  @param  first1  A forward iterator.
 453    *  @param  last1   A forward iterator.
 454    *  @param  first2  A forward iterator.
 455    *  @param  last2   A forward iterator.
 456    *  @return   The first iterator @c i in the range
 457    *  @p [first1,last1-(last2-first2)) such that @c *(i+N) == @p *(first2+N)
 458    *  for each @c N in the range @p [0,last2-first2), or @p last1 if no
 459    *  such iterator exists.
 460    *
 461    *  Searches the range @p [first1,last1) for a sub-sequence that compares
 462    *  equal value-by-value with the sequence given by @p [first2,last2) and
 463    *  returns an iterator to the first element of the sub-sequence, or
 464    *  @p last1 if the sub-sequence is not found.
 465    *
 466    *  Because the sub-sequence must lie completely within the range
 467    *  @p [first1,last1) it must start at a position less than
 468    *  @p last1-(last2-first2) where @p last2-first2 is the length of the
 469    *  sub-sequence.
 470    *  This means that the returned iterator @c i will be in the range
 471    *  @p [first1,last1-(last2-first2))
 472   */
 473   template<typename _ForwardIterator1, typename _ForwardIterator2>
 474     _ForwardIterator1
 475     search(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
 476            _ForwardIterator2 __first2, _ForwardIterator2 __last2)
 477     {
 478       // concept requirements
 479       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
 480       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
 481       __glibcxx_function_requires(_EqualOpConcept<
 482             typename iterator_traits<_ForwardIterator1>::value_type,
 483             typename iterator_traits<_ForwardIterator2>::value_type>)
 484       __glibcxx_requires_valid_range(__first1, __last1);
 485       __glibcxx_requires_valid_range(__first2, __last2);
 486       // Test for empty ranges
 487       if (__first1 == __last1 || __first2 == __last2)
 488         return __first1;
 489
 490       // Test for a pattern of length 1.
 491       _ForwardIterator2 __tmp(__first2);
 492       ++__tmp;
 493       if (__tmp == __last2)
 494         return std::find(__first1, __last1, *__first2);
 495
 496       // General case.
 497       _ForwardIterator2 __p1, __p;
 498       __p1 = __first2; ++__p1;
 499       _ForwardIterator1 __current = __first1;
 500
 501       while (__first1 != __last1)
 502         {
 503           __first1 = std::find(__first1, __last1, *__first2);
 504           if (__first1 == __last1)
 505             return __last1;
 506
 507           __p = __p1;
 508           __current = __first1;
 509           if (++__current == __last1)
 510             return __last1;
 511
 512           while (*__current == *__p)
 513             {
 514               if (++__p == __last2)
 515                 return __first1;
 516               if (++__current == __last1)
 517                 return __last1;
 518             }
 519           ++__first1;
 520         }
 521       return __first1;
 522     }
 523
 524   /**
 525    *  @brief Search a sequence for a matching sub-sequence using a predicate.
 526    *  @param  first1     A forward iterator.
 527    *  @param  last1      A forward iterator.
 528    *  @param  first2     A forward iterator.
 529    *  @param  last2      A forward iterator.
 530    *  @param  predicate  A binary predicate.
 531    *  @return   The first iterator @c i in the range
 532    *  @p [first1,last1-(last2-first2)) such that
 533    *  @p predicate(*(i+N),*(first2+N)) is true for each @c N in the range
 534    *  @p [0,last2-first2), or @p last1 if no such iterator exists.
 535    *
 536    *  Searches the range @p [first1,last1) for a sub-sequence that compares
 537    *  equal value-by-value with the sequence given by @p [first2,last2),
 538    *  using @p predicate to determine equality, and returns an iterator
 539    *  to the first element of the sub-sequence, or @p last1 if no such
 540    *  iterator exists.
 541    *
 542    *  @see search(_ForwardIter1, _ForwardIter1, _ForwardIter2, _ForwardIter2)
 543   */
 544   template<typename _ForwardIterator1, typename _ForwardIterator2,
 545            typename _BinaryPredicate>
 546     _ForwardIterator1
 547     search(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
 548            _ForwardIterator2 __first2, _ForwardIterator2 __last2,
 549            _BinaryPredicate  __predicate)
 550     {
 551       // concept requirements
 552       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
 553       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
 554       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
 555             typename iterator_traits<_ForwardIterator1>::value_type,
 556             typename iterator_traits<_ForwardIterator2>::value_type>)
 557       __glibcxx_requires_valid_range(__first1, __last1);
 558       __glibcxx_requires_valid_range(__first2, __last2);
 559
 560       // Test for empty ranges
 561       if (__first1 == __last1 || __first2 == __last2)
 562         return __first1;
 563
 564       // Test for a pattern of length 1.
 565       _ForwardIterator2 __tmp(__first2);
 566       ++__tmp;
 567       if (__tmp == __last2)
 568         {
 569           while (__first1 != __last1 && !__predicate(*__first1, *__first2))
 570             ++__first1;
 571           return __first1;
 572         }
 573
 574       // General case.
 575       _ForwardIterator2 __p1, __p;
 576       __p1 = __first2; ++__p1;
 577       _ForwardIterator1 __current = __first1;
 578
 579       while (__first1 != __last1)
 580         {
 581           while (__first1 != __last1)
 582             {
 583               if (__predicate(*__first1, *__first2))
 584                 break;
 585               ++__first1;
 586             }
 587           while (__first1 != __last1 && !__predicate(*__first1, *__first2))
 588             ++__first1;
 589           if (__first1 == __last1)
 590             return __last1;
 591
 592           __p = __p1;
 593           __current = __first1;
 594           if (++__current == __last1)
 595             return __last1;
 596
 597           while (__predicate(*__current, *__p))
 598             {
 599               if (++__p == __last2)
 600                 return __first1;
 601               if (++__current == __last1)
 602                 return __last1;
 603             }
 604           ++__first1;
 605         }
 606       return __first1;
 607     }
 608
 609   /**
 610    *  @brief Search a sequence for a number of consecutive values.
 611    *  @param  first  A forward iterator.
 612    *  @param  last   A forward iterator.
 613    *  @param  count  The number of consecutive values.
 614    *  @param  val    The value to find.
 615    *  @return   The first iterator @c i in the range @p [first,last-count)
 616    *  such that @c *(i+N) == @p val for each @c N in the range @p [0,count),
 617    *  or @p last if no such iterator exists.
 618    *
 619    *  Searches the range @p [first,last) for @p count consecutive elements
 620    *  equal to @p val.
 621   */
 622   template<typename _ForwardIterator, typename _Integer, typename _Tp>
 623     _ForwardIterator
 624     search_n(_ForwardIterator __first, _ForwardIterator __last,
 625              _Integer __count, const _Tp& __val)
 626     {
 627       // concept requirements
 628       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
 629       __glibcxx_function_requires(_EqualOpConcept<
 630         typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
 631       __glibcxx_requires_valid_range(__first, __last);
 632
 633       if (__count <= 0)
 634         return __first;
 635       else
 636         {
 637           __first = std::find(__first, __last, __val);
 638           while (__first != __last)
 639             {
 640               typename iterator_traits<_ForwardIterator>::difference_type
 641                 __n = __count;
 642               _ForwardIterator __i = __first;
 643               ++__i;
 644               while (__i != __last && __n != 1 && *__i == __val)
 645                 {
 646                   ++__i;
 647                   --__n;
 648                 }
 649               if (__n == 1)
 650                 return __first;
 651               else
 652                 __first = std::find(__i, __last, __val);
 653             }
 654           return __last;
 655         }
 656     }
 657
 658   /**
 659    *  @brief Search a sequence for a number of consecutive values using a
 660    *         predicate.
 661    *  @param  first        A forward iterator.
 662    *  @param  last         A forward iterator.
 663    *  @param  count        The number of consecutive values.
 664    *  @param  val          The value to find.
 665    *  @param  binary_pred  A binary predicate.
 666    *  @return   The first iterator @c i in the range @p [first,last-count)
 667    *  such that @p binary_pred(*(i+N),val) is true for each @c N in the
 668    *  range @p [0,count), or @p last if no such iterator exists.
 669    *
 670    *  Searches the range @p [first,last) for @p count consecutive elements
 671    *  for which the predicate returns true.
 672   */
 673   template<typename _ForwardIterator, typename _Integer, typename _Tp,
 674            typename _BinaryPredicate>
 675     _ForwardIterator
 676     search_n(_ForwardIterator __first, _ForwardIterator __last,
 677              _Integer __count, const _Tp& __val,
 678              _BinaryPredicate __binary_pred)
 679     {
 680       // concept requirements
 681       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
 682       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
 683             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
 684       __glibcxx_requires_valid_range(__first, __last);
 685
 686       if (__count <= 0)
 687         return __first;
 688       else
 689         {
 690           while (__first != __last)
 691             {
 692               if (__binary_pred(*__first, __val))
 693                 break;
 694               ++__first;
 695             }
 696           while (__first != __last)
 697             {
 698               typename iterator_traits<_ForwardIterator>::difference_type
 699                 __n = __count;
 700               _ForwardIterator __i = __first;
 701               ++__i;
 702               while (__i != __last && __n != 1 && __binary_pred(*__i, __val))
 703                 {
 704                   ++__i;
 705                   --__n;
 706                 }
 707               if (__n == 1)
 708                 return __first;
 709               else
 710                 {
 711                   while (__i != __last)
 712                     {
 713                       if (__binary_pred(*__i, __val))
 714                         break;
 715                       ++__i;
 716                     }
 717                   __first = __i;
 718                 }
 719             }
 720           return __last;
 721         }
 722     }
 723
 724   /**
 725    *  @brief Swap the elements of two sequences.
 726    *  @param  first1  A forward iterator.
 727    *  @param  last1   A forward iterator.
 728    *  @param  first2  A forward iterator.
 729    *  @return   An iterator equal to @p first2+(last1-first1).
 730    *
 731    *  Swaps each element in the range @p [first1,last1) with the
 732    *  corresponding element in the range @p [first2,(last1-first1)).
 733    *  The ranges must not overlap.
 734   */
 735   template<typename _ForwardIterator1, typename _ForwardIterator2>
 736     _ForwardIterator2
 737     swap_ranges(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
 738                 _ForwardIterator2 __first2)
 739     {
 740       // concept requirements
 741       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
 742                                   _ForwardIterator1>)
 743       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
 744                                   _ForwardIterator2>)
 745       __glibcxx_function_requires(_ConvertibleConcept<
 746             typename iterator_traits<_ForwardIterator1>::value_type,
 747             typename iterator_traits<_ForwardIterator2>::value_type>)
 748       __glibcxx_function_requires(_ConvertibleConcept<
 749             typename iterator_traits<_ForwardIterator2>::value_type,
 750             typename iterator_traits<_ForwardIterator1>::value_type>)
 751       __glibcxx_requires_valid_range(__first1, __last1);
 752
 753       for ( ; __first1 != __last1; ++__first1, ++__first2)
 754         std::iter_swap(__first1, __first2);
 755       return __first2;
 756     }
 757
 758   /**
 759    *  @brief Perform an operation on a sequence.
 760    *  @param  first     An input iterator.
 761    *  @param  last      An input iterator.
 762    *  @param  result    An output iterator.
 763    *  @param  unary_op  A unary operator.
 764    *  @return   An output iterator equal to @p result+(last-first).
 765    *
 766    *  Applies the operator to each element in the input range and assigns
 767    *  the results to successive elements of the output sequence.
 768    *  Evaluates @p *(result+N)=unary_op(*(first+N)) for each @c N in the
 769    *  range @p [0,last-first).
 770    *
 771    *  @p unary_op must not alter its argument.
 772   */
 773   template<typename _InputIterator, typename _OutputIterator,
 774            typename _UnaryOperation>
 775     _OutputIterator
 776     transform(_InputIterator __first, _InputIterator __last,
 777               _OutputIterator __result, _UnaryOperation __unary_op)
 778     {
 779       // concept requirements
 780       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 781       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
 782             // "the type returned by a _UnaryOperation"
 783             __typeof__(__unary_op(*__first))>)
 784       __glibcxx_requires_valid_range(__first, __last);
 785
 786       for ( ; __first != __last; ++__first, ++__result)
 787         *__result = __unary_op(*__first);
 788       return __result;
 789     }
 790
 791   /**
 792    *  @brief Perform an operation on corresponding elements of two sequences.
 793    *  @param  first1     An input iterator.
 794    *  @param  last1      An input iterator.
 795    *  @param  first2     An input iterator.
 796    *  @param  result     An output iterator.
 797    *  @param  binary_op  A binary operator.
 798    *  @return   An output iterator equal to @p result+(last-first).
 799    *
 800    *  Applies the operator to the corresponding elements in the two
 801    *  input ranges and assigns the results to successive elements of the
 802    *  output sequence.
 803    *  Evaluates @p *(result+N)=binary_op(*(first1+N),*(first2+N)) for each
 804    *  @c N in the range @p [0,last1-first1).
 805    *
 806    *  @p binary_op must not alter either of its arguments.
 807   */
 808   template<typename _InputIterator1, typename _InputIterator2,
 809            typename _OutputIterator, typename _BinaryOperation>
 810     _OutputIterator
 811     transform(_InputIterator1 __first1, _InputIterator1 __last1,
 812               _InputIterator2 __first2, _OutputIterator __result,
 813               _BinaryOperation __binary_op)
 814     {
 815       // concept requirements
 816       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
 817       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
 818       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
 819             // "the type returned by a _BinaryOperation"
 820             __typeof__(__binary_op(*__first1,*__first2))>)
 821       __glibcxx_requires_valid_range(__first1, __last1);
 822
 823       for ( ; __first1 != __last1; ++__first1, ++__first2, ++__result)
 824         *__result = __binary_op(*__first1, *__first2);
 825       return __result;
 826     }
 827
 828   /**
 829    *  @brief Replace each occurrence of one value in a sequence with another
 830    *         value.
 831    *  @param  first      A forward iterator.
 832    *  @param  last       A forward iterator.
 833    *  @param  old_value  The value to be replaced.
 834    *  @param  new_value  The replacement value.
 835    *  @return   replace() returns no value.
 836    *
 837    *  For each iterator @c i in the range @p [first,last) if @c *i ==
 838    *  @p old_value then the assignment @c *i = @p new_value is performed.
 839   */
 840   template<typename _ForwardIterator, typename _Tp>
 841     void
 842     replace(_ForwardIterator __first, _ForwardIterator __last,
 843             const _Tp& __old_value, const _Tp& __new_value)
 844     {
 845       // concept requirements
 846       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
 847                                   _ForwardIterator>)
 848       __glibcxx_function_requires(_EqualOpConcept<
 849             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
 850       __glibcxx_function_requires(_ConvertibleConcept<_Tp,
 851             typename iterator_traits<_ForwardIterator>::value_type>)
 852       __glibcxx_requires_valid_range(__first, __last);
 853
 854       for ( ; __first != __last; ++__first)
 855         if (*__first == __old_value)
 856           *__first = __new_value;
 857     }
 858
 859   /**
 860    *  @brief Replace each value in a sequence for which a predicate returns
 861    *         true with another value.
 862    *  @param  first      A forward iterator.
 863    *  @param  last       A forward iterator.
 864    *  @param  pred       A predicate.
 865    *  @param  new_value  The replacement value.
 866    *  @return   replace_if() returns no value.
 867    *
 868    *  For each iterator @c i in the range @p [first,last) if @p pred(*i)
 869    *  is true then the assignment @c *i = @p new_value is performed.
 870   */
 871   template<typename _ForwardIterator, typename _Predicate, typename _Tp>
 872     void
 873     replace_if(_ForwardIterator __first, _ForwardIterator __last,
 874                _Predicate __pred, const _Tp& __new_value)
 875     {
 876       // concept requirements
 877       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
 878                                   _ForwardIterator>)
 879       __glibcxx_function_requires(_ConvertibleConcept<_Tp,
 880             typename iterator_traits<_ForwardIterator>::value_type>)
 881       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
 882             typename iterator_traits<_ForwardIterator>::value_type>)
 883       __glibcxx_requires_valid_range(__first, __last);
 884
 885       for ( ; __first != __last; ++__first)
 886         if (__pred(*__first))
 887           *__first = __new_value;
 888     }
 889
 890   /**
 891    *  @brief Copy a sequence, replacing each element of one value with another
 892    *         value.
 893    *  @param  first      An input iterator.
 894    *  @param  last       An input iterator.
 895    *  @param  result     An output iterator.
 896    *  @param  old_value  The value to be replaced.
 897    *  @param  new_value  The replacement value.
 898    *  @return   The end of the output sequence, @p result+(last-first).
 899    *
 900    *  Copies each element in the input range @p [first,last) to the
 901    *  output range @p [result,result+(last-first)) replacing elements
 902    *  equal to @p old_value with @p new_value.
 903   */
 904   template<typename _InputIterator, typename _OutputIterator, typename _Tp>
 905     _OutputIterator
 906     replace_copy(_InputIterator __first, _InputIterator __last,
 907                  _OutputIterator __result,
 908                  const _Tp& __old_value, const _Tp& __new_value)
 909     {
 910       // concept requirements
 911       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 912       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
 913             typename iterator_traits<_InputIterator>::value_type>)
 914       __glibcxx_function_requires(_EqualOpConcept<
 915             typename iterator_traits<_InputIterator>::value_type, _Tp>)
 916       __glibcxx_requires_valid_range(__first, __last);
 917
 918       for ( ; __first != __last; ++__first, ++__result)
 919         *__result = *__first == __old_value ? __new_value : *__first;
 920       return __result;
 921     }
 922
 923   /**
 924    *  @brief Copy a sequence, replacing each value for which a predicate
 925    *         returns true with another value.
 926    *  @param  first      An input iterator.
 927    *  @param  last       An input iterator.
 928    *  @param  result     An output iterator.
 929    *  @param  pred       A predicate.
 930    *  @param  new_value  The replacement value.
 931    *  @return   The end of the output sequence, @p result+(last-first).
 932    *
 933    *  Copies each element in the range @p [first,last) to the range
 934    *  @p [result,result+(last-first)) replacing elements for which
 935    *  @p pred returns true with @p new_value.
 936   */
 937   template<typename _InputIterator, typename _OutputIterator,
 938            typename _Predicate, typename _Tp>
 939     _OutputIterator
 940     replace_copy_if(_InputIterator __first, _InputIterator __last,
 941                     _OutputIterator __result,
 942                     _Predicate __pred, const _Tp& __new_value)
 943     {
 944       // concept requirements
 945       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
 946       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
 947             typename iterator_traits<_InputIterator>::value_type>)
 948       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
 949             typename iterator_traits<_InputIterator>::value_type>)
 950       __glibcxx_requires_valid_range(__first, __last);
 951
 952       for ( ; __first != __last; ++__first, ++__result)
 953         *__result = __pred(*__first) ? __new_value : *__first;
 954       return __result;
 955     }
 956
 957   /**
 958    *  @brief Assign the result of a function object to each value in a
 959    *         sequence.
 960    *  @param  first  A forward iterator.
 961    *  @param  last   A forward iterator.
 962    *  @param  gen    A function object taking no arguments.
 963    *  @return   generate() returns no value.
 964    *
 965    *  Performs the assignment @c *i = @p gen() for each @c i in the range
 966    *  @p [first,last).
 967   */
 968   template<typename _ForwardIterator, typename _Generator>
 969     void
 970     generate(_ForwardIterator __first, _ForwardIterator __last,
 971              _Generator __gen)
 972     {
 973       // concept requirements
 974       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
 975       __glibcxx_function_requires(_GeneratorConcept<_Generator,
 976             typename iterator_traits<_ForwardIterator>::value_type>)
 977       __glibcxx_requires_valid_range(__first, __last);
 978
 979       for ( ; __first != __last; ++__first)
 980         *__first = __gen();
 981     }
 982
 983   /**
 984    *  @brief Assign the result of a function object to each value in a
 985    *         sequence.
 986    *  @param  first  A forward iterator.
 987    *  @param  n      The length of the sequence.
 988    *  @param  gen    A function object taking no arguments.
 989    *  @return   The end of the sequence, @p first+n
 990    *
 991    *  Performs the assignment @c *i = @p gen() for each @c i in the range
 992    *  @p [first,first+n).
 993   */
 994   template<typename _OutputIterator, typename _Size, typename _Generator>
 995     _OutputIterator
 996     generate_n(_OutputIterator __first, _Size __n, _Generator __gen)
 997     {
 998       // concept requirements
 999       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1000             // "the type returned by a _Generator"
1001             __typeof__(__gen())>)
1002
1003       for ( ; __n > 0; --__n, ++__first)
1004         *__first = __gen();
1005       return __first;
1006     }
1007
1008   /**
1009    *  @brief Copy a sequence, removing elements of a given value.
1010    *  @param  first   An input iterator.
1011    *  @param  last    An input iterator.
1012    *  @param  result  An output iterator.
1013    *  @param  value   The value to be removed.
1014    *  @return   An iterator designating the end of the resulting sequence.
1015    *
1016    *  Copies each element in the range @p [first,last) not equal to @p value
1017    *  to the range beginning at @p result.
1018    *  remove_copy() is stable, so the relative order of elements that are
1019    *  copied is unchanged.
1020   */
1021   template<typename _InputIterator, typename _OutputIterator, typename _Tp>
1022     _OutputIterator
1023     remove_copy(_InputIterator __first, _InputIterator __last,
1024                 _OutputIterator __result, const _Tp& __value)
1025     {
1026       // concept requirements
1027       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1028       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1029             typename iterator_traits<_InputIterator>::value_type>)
1030       __glibcxx_function_requires(_EqualOpConcept<
1031             typename iterator_traits<_InputIterator>::value_type, _Tp>)
1032       __glibcxx_requires_valid_range(__first, __last);
1033
1034       for ( ; __first != __last; ++__first)
1035         if (!(*__first == __value))
1036           {
1037             *__result = *__first;
1038             ++__result;
1039           }
1040       return __result;
1041     }
1042
1043   /**
1044    *  @brief Copy a sequence, removing elements for which a predicate is true.
1045    *  @param  first   An input iterator.
1046    *  @param  last    An input iterator.
1047    *  @param  result  An output iterator.
1048    *  @param  pred    A predicate.
1049    *  @return   An iterator designating the end of the resulting sequence.
1050    *
1051    *  Copies each element in the range @p [first,last) for which
1052    *  @p pred returns true to the range beginning at @p result.
1053    *
1054    *  remove_copy_if() is stable, so the relative order of elements that are
1055    *  copied is unchanged.
1056   */
1057   template<typename _InputIterator, typename _OutputIterator,
1058            typename _Predicate>
1059     _OutputIterator
1060     remove_copy_if(_InputIterator __first, _InputIterator __last,
1061                    _OutputIterator __result, _Predicate __pred)
1062     {
1063       // concept requirements
1064       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1065       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1066             typename iterator_traits<_InputIterator>::value_type>)
1067       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1068             typename iterator_traits<_InputIterator>::value_type>)
1069       __glibcxx_requires_valid_range(__first, __last);
1070
1071       for ( ; __first != __last; ++__first)
1072         if (!__pred(*__first))
1073           {
1074             *__result = *__first;
1075             ++__result;
1076           }
1077       return __result;
1078     }
1079
1080   /**
1081    *  @brief Remove elements from a sequence.
1082    *  @param  first  An input iterator.
1083    *  @param  last   An input iterator.
1084    *  @param  value  The value to be removed.
1085    *  @return   An iterator designating the end of the resulting sequence.
1086    *
1087    *  All elements equal to @p value are removed from the range
1088    *  @p [first,last).
1089    *
1090    *  remove() is stable, so the relative order of elements that are
1091    *  not removed is unchanged.
1092    *
1093    *  Elements between the end of the resulting sequence and @p last
1094    *  are still present, but their value is unspecified.
1095   */
1096   template<typename _ForwardIterator, typename _Tp>
1097     _ForwardIterator
1098     remove(_ForwardIterator __first, _ForwardIterator __last,
1099            const _Tp& __value)
1100     {
1101       // concept requirements
1102       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1103                                   _ForwardIterator>)
1104       __glibcxx_function_requires(_EqualOpConcept<
1105             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
1106       __glibcxx_requires_valid_range(__first, __last);
1107
1108       __first = std::find(__first, __last, __value);
1109       _ForwardIterator __i = __first;
1110       return __first == __last ? __first
1111                                : std::remove_copy(++__i, __last,
1112                                                   __first, __value);
1113     }
1114
1115   /**
1116    *  @brief Remove elements from a sequence using a predicate.
1117    *  @param  first  A forward iterator.
1118    *  @param  last   A forward iterator.
1119    *  @param  pred   A predicate.
1120    *  @return   An iterator designating the end of the resulting sequence.
1121    *
1122    *  All elements for which @p pred returns true are removed from the range
1123    *  @p [first,last).
1124    *
1125    *  remove_if() is stable, so the relative order of elements that are
1126    *  not removed is unchanged.
1127    *
1128    *  Elements between the end of the resulting sequence and @p last
1129    *  are still present, but their value is unspecified.
1130   */
1131   template<typename _ForwardIterator, typename _Predicate>
1132     _ForwardIterator
1133     remove_if(_ForwardIterator __first, _ForwardIterator __last,
1134               _Predicate __pred)
1135     {
1136       // concept requirements
1137       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1138                                   _ForwardIterator>)
1139       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1140             typename iterator_traits<_ForwardIterator>::value_type>)
1141       __glibcxx_requires_valid_range(__first, __last);
1142
1143       __first = std::find_if(__first, __last, __pred);
1144       _ForwardIterator __i = __first;
1145       return __first == __last ? __first
1146                                : std::remove_copy_if(++__i, __last,
1147                                                      __first, __pred);
1148     }
1149
1150   /**
1151    *  @if maint
1152    *  This is an uglified unique_copy(_InputIterator, _InputIterator,
1153    *                                  _OutputIterator)
1154    *  overloaded for output iterators.
1155    *  @endif
1156   */
1157   template<typename _InputIterator, typename _OutputIterator>
1158     _OutputIterator
1159     __unique_copy(_InputIterator __first, _InputIterator __last,
1160                   _OutputIterator __result,
1161                   output_iterator_tag)
1162     {
1163       // concept requirements -- taken care of in dispatching function
1164       typename iterator_traits<_InputIterator>::value_type __value = *__first;
1165       *__result = __value;
1166       while (++__first != __last)
1167         if (!(__value == *__first))
1168           {
1169             __value = *__first;
1170             *++__result = __value;
1171           }
1172       return ++__result;
1173     }
1174
1175   /**
1176    *  @if maint
1177    *  This is an uglified unique_copy(_InputIterator, _InputIterator,
1178    *                                  _OutputIterator)
1179    *  overloaded for forward iterators.
1180    *  @endif
1181   */
1182   template<typename _InputIterator, typename _ForwardIterator>
1183     _ForwardIterator
1184     __unique_copy(_InputIterator __first, _InputIterator __last,
1185                   _ForwardIterator __result,
1186                   forward_iterator_tag)
1187     {
1188       // concept requirements -- taken care of in dispatching function
1189       *__result = *__first;
1190       while (++__first != __last)
1191         if (!(*__result == *__first))
1192           *++__result = *__first;
1193       return ++__result;
1194     }
1195
1196   /**
1197    *  @if maint
1198    *  This is an uglified
1199    *  unique_copy(_InputIterator, _InputIterator, _OutputIterator,
1200    *              _BinaryPredicate)
1201    *  overloaded for output iterators.
1202    *  @endif
1203   */
1204   template<typename _InputIterator, typename _OutputIterator,
1205            typename _BinaryPredicate>
1206     _OutputIterator
1207     __unique_copy(_InputIterator __first, _InputIterator __last,
1208                   _OutputIterator __result,
1209                   _BinaryPredicate __binary_pred,
1210                   output_iterator_tag)
1211     {
1212       // concept requirements -- iterators already checked
1213       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1214           typename iterator_traits<_InputIterator>::value_type,
1215           typename iterator_traits<_InputIterator>::value_type>)
1216
1217       typename iterator_traits<_InputIterator>::value_type __value = *__first;
1218       *__result = __value;
1219       while (++__first != __last)
1220         if (!__binary_pred(__value, *__first))
1221           {
1222             __value = *__first;
1223             *++__result = __value;
1224           }
1225       return ++__result;
1226     }
1227
1228   /**
1229    *  @if maint
1230    *  This is an uglified
1231    *  unique_copy(_InputIterator, _InputIterator, _OutputIterator,
1232    *              _BinaryPredicate)
1233    *  overloaded for forward iterators.
1234    *  @endif
1235   */
1236   template<typename _InputIterator, typename _ForwardIterator,
1237            typename _BinaryPredicate>
1238     _ForwardIterator
1239     __unique_copy(_InputIterator __first, _InputIterator __last,
1240                   _ForwardIterator __result,
1241                   _BinaryPredicate __binary_pred,
1242                   forward_iterator_tag)
1243     {
1244       // concept requirements -- iterators already checked
1245       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1246             typename iterator_traits<_ForwardIterator>::value_type,
1247             typename iterator_traits<_InputIterator>::value_type>)
1248
1249       *__result = *__first;
1250       while (++__first != __last)
1251         if (!__binary_pred(*__result, *__first)) *++__result = *__first;
1252       return ++__result;
1253     }
1254
1255   /**
1256    *  @brief Copy a sequence, removing consecutive duplicate values.
1257    *  @param  first   An input iterator.
1258    *  @param  last    An input iterator.
1259    *  @param  result  An output iterator.
1260    *  @return   An iterator designating the end of the resulting sequence.
1261    *
1262    *  Copies each element in the range @p [first,last) to the range
1263    *  beginning at @p result, except that only the first element is copied
1264    *  from groups of consecutive elements that compare equal.
1265    *  unique_copy() is stable, so the relative order of elements that are
1266    *  copied is unchanged.
1267   */
1268   template<typename _InputIterator, typename _OutputIterator>
1269     inline _OutputIterator
1270     unique_copy(_InputIterator __first, _InputIterator __last,
1271                 _OutputIterator __result)
1272     {
1273       // concept requirements
1274       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1275       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1276             typename iterator_traits<_InputIterator>::value_type>)
1277       __glibcxx_function_requires(_EqualityComparableConcept<
1278             typename iterator_traits<_InputIterator>::value_type>)
1279       __glibcxx_requires_valid_range(__first, __last);
1280
1281       typedef typename iterator_traits<_OutputIterator>::iterator_category
1282         _IterType;
1283
1284       if (__first == __last) return __result;
1285       return std::__unique_copy(__first, __last, __result, _IterType());
1286     }
1287
1288   /**
1289    *  @brief Copy a sequence, removing consecutive values using a predicate.
1290    *  @param  first        An input iterator.
1291    *  @param  last         An input iterator.
1292    *  @param  result       An output iterator.
1293    *  @param  binary_pred  A binary predicate.
1294    *  @return   An iterator designating the end of the resulting sequence.
1295    *
1296    *  Copies each element in the range @p [first,last) to the range
1297    *  beginning at @p result, except that only the first element is copied
1298    *  from groups of consecutive elements for which @p binary_pred returns
1299    *  true.
1300    *  unique_copy() is stable, so the relative order of elements that are
1301    *  copied is unchanged.
1302   */
1303   template<typename _InputIterator, typename _OutputIterator,
1304            typename _BinaryPredicate>
1305     inline _OutputIterator
1306     unique_copy(_InputIterator __first, _InputIterator __last,
1307                 _OutputIterator __result,
1308                 _BinaryPredicate __binary_pred)
1309     {
1310       // concept requirements -- predicates checked later
1311       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1312       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1313             typename iterator_traits<_InputIterator>::value_type>)
1314       __glibcxx_requires_valid_range(__first, __last);
1315
1316       typedef typename iterator_traits<_OutputIterator>::iterator_category
1317         _IterType;
1318
1319       if (__first == __last) return __result;
1320       return std::__unique_copy(__first, __last, __result,
1321                                 __binary_pred, _IterType());
1322     }
1323
1324   /**
1325    *  @brief Remove consecutive duplicate values from a sequence.
1326    *  @param  first  A forward iterator.
1327    *  @param  last   A forward iterator.
1328    *  @return  An iterator designating the end of the resulting sequence.
1329    *
1330    *  Removes all but the first element from each group of consecutive
1331    *  values that compare equal.
1332    *  unique() is stable, so the relative order of elements that are
1333    *  not removed is unchanged.
1334    *  Elements between the end of the resulting sequence and @p last
1335    *  are still present, but their value is unspecified.
1336   */
1337   template<typename _ForwardIterator>
1338     _ForwardIterator
1339     unique(_ForwardIterator __first, _ForwardIterator __last)
1340     {
1341       // concept requirements
1342       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1343                                   _ForwardIterator>)
1344       __glibcxx_function_requires(_EqualityComparableConcept<
1345                      typename iterator_traits<_ForwardIterator>::value_type>)
1346       __glibcxx_requires_valid_range(__first, __last);
1347
1348       // Skip the beginning, if already unique.
1349       __first = std::adjacent_find(__first, __last);
1350       if (__first == __last)
1351         return __last;
1352
1353       // Do the real copy work.
1354       _ForwardIterator __dest = __first;
1355       ++__first;
1356       while (++__first != __last)
1357         if (!(*__dest == *__first))
1358           *++__dest = *__first;
1359       return ++__dest;
1360     }
1361
1362   /**
1363    *  @brief Remove consecutive values from a sequence using a predicate.
1364    *  @param  first        A forward iterator.
1365    *  @param  last         A forward iterator.
1366    *  @param  binary_pred  A binary predicate.
1367    *  @return  An iterator designating the end of the resulting sequence.
1368    *
1369    *  Removes all but the first element from each group of consecutive
1370    *  values for which @p binary_pred returns true.
1371    *  unique() is stable, so the relative order of elements that are
1372    *  not removed is unchanged.
1373    *  Elements between the end of the resulting sequence and @p last
1374    *  are still present, but their value is unspecified.
1375   */
1376   template<typename _ForwardIterator, typename _BinaryPredicate>
1377     _ForwardIterator
1378     unique(_ForwardIterator __first, _ForwardIterator __last,
1379            _BinaryPredicate __binary_pred)
1380     {
1381       // concept requirements
1382       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1383                                   _ForwardIterator>)
1384       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1385                 typename iterator_traits<_ForwardIterator>::value_type,
1386                 typename iterator_traits<_ForwardIterator>::value_type>)
1387       __glibcxx_requires_valid_range(__first, __last);
1388
1389       // Skip the beginning, if already unique.
1390       __first = std::adjacent_find(__first, __last, __binary_pred);
1391       if (__first == __last)
1392         return __last;
1393
1394       // Do the real copy work.
1395       _ForwardIterator __dest = __first;
1396       ++__first;
1397       while (++__first != __last)
1398         if (!__binary_pred(*__dest, *__first))
1399           *++__dest = *__first;
1400       return ++__dest;
1401     }
1402
1403   /**
1404    *  @if maint
1405    *  This is an uglified reverse(_BidirectionalIterator,
1406    *                              _BidirectionalIterator)
1407    *  overloaded for bidirectional iterators.
1408    *  @endif
1409   */
1410   template<typename _BidirectionalIterator>
1411     void
1412     __reverse(_BidirectionalIterator __first, _BidirectionalIterator __last,
1413               bidirectional_iterator_tag)
1414     {
1415       while (true)
1416         if (__first == __last || __first == --__last)
1417           return;
1418         else
1419           {
1420             std::iter_swap(__first, __last);
1421             ++__first;
1422           }
1423     }
1424
1425   /**
1426    *  @if maint
1427    *  This is an uglified reverse(_BidirectionalIterator,
1428    *                              _BidirectionalIterator)
1429    *  overloaded for random access iterators.
1430    *  @endif
1431   */
1432   template<typename _RandomAccessIterator>
1433     void
1434     __reverse(_RandomAccessIterator __first, _RandomAccessIterator __last,
1435               random_access_iterator_tag)
1436     {
1437       if (__first == __last)
1438         return;
1439       --__last;
1440       while (__first < __last)
1441         {
1442           std::iter_swap(__first, __last);
1443           ++__first;
1444           --__last;
1445         }
1446     }
1447
1448   /**
1449    *  @brief Reverse a sequence.
1450    *  @param  first  A bidirectional iterator.
1451    *  @param  last   A bidirectional iterator.
1452    *  @return   reverse() returns no value.
1453    *
1454    *  Reverses the order of the elements in the range @p [first,last),
1455    *  so that the first element becomes the last etc.
1456    *  For every @c i such that @p 0<=i<=(last-first)/2), @p reverse()
1457    *  swaps @p *(first+i) and @p *(last-(i+1))
1458   */
1459   template<typename _BidirectionalIterator>
1460     inline void
1461     reverse(_BidirectionalIterator __first, _BidirectionalIterator __last)
1462     {
1463       // concept requirements
1464       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
1465                                   _BidirectionalIterator>)
1466       __glibcxx_requires_valid_range(__first, __last);
1467       std::__reverse(__first, __last, std::__iterator_category(__first));
1468     }
1469
1470   /**
1471    *  @brief Copy a sequence, reversing its elements.
1472    *  @param  first   A bidirectional iterator.
1473    *  @param  last    A bidirectional iterator.
1474    *  @param  result  An output iterator.
1475    *  @return  An iterator designating the end of the resulting sequence.
1476    *
1477    *  Copies the elements in the range @p [first,last) to the range
1478    *  @p [result,result+(last-first)) such that the order of the
1479    *  elements is reversed.
1480    *  For every @c i such that @p 0<=i<=(last-first), @p reverse_copy()
1481    *  performs the assignment @p *(result+(last-first)-i) = *(first+i).
1482    *  The ranges @p [first,last) and @p [result,result+(last-first))
1483    *  must not overlap.
1484   */
1485   template<typename _BidirectionalIterator, typename _OutputIterator>
1486     _OutputIterator
1487     reverse_copy(_BidirectionalIterator __first, _BidirectionalIterator __last,
1488                              _OutputIterator __result)
1489     {
1490       // concept requirements
1491       __glibcxx_function_requires(_BidirectionalIteratorConcept<
1492                                   _BidirectionalIterator>)
1493       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1494                 typename iterator_traits<_BidirectionalIterator>::value_type>)
1495       __glibcxx_requires_valid_range(__first, __last);
1496
1497       while (__first != __last)
1498         {
1499           --__last;
1500           *__result = *__last;
1501           ++__result;
1502         }
1503       return __result;
1504     }
1505
1506
1507   /**
1508    *  @if maint
1509    *  This is a helper function for the rotate algorithm specialized on RAIs.
1510    *  It returns the greatest common divisor of two integer values.
1511    *  @endif
1512   */
1513   template<typename _EuclideanRingElement>
1514     _EuclideanRingElement
1515     __gcd(_EuclideanRingElement __m, _EuclideanRingElement __n)
1516     {
1517       while (__n != 0)
1518         {
1519           _EuclideanRingElement __t = __m % __n;
1520           __m = __n;
1521           __n = __t;
1522         }
1523       return __m;
1524     }
1525
1526   /**
1527    *  @if maint
1528    *  This is a helper function for the rotate algorithm.
1529    *  @endif
1530   */
1531   template<typename _ForwardIterator>
1532     void
1533     __rotate(_ForwardIterator __first,
1534              _ForwardIterator __middle,
1535              _ForwardIterator __last,
1536              forward_iterator_tag)
1537     {
1538       if (__first == __middle || __last  == __middle)
1539         return;
1540
1541       _ForwardIterator __first2 = __middle;
1542       do
1543         {
1544           swap(*__first, *__first2);
1545           ++__first;
1546           ++__first2;
1547           if (__first == __middle)
1548             __middle = __first2;
1549         }
1550       while (__first2 != __last);
1551
1552       __first2 = __middle;
1553
1554       while (__first2 != __last)
1555         {
1556           swap(*__first, *__first2);
1557           ++__first;
1558           ++__first2;
1559           if (__first == __middle)
1560             __middle = __first2;
1561           else if (__first2 == __last)
1562             __first2 = __middle;
1563         }
1564     }
1565
1566   /**
1567    *  @if maint
1568    *  This is a helper function for the rotate algorithm.
1569    *  @endif
1570   */
1571   template<typename _BidirectionalIterator>
1572     void
1573     __rotate(_BidirectionalIterator __first,
1574              _BidirectionalIterator __middle,
1575              _BidirectionalIterator __last,
1576               bidirectional_iterator_tag)
1577     {
1578       // concept requirements
1579       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
1580                                   _BidirectionalIterator>)
1581
1582       if (__first == __middle || __last  == __middle)
1583         return;
1584
1585       std::__reverse(__first,  __middle, bidirectional_iterator_tag());
1586       std::__reverse(__middle, __last,   bidirectional_iterator_tag());
1587
1588       while (__first != __middle && __middle != __last)
1589         {
1590           swap(*__first, *--__last);
1591           ++__first;
1592         }
1593
1594       if (__first == __middle)
1595         std::__reverse(__middle, __last,   bidirectional_iterator_tag());
1596       else
1597         std::__reverse(__first,  __middle, bidirectional_iterator_tag());
1598     }
1599
1600   /**
1601    *  @if maint
1602    *  This is a helper function for the rotate algorithm.
1603    *  @endif
1604   */
1605   template<typename _RandomAccessIterator>
1606     void
1607     __rotate(_RandomAccessIterator __first,
1608              _RandomAccessIterator __middle,
1609              _RandomAccessIterator __last,
1610              random_access_iterator_tag)
1611     {
1612       // concept requirements
1613       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1614                                   _RandomAccessIterator>)
1615
1616       if (__first == __middle || __last  == __middle)
1617         return;
1618
1619       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
1620         _Distance;
1621       typedef typename iterator_traits<_RandomAccessIterator>::value_type
1622         _ValueType;
1623
1624       const _Distance __n = __last   - __first;
1625       const _Distance __k = __middle - __first;
1626       const _Distance __l = __n - __k;
1627
1628       if (__k == __l)
1629         {
1630           std::swap_ranges(__first, __middle, __middle);
1631           return;
1632         }
1633
1634       const _Distance __d = __gcd(__n, __k);
1635
1636       for (_Distance __i = 0; __i < __d; __i++)
1637         {
1638           _ValueType __tmp = *__first;
1639           _RandomAccessIterator __p = __first;
1640
1641           if (__k < __l)
1642             {
1643               for (_Distance __j = 0; __j < __l / __d; __j++)
1644                 {
1645                   if (__p > __first + __l)
1646                     {
1647                       *__p = *(__p - __l);
1648                       __p -= __l;
1649                     }
1650
1651                   *__p = *(__p + __k);
1652                   __p += __k;
1653                 }
1654             }
1655           else
1656             {
1657               for (_Distance __j = 0; __j < __k / __d - 1; __j ++)
1658                 {
1659                   if (__p < __last - __k)
1660                     {
1661                       *__p = *(__p + __k);
1662                       __p += __k;
1663                     }
1664                   *__p = * (__p - __l);
1665                   __p -= __l;
1666                 }
1667             }
1668
1669           *__p = __tmp;
1670           ++__first;
1671         }
1672     }
1673
1674   /**
1675    *  @brief Rotate the elements of a sequence.
1676    *  @param  first   A forward iterator.
1677    *  @param  middle  A forward iterator.
1678    *  @param  last    A forward iterator.
1679    *  @return  Nothing.
1680    *
1681    *  Rotates the elements of the range @p [first,last) by @p (middle-first)
1682    *  positions so that the element at @p middle is moved to @p first, the
1683    *  element at @p middle+1 is moved to @first+1 and so on for each element
1684    *  in the range @p [first,last).
1685    *
1686    *  This effectively swaps the ranges @p [first,middle) and
1687    *  @p [middle,last).
1688    *
1689    *  Performs @p *(first+(n+(last-middle))%(last-first))=*(first+n) for
1690    *  each @p n in the range @p [0,last-first).
1691   */
1692   template<typename _ForwardIterator>
1693     inline void
1694     rotate(_ForwardIterator __first, _ForwardIterator __middle,
1695            _ForwardIterator __last)
1696     {
1697       // concept requirements
1698       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1699                                   _ForwardIterator>)
1700       __glibcxx_requires_valid_range(__first, __middle);
1701       __glibcxx_requires_valid_range(__middle, __last);
1702
1703       typedef typename iterator_traits<_ForwardIterator>::iterator_category
1704         _IterType;
1705       std::__rotate(__first, __middle, __last, _IterType());
1706     }
1707
1708   /**
1709    *  @brief Copy a sequence, rotating its elements.
1710    *  @param  first   A forward iterator.
1711    *  @param  middle  A forward iterator.
1712    *  @param  last    A forward iterator.
1713    *  @param  result  An output iterator.
1714    *  @return   An iterator designating the end of the resulting sequence.
1715    *
1716    *  Copies the elements of the range @p [first,last) to the range
1717    *  beginning at @result, rotating the copied elements by @p (middle-first)
1718    *  positions so that the element at @p middle is moved to @p result, the
1719    *  element at @p middle+1 is moved to @result+1 and so on for each element
1720    *  in the range @p [first,last).
1721    *
1722    *  Performs @p *(result+(n+(last-middle))%(last-first))=*(first+n) for
1723    *  each @p n in the range @p [0,last-first).
1724   */
1725   template<typename _ForwardIterator, typename _OutputIterator>
1726     _OutputIterator
1727     rotate_copy(_ForwardIterator __first, _ForwardIterator __middle,
1728                 _ForwardIterator __last, _OutputIterator __result)
1729     {
1730       // concept requirements
1731       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
1732       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1733                 typename iterator_traits<_ForwardIterator>::value_type>)
1734       __glibcxx_requires_valid_range(__first, __middle);
1735       __glibcxx_requires_valid_range(__middle, __last);
1736
1737       return std::copy(__first, __middle,
1738                        std::copy(__middle, __last, __result));
1739     }
1740
1741   /**
1742    *  @brief Randomly shuffle the elements of a sequence.
1743    *  @param  first   A forward iterator.
1744    *  @param  last    A forward iterator.
1745    *  @return  Nothing.
1746    *
1747    *  Reorder the elements in the range @p [first,last) using a random
1748    *  distribution, so that every possible ordering of the sequence is
1749    *  equally likely.
1750   */
1751   template<typename _RandomAccessIterator>
1752     inline void
1753     random_shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last)
1754     {
1755       // concept requirements
1756       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1757             _RandomAccessIterator>)
1758       __glibcxx_requires_valid_range(__first, __last);
1759
1760       if (__first != __last)
1761         for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
1762           std::iter_swap(__i, __first + (std::rand() % ((__i - __first) + 1)));
1763     }
1764
1765   /**
1766    *  @brief Shuffle the elements of a sequence using a random number
1767    *         generator.
1768    *  @param  first   A forward iterator.
1769    *  @param  last    A forward iterator.
1770    *  @param  rand    The RNG functor or function.
1771    *  @return  Nothing.
1772    *
1773    *  Reorders the elements in the range @p [first,last) using @p rand to
1774    *  provide a random distribution. Calling @p rand(N) for a positive
1775    *  integer @p N should return a randomly chosen integer from the
1776    *  range [0,N).
1777   */
1778   template<typename _RandomAccessIterator, typename _RandomNumberGenerator>
1779     void
1780     random_shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last,
1781                    _RandomNumberGenerator& __rand)
1782     {
1783       // concept requirements
1784       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1785             _RandomAccessIterator>)
1786       __glibcxx_requires_valid_range(__first, __last);
1787
1788       if (__first == __last)
1789         return;
1790       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
1791         std::iter_swap(__i, __first + __rand((__i - __first) + 1));
1792     }
1793
1794
1795   /**
1796    *  @if maint
1797    *  This is a helper function...
1798    *  @endif
1799   */
1800   template<typename _ForwardIterator, typename _Predicate>
1801     _ForwardIterator
1802     __partition(_ForwardIterator __first, _ForwardIterator __last,
1803                 _Predicate __pred,
1804                 forward_iterator_tag)
1805     {
1806       if (__first == __last)
1807         return __first;
1808
1809       while (__pred(*__first))
1810         if (++__first == __last)
1811           return __first;
1812
1813       _ForwardIterator __next = __first;
1814
1815       while (++__next != __last)
1816         if (__pred(*__next))
1817           {
1818             swap(*__first, *__next);
1819             ++__first;
1820           }
1821
1822       return __first;
1823     }
1824
1825   /**
1826    *  @if maint
1827    *  This is a helper function...
1828    *  @endif
1829   */
1830   template<typename _BidirectionalIterator, typename _Predicate>
1831     _BidirectionalIterator
1832     __partition(_BidirectionalIterator __first, _BidirectionalIterator __last,
1833                 _Predicate __pred,
1834                 bidirectional_iterator_tag)
1835     {
1836       while (true)
1837         {
1838           while (true)
1839             if (__first == __last)
1840               return __first;
1841             else if (__pred(*__first))
1842               ++__first;
1843             else
1844               break;
1845           --__last;
1846           while (true)
1847             if (__first == __last)
1848               return __first;
1849             else if (!__pred(*__last))
1850               --__last;
1851             else
1852               break;
1853           std::iter_swap(__first, __last);
1854           ++__first;
1855         }
1856     }
1857
1858   /**
1859    *  @brief Move elements for which a predicate is true to the beginning
1860    *         of a sequence.
1861    *  @param  first   A forward iterator.
1862    *  @param  last    A forward iterator.
1863    *  @param  pred    A predicate functor.
1864    *  @return  An iterator @p middle such that @p pred(i) is true for each
1865    *  iterator @p i in the range @p [first,middle) and false for each @p i
1866    *  in the range @p [middle,last).
1867    *
1868    *  @p pred must not modify its operand. @p partition() does not preserve
1869    *  the relative ordering of elements in each group, use
1870    *  @p stable_partition() if this is needed.
1871   */
1872   template<typename _ForwardIterator, typename _Predicate>
1873     inline _ForwardIterator
1874     partition(_ForwardIterator __first, _ForwardIterator __last,
1875               _Predicate   __pred)
1876     {
1877       // concept requirements
1878       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1879                                   _ForwardIterator>)
1880       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1881             typename iterator_traits<_ForwardIterator>::value_type>)
1882       __glibcxx_requires_valid_range(__first, __last);
1883
1884       return std::__partition(__first, __last, __pred,
1885                               std::__iterator_category(__first));
1886     }
1887
1888
1889   /**
1890    *  @if maint
1891    *  This is a helper function...
1892    *  @endif
1893   */
1894   template<typename _ForwardIterator, typename _Predicate, typename _Distance>
1895     _ForwardIterator
1896     __inplace_stable_partition(_ForwardIterator __first,
1897                                _ForwardIterator __last,
1898                                _Predicate __pred, _Distance __len)
1899     {
1900       if (__len == 1)
1901         return __pred(*__first) ? __last : __first;
1902       _ForwardIterator __middle = __first;
1903       std::advance(__middle, __len / 2);
1904       _ForwardIterator __begin = std::__inplace_stable_partition(__first,
1905                                                                  __middle,
1906                                                                  __pred,
1907                                                                  __len / 2);
1908       _ForwardIterator __end = std::__inplace_stable_partition(__middle, __last,
1909                                                                __pred,
1910                                                                __len
1911                                                                - __len / 2);
1912       std::rotate(__begin, __middle, __end);
1913       std::advance(__begin, std::distance(__middle, __end));
1914       return __begin;
1915     }
1916
1917   /**
1918    *  @if maint
1919    *  This is a helper function...
1920    *  @endif
1921   */
1922   template<typename _ForwardIterator, typename _Pointer, typename _Predicate,
1923            typename _Distance>
1924     _ForwardIterator
1925     __stable_partition_adaptive(_ForwardIterator __first,
1926                                 _ForwardIterator __last,
1927                                 _Predicate __pred, _Distance __len,
1928                                 _Pointer __buffer,
1929                                 _Distance __buffer_size)
1930     {
1931       if (__len <= __buffer_size)
1932         {
1933           _ForwardIterator __result1 = __first;
1934           _Pointer __result2 = __buffer;
1935           for ( ; __first != __last ; ++__first)
1936             if (__pred(*__first))
1937               {
1938                 *__result1 = *__first;
1939                 ++__result1;
1940               }
1941             else
1942               {
1943                 *__result2 = *__first;
1944                 ++__result2;
1945               }
1946           std::copy(__buffer, __result2, __result1);
1947           return __result1;
1948         }
1949       else
1950         {
1951           _ForwardIterator __middle = __first;
1952           std::advance(__middle, __len / 2);
1953           _ForwardIterator __begin =
1954             std::__stable_partition_adaptive(__first, __middle, __pred,
1955                                              __len / 2, __buffer,
1956                                              __buffer_size);
1957           _ForwardIterator __end =
1958             std::__stable_partition_adaptive(__middle, __last, __pred,
1959                                              __len - __len / 2,
1960                                              __buffer, __buffer_size);
1961           std::rotate(__begin, __middle, __end);
1962           std::advance(__begin, std::distance(__middle, __end));
1963           return __begin;
1964         }
1965     }
1966
1967   /**
1968    *  @brief Move elements for which a predicate is true to the beginning
1969    *         of a sequence, preserving relative ordering.
1970    *  @param  first   A forward iterator.
1971    *  @param  last    A forward iterator.
1972    *  @param  pred    A predicate functor.
1973    *  @return  An iterator @p middle such that @p pred(i) is true for each
1974    *  iterator @p i in the range @p [first,middle) and false for each @p i
1975    *  in the range @p [middle,last).
1976    *
1977    *  Performs the same function as @p partition() with the additional
1978    *  guarantee that the relative ordering of elements in each group is
1979    *  preserved, so any two elements @p x and @p y in the range
1980    *  @p [first,last) such that @p pred(x)==pred(y) will have the same
1981    *  relative ordering after calling @p stable_partition().
1982   */
1983   template<typename _ForwardIterator, typename _Predicate>
1984     _ForwardIterator
1985     stable_partition(_ForwardIterator __first, _ForwardIterator __last,
1986                      _Predicate __pred)
1987     {
1988       // concept requirements
1989       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
1990                                   _ForwardIterator>)
1991       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1992             typename iterator_traits<_ForwardIterator>::value_type>)
1993       __glibcxx_requires_valid_range(__first, __last);
1994
1995       if (__first == __last)
1996         return __first;
1997       else
1998         {
1999           typedef typename iterator_traits<_ForwardIterator>::value_type
2000             _ValueType;
2001           typedef typename iterator_traits<_ForwardIterator>::difference_type
2002             _DistanceType;
2003
2004           _Temporary_buffer<_ForwardIterator, _ValueType> __buf(__first,
2005                                                                 __last);
2006         if (__buf.size() > 0)
2007           return
2008             std::__stable_partition_adaptive(__first, __last, __pred,
2009                                           _DistanceType(__buf.requested_size()),
2010                                           __buf.begin(), __buf.size());
2011         else
2012           return
2013             std::__inplace_stable_partition(__first, __last, __pred,
2014                                          _DistanceType(__buf.requested_size()));
2015         }
2016     }
2017
2018   /**
2019    *  @if maint
2020    *  This is a helper function...
2021    *  @endif
2022   */
2023   template<typename _RandomAccessIterator, typename _Tp>
2024     _RandomAccessIterator
2025     __unguarded_partition(_RandomAccessIterator __first,
2026                           _RandomAccessIterator __last, _Tp __pivot)
2027     {
2028       while (true)
2029         {
2030           while (*__first < __pivot)
2031             ++__first;
2032           --__last;
2033           while (__pivot < *__last)
2034             --__last;
2035           if (!(__first < __last))
2036             return __first;
2037           std::iter_swap(__first, __last);
2038           ++__first;
2039         }
2040     }
2041
2042   /**
2043    *  @if maint
2044    *  This is a helper function...
2045    *  @endif
2046   */
2047   template<typename _RandomAccessIterator, typename _Tp, typename _Compare>
2048     _RandomAccessIterator
2049     __unguarded_partition(_RandomAccessIterator __first,
2050                           _RandomAccessIterator __last,
2051                           _Tp __pivot, _Compare __comp)
2052     {
2053       while (true)
2054         {
2055           while (__comp(*__first, __pivot))
2056             ++__first;
2057           --__last;
2058           while (__comp(__pivot, *__last))
2059             --__last;
2060           if (!(__first < __last))
2061             return __first;
2062           std::iter_swap(__first, __last);
2063           ++__first;
2064         }
2065     }
2066
2067   /**
2068    *  @if maint
2069    *  @doctodo
2070    *  This controls some aspect of the sort routines.
2071    *  @endif
2072   */
2073   enum { _S_threshold = 16 };
2074
2075   /**
2076    *  @if maint
2077    *  This is a helper function for the sort routine.
2078    *  @endif
2079   */
2080   template<typename _RandomAccessIterator, typename _Tp>
2081     void
2082     __unguarded_linear_insert(_RandomAccessIterator __last, _Tp __val)
2083     {
2084       _RandomAccessIterator __next = __last;
2085       --__next;
2086       while (__val < *__next)
2087         {
2088           *__last = *__next;
2089           __last = __next;
2090           --__next;
2091         }
2092       *__last = __val;
2093     }
2094
2095   /**
2096    *  @if maint
2097    *  This is a helper function for the sort routine.
2098    *  @endif
2099   */
2100   template<typename _RandomAccessIterator, typename _Tp, typename _Compare>
2101     void
2102     __unguarded_linear_insert(_RandomAccessIterator __last, _Tp __val,
2103                               _Compare __comp)
2104     {
2105       _RandomAccessIterator __next = __last;
2106       --__next;
2107       while (__comp(__val, *__next))
2108         {
2109           *__last = *__next;
2110           __last = __next;
2111           --__next;
2112         }
2113       *__last = __val;
2114     }
2115
2116   /**
2117    *  @if maint
2118    *  This is a helper function for the sort routine.
2119    *  @endif
2120   */
2121   template<typename _RandomAccessIterator>
2122     void
2123     __insertion_sort(_RandomAccessIterator __first,
2124                      _RandomAccessIterator __last)
2125     {
2126       if (__first == __last)
2127         return;
2128
2129       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
2130         {
2131           typename iterator_traits<_RandomAccessIterator>::value_type
2132             __val = *__i;
2133           if (__val < *__first)
2134             {
2135               std::copy_backward(__first, __i, __i + 1);
2136               *__first = __val;
2137             }
2138           else
2139             std::__unguarded_linear_insert(__i, __val);
2140         }
2141     }
2142
2143   /**
2144    *  @if maint
2145    *  This is a helper function for the sort routine.
2146    *  @endif
2147   */
2148   template<typename _RandomAccessIterator, typename _Compare>
2149     void
2150     __insertion_sort(_RandomAccessIterator __first,
2151                      _RandomAccessIterator __last, _Compare __comp)
2152     {
2153       if (__first == __last) return;
2154
2155       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
2156         {
2157           typename iterator_traits<_RandomAccessIterator>::value_type
2158             __val = *__i;
2159           if (__comp(__val, *__first))
2160             {
2161               std::copy_backward(__first, __i, __i + 1);
2162               *__first = __val;
2163             }
2164           else
2165             std::__unguarded_linear_insert(__i, __val, __comp);
2166         }
2167     }
2168
2169   /**
2170    *  @if maint
2171    *  This is a helper function for the sort routine.
2172    *  @endif
2173   */
2174   template<typename _RandomAccessIterator>
2175     inline void
2176     __unguarded_insertion_sort(_RandomAccessIterator __first,
2177                                _RandomAccessIterator __last)
2178     {
2179       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2180         _ValueType;
2181
2182       for (_RandomAccessIterator __i = __first; __i != __last; ++__i)
2183         std::__unguarded_linear_insert(__i, _ValueType(*__i));
2184     }
2185
2186   /**
2187    *  @if maint
2188    *  This is a helper function for the sort routine.
2189    *  @endif
2190   */
2191   template<typename _RandomAccessIterator, typename _Compare>
2192     inline void
2193     __unguarded_insertion_sort(_RandomAccessIterator __first,
2194                                _RandomAccessIterator __last, _Compare __comp)
2195     {
2196       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2197         _ValueType;
2198
2199       for (_RandomAccessIterator __i = __first; __i != __last; ++__i)
2200         std::__unguarded_linear_insert(__i, _ValueType(*__i), __comp);
2201     }
2202
2203   /**
2204    *  @if maint
2205    *  This is a helper function for the sort routine.
2206    *  @endif
2207   */
2208   template<typename _RandomAccessIterator>
2209     void
2210     __final_insertion_sort(_RandomAccessIterator __first,
2211                            _RandomAccessIterator __last)
2212     {
2213       if (__last - __first > int(_S_threshold))
2214         {
2215           std::__insertion_sort(__first, __first + int(_S_threshold));
2216           std::__unguarded_insertion_sort(__first + int(_S_threshold), __last);
2217         }
2218       else
2219         std::__insertion_sort(__first, __last);
2220     }
2221
2222   /**
2223    *  @if maint
2224    *  This is a helper function for the sort routine.
2225    *  @endif
2226   */
2227   template<typename _RandomAccessIterator, typename _Compare>
2228     void
2229     __final_insertion_sort(_RandomAccessIterator __first,
2230                            _RandomAccessIterator __last, _Compare __comp)
2231     {
2232       if (__last - __first > int(_S_threshold))
2233         {
2234           std::__insertion_sort(__first, __first + int(_S_threshold), __comp);
2235           std::__unguarded_insertion_sort(__first + int(_S_threshold), __last,
2236                                           __comp);
2237         }
2238       else
2239         std::__insertion_sort(__first, __last, __comp);
2240     }
2241
2242   /**
2243    *  @if maint
2244    *  This is a helper function for the sort routine.
2245    *  @endif
2246   */
2247   template<typename _Size>
2248     inline _Size
2249     __lg(_Size __n)
2250     {
2251       _Size __k;
2252       for (__k = 0; __n != 1; __n >>= 1)
2253         ++__k;
2254       return __k;
2255     }
2256
2257   /**
2258    *  @brief Sort the smallest elements of a sequence.
2259    *  @param  first   An iterator.
2260    *  @param  middle  Another iterator.
2261    *  @param  last    Another iterator.
2262    *  @return  Nothing.
2263    *
2264    *  Sorts the smallest @p (middle-first) elements in the range
2265    *  @p [first,last) and moves them to the range @p [first,middle). The
2266    *  order of the remaining elements in the range @p [middle,last) is
2267    *  undefined.
2268    *  After the sort if @p i and @j are iterators in the range
2269    *  @p [first,middle) such that @i precedes @j and @k is an iterator in
2270    *  the range @p [middle,last) then @p *j<*i and @p *k<*i are both false.
2271   */
2272   template<typename _RandomAccessIterator>
2273     void
2274     partial_sort(_RandomAccessIterator __first,
2275                  _RandomAccessIterator __middle,
2276                  _RandomAccessIterator __last)
2277     {
2278       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2279         _ValueType;
2280
2281       // concept requirements
2282       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2283             _RandomAccessIterator>)
2284       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
2285       __glibcxx_requires_valid_range(__first, __middle);
2286       __glibcxx_requires_valid_range(__middle, __last);
2287
2288       std::make_heap(__first, __middle);
2289       for (_RandomAccessIterator __i = __middle; __i < __last; ++__i)
2290         if (*__i < *__first)
2291           std::__pop_heap(__first, __middle, __i, _ValueType(*__i));
2292       std::sort_heap(__first, __middle);
2293     }
2294
2295   /**
2296    *  @brief Sort the smallest elements of a sequence using a predicate
2297    *         for comparison.
2298    *  @param  first   An iterator.
2299    *  @param  middle  Another iterator.
2300    *  @param  last    Another iterator.
2301    *  @param  comp    A comparison functor.
2302    *  @return  Nothing.
2303    *
2304    *  Sorts the smallest @p (middle-first) elements in the range
2305    *  @p [first,last) and moves them to the range @p [first,middle). The
2306    *  order of the remaining elements in the range @p [middle,last) is
2307    *  undefined.
2308    *  After the sort if @p i and @j are iterators in the range
2309    *  @p [first,middle) such that @i precedes @j and @k is an iterator in
2310    *  the range @p [middle,last) then @p *comp(j,*i) and @p comp(*k,*i)
2311    *  are both false.
2312   */
2313   template<typename _RandomAccessIterator, typename _Compare>
2314     void
2315     partial_sort(_RandomAccessIterator __first,
2316                  _RandomAccessIterator __middle,
2317                  _RandomAccessIterator __last,
2318                  _Compare __comp)
2319     {
2320       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2321         _ValueType;
2322
2323       // concept requirements
2324       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2325             _RandomAccessIterator>)
2326       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2327                                   _ValueType, _ValueType>)
2328       __glibcxx_requires_valid_range(__first, __middle);
2329       __glibcxx_requires_valid_range(__middle, __last);
2330
2331       std::make_heap(__first, __middle, __comp);
2332       for (_RandomAccessIterator __i = __middle; __i < __last; ++__i)
2333         if (__comp(*__i, *__first))
2334           std::__pop_heap(__first, __middle, __i, _ValueType(*__i), __comp);
2335       std::sort_heap(__first, __middle, __comp);
2336     }
2337
2338   /**
2339    *  @brief Copy the smallest elements of a sequence.
2340    *  @param  first   An iterator.
2341    *  @param  last    Another iterator.
2342    *  @param  result_first   A random-access iterator.
2343    *  @param  result_last    Another random-access iterator.
2344    *  @return   An iterator indicating the end of the resulting sequence.
2345    *
2346    *  Copies and sorts the smallest N values from the range @p [first,last)
2347    *  to the range beginning at @p result_first, where the number of
2348    *  elements to be copied, @p N, is the smaller of @p (last-first) and
2349    *  @p (result_last-result_first).
2350    *  After the sort if @p i and @j are iterators in the range
2351    *  @p [result_first,result_first+N) such that @i precedes @j then
2352    *  @p *j<*i is false.
2353    *  The value returned is @p result_first+N.
2354   */
2355   template<typename _InputIterator, typename _RandomAccessIterator>
2356     _RandomAccessIterator
2357     partial_sort_copy(_InputIterator __first, _InputIterator __last,
2358                       _RandomAccessIterator __result_first,
2359                       _RandomAccessIterator __result_last)
2360     {
2361       typedef typename iterator_traits<_InputIterator>::value_type
2362         _InputValueType;
2363       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2364         _OutputValueType;
2365       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
2366         _DistanceType;
2367
2368       // concept requirements
2369       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
2370       __glibcxx_function_requires(_ConvertibleConcept<_InputValueType,
2371                                   _OutputValueType>)
2372       __glibcxx_function_requires(_LessThanComparableConcept<_OutputValueType>)
2373       __glibcxx_function_requires(_LessThanComparableConcept<_InputValueType>)
2374       __glibcxx_requires_valid_range(__first, __last);
2375       __glibcxx_requires_valid_range(__result_first, __result_last);
2376
2377       if (__result_first == __result_last)
2378         return __result_last;
2379       _RandomAccessIterator __result_real_last = __result_first;
2380       while(__first != __last && __result_real_last != __result_last)
2381         {
2382           *__result_real_last = *__first;
2383           ++__result_real_last;
2384           ++__first;
2385         }
2386       std::make_heap(__result_first, __result_real_last);
2387       while (__first != __last)
2388         {
2389           if (*__first < *__result_first)
2390             std::__adjust_heap(__result_first, _DistanceType(0),
2391                                _DistanceType(__result_real_last
2392                                              - __result_first),
2393                                _InputValueType(*__first));
2394           ++__first;
2395         }
2396       std::sort_heap(__result_first, __result_real_last);
2397       return __result_real_last;
2398     }
2399
2400   /**
2401    *  @brief Copy the smallest elements of a sequence using a predicate for
2402    *         comparison.
2403    *  @param  first   An input iterator.
2404    *  @param  last    Another input iterator.
2405    *  @param  result_first   A random-access iterator.
2406    *  @param  result_last    Another random-access iterator.
2407    *  @param  comp    A comparison functor.
2408    *  @return   An iterator indicating the end of the resulting sequence.
2409    *
2410    *  Copies and sorts the smallest N values from the range @p [first,last)
2411    *  to the range beginning at @p result_first, where the number of
2412    *  elements to be copied, @p N, is the smaller of @p (last-first) and
2413    *  @p (result_last-result_first).
2414    *  After the sort if @p i and @j are iterators in the range
2415    *  @p [result_first,result_first+N) such that @i precedes @j then
2416    *  @p comp(*j,*i) is false.
2417    *  The value returned is @p result_first+N.
2418   */
2419   template<typename _InputIterator, typename _RandomAccessIterator, typename _Compare>
2420     _RandomAccessIterator
2421     partial_sort_copy(_InputIterator __first, _InputIterator __last,
2422                       _RandomAccessIterator __result_first,
2423                       _RandomAccessIterator __result_last,
2424                       _Compare __comp)
2425     {
2426       typedef typename iterator_traits<_InputIterator>::value_type
2427         _InputValueType;
2428       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2429         _OutputValueType;
2430       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
2431         _DistanceType;
2432
2433       // concept requirements
2434       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
2435       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2436                                   _RandomAccessIterator>)
2437       __glibcxx_function_requires(_ConvertibleConcept<_InputValueType,
2438                                   _OutputValueType>)
2439       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2440                                   _OutputValueType, _OutputValueType>)
2441       __glibcxx_requires_valid_range(__first, __last);
2442       __glibcxx_requires_valid_range(__result_first, __result_last);
2443
2444       if (__result_first == __result_last)
2445         return __result_last;
2446       _RandomAccessIterator __result_real_last = __result_first;
2447       while(__first != __last && __result_real_last != __result_last)
2448         {
2449           *__result_real_last = *__first;
2450           ++__result_real_last;
2451           ++__first;
2452         }
2453       std::make_heap(__result_first, __result_real_last, __comp);
2454       while (__first != __last)
2455         {
2456           if (__comp(*__first, *__result_first))
2457             std::__adjust_heap(__result_first, _DistanceType(0),
2458                                _DistanceType(__result_real_last
2459                                              - __result_first),
2460                                _InputValueType(*__first),
2461                                __comp);
2462           ++__first;
2463         }
2464       std::sort_heap(__result_first, __result_real_last, __comp);
2465       return __result_real_last;
2466     }
2467
2468   /**
2469    *  @if maint
2470    *  This is a helper function for the sort routine.
2471    *  @endif
2472   */
2473   template<typename _RandomAccessIterator, typename _Size>
2474     void
2475     __introsort_loop(_RandomAccessIterator __first,
2476                      _RandomAccessIterator __last,
2477                      _Size __depth_limit)
2478     {
2479       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2480         _ValueType;
2481
2482       while (__last - __first > int(_S_threshold))
2483         {
2484           if (__depth_limit == 0)
2485             {
2486               std::partial_sort(__first, __last, __last);
2487               return;
2488             }
2489           --__depth_limit;
2490           _RandomAccessIterator __cut =
2491             std::__unguarded_partition(__first, __last,
2492                                        _ValueType(std::__median(*__first,
2493                                                                 *(__first
2494                                                                   + (__last
2495                                                                      - __first)
2496                                                                   / 2),
2497                                                                 *(__last
2498                                                                   - 1))));
2499           std::__introsort_loop(__cut, __last, __depth_limit);
2500           __last = __cut;
2501         }
2502     }
2503
2504   /**
2505    *  @if maint
2506    *  This is a helper function for the sort routine.
2507    *  @endif
2508   */
2509   template<typename _RandomAccessIterator, typename _Size, typename _Compare>
2510     void
2511     __introsort_loop(_RandomAccessIterator __first,
2512                      _RandomAccessIterator __last,
2513                      _Size __depth_limit, _Compare __comp)
2514     {
2515       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2516         _ValueType;
2517
2518       while (__last - __first > int(_S_threshold))
2519         {
2520           if (__depth_limit == 0)
2521             {
2522               std::partial_sort(__first, __last, __last, __comp);
2523               return;
2524             }
2525           --__depth_limit;
2526           _RandomAccessIterator __cut =
2527             std::__unguarded_partition(__first, __last,
2528                                        _ValueType(std::__median(*__first,
2529                                                                 *(__first
2530                                                                   + (__last
2531                                                                      - __first)
2532                                                                   / 2),
2533                                                                 *(__last - 1),
2534                                                                 __comp)),
2535                                        __comp);
2536           std::__introsort_loop(__cut, __last, __depth_limit, __comp);
2537           __last = __cut;
2538         }
2539     }
2540
2541   /**
2542    *  @brief Sort the elements of a sequence.
2543    *  @param  first   An iterator.
2544    *  @param  last    Another iterator.
2545    *  @return  Nothing.
2546    *
2547    *  Sorts the elements in the range @p [first,last) in ascending order,
2548    *  such that @p *(i+1)<*i is false for each iterator @p i in the range
2549    *  @p [first,last-1).
2550    *
2551    *  The relative ordering of equivalent elements is not preserved, use
2552    *  @p stable_sort() if this is needed.
2553   */
2554   template<typename _RandomAccessIterator>
2555     inline void
2556     sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2557     {
2558       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2559         _ValueType;
2560
2561       // concept requirements
2562       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2563             _RandomAccessIterator>)
2564       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
2565       __glibcxx_requires_valid_range(__first, __last);
2566
2567       if (__first != __last)
2568         {
2569           std::__introsort_loop(__first, __last, __lg(__last - __first) * 2);
2570           std::__final_insertion_sort(__first, __last);
2571         }
2572     }
2573
2574   /**
2575    *  @brief Sort the elements of a sequence using a predicate for comparison.
2576    *  @param  first   An iterator.
2577    *  @param  last    Another iterator.
2578    *  @param  comp    A comparison functor.
2579    *  @return  Nothing.
2580    *
2581    *  Sorts the elements in the range @p [first,last) in ascending order,
2582    *  such that @p comp(*(i+1),*i) is false for every iterator @p i in the
2583    *  range @p [first,last-1).
2584    *
2585    *  The relative ordering of equivalent elements is not preserved, use
2586    *  @p stable_sort() if this is needed.
2587   */
2588   template<typename _RandomAccessIterator, typename _Compare>
2589     inline void
2590     sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2591          _Compare __comp)
2592     {
2593       typedef typename iterator_traits<_RandomAccessIterator>::value_type
2594         _ValueType;
2595
2596       // concept requirements
2597       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2598             _RandomAccessIterator>)
2599       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare, _ValueType,
2600                                   _ValueType>)
2601       __glibcxx_requires_valid_range(__first, __last);
2602
2603       if (__first != __last)
2604         {
2605           std::__introsort_loop(__first, __last, __lg(__last - __first) * 2,
2606                                 __comp);
2607           std::__final_insertion_sort(__first, __last, __comp);
2608         }
2609     }
2610
2611   /**
2612    *  @brief Finds the first position in which @a val could be inserted
2613    *         without changing the ordering.
2614    *  @param  first   An iterator.
2615    *  @param  last    Another iterator.
2616    *  @param  val     The search term.
2617    *  @return  An iterator pointing to the first element "not less than" @a val,
2618    *           or end() if every element is less than @a val.
2619    *  @ingroup binarysearch
2620   */
2621   template<typename _ForwardIterator, typename _Tp>
2622     _ForwardIterator
2623     lower_bound(_ForwardIterator __first, _ForwardIterator __last,
2624                 const _Tp& __val)
2625     {
2626       typedef typename iterator_traits<_ForwardIterator>::value_type
2627         _ValueType;
2628       typedef typename iterator_traits<_ForwardIterator>::difference_type
2629         _DistanceType;
2630
2631       // concept requirements
2632       // Note that these are slightly stricter than those of the 4-argument
2633       // version, defined next.  The difference is in the strictness of the
2634       // comparison operations... so for looser checking, define your own
2635       // comparison function, as was intended.
2636       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2637       __glibcxx_function_requires(_SameTypeConcept<_Tp, _ValueType>)
2638       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
2639       __glibcxx_requires_partitioned(__first, __last, __val);
2640
2641       _DistanceType __len = std::distance(__first, __last);
2642       _DistanceType __half;
2643       _ForwardIterator __middle;
2644
2645       while (__len > 0)
2646         {
2647           __half = __len >> 1;
2648           __middle = __first;
2649           std::advance(__middle, __half);
2650           if (*__middle < __val)
2651             {
2652               __first = __middle;
2653               ++__first;
2654               __len = __len - __half - 1;
2655             }
2656           else
2657             __len = __half;
2658         }
2659       return __first;
2660     }
2661
2662   /**
2663    *  @brief Finds the first position in which @a val could be inserted
2664    *         without changing the ordering.
2665    *  @param  first   An iterator.
2666    *  @param  last    Another iterator.
2667    *  @param  val     The search term.
2668    *  @param  comp    A functor to use for comparisons.
2669    *  @return  An iterator pointing to the first element "not less than" @a val,
2670    *           or end() if every element is less than @a val.
2671    *  @ingroup binarysearch
2672    *
2673    *  The comparison function should have the same effects on ordering as
2674    *  the function used for the initial sort.
2675   */
2676   template<typename _ForwardIterator, typename _Tp, typename _Compare>
2677     _ForwardIterator
2678     lower_bound(_ForwardIterator __first, _ForwardIterator __last,
2679                 const _Tp& __val, _Compare __comp)
2680     {
2681       typedef typename iterator_traits<_ForwardIterator>::value_type
2682         _ValueType;
2683       typedef typename iterator_traits<_ForwardIterator>::difference_type
2684         _DistanceType;
2685
2686       // concept requirements
2687       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2688       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2689                                   _ValueType, _Tp>)
2690       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
2691
2692       _DistanceType __len = std::distance(__first, __last);
2693       _DistanceType __half;
2694       _ForwardIterator __middle;
2695
2696       while (__len > 0)
2697         {
2698           __half = __len >> 1;
2699           __middle = __first;
2700           std::advance(__middle, __half);
2701           if (__comp(*__middle, __val))
2702             {
2703               __first = __middle;
2704               ++__first;
2705               __len = __len - __half - 1;
2706             }
2707           else
2708             __len = __half;
2709         }
2710       return __first;
2711     }
2712
2713   /**
2714    *  @brief Finds the last position in which @a val could be inserted
2715    *         without changing the ordering.
2716    *  @param  first   An iterator.
2717    *  @param  last    Another iterator.
2718    *  @param  val     The search term.
2719    *  @return  An iterator pointing to the first element greater than @a val,
2720    *           or end() if no elements are greater than @a val.
2721    *  @ingroup binarysearch
2722   */
2723   template<typename _ForwardIterator, typename _Tp>
2724     _ForwardIterator
2725     upper_bound(_ForwardIterator __first, _ForwardIterator __last,
2726                 const _Tp& __val)
2727     {
2728       typedef typename iterator_traits<_ForwardIterator>::value_type
2729         _ValueType;
2730       typedef typename iterator_traits<_ForwardIterator>::difference_type
2731         _DistanceType;
2732
2733       // concept requirements
2734       // See comments on lower_bound.
2735       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2736       __glibcxx_function_requires(_SameTypeConcept<_Tp, _ValueType>)
2737       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
2738       __glibcxx_requires_partitioned(__first, __last, __val);
2739
2740       _DistanceType __len = std::distance(__first, __last);
2741       _DistanceType __half;
2742       _ForwardIterator __middle;
2743
2744       while (__len > 0)
2745         {
2746           __half = __len >> 1;
2747           __middle = __first;
2748           std::advance(__middle, __half);
2749           if (__val < *__middle)
2750             __len = __half;
2751           else
2752             {
2753               __first = __middle;
2754               ++__first;
2755               __len = __len - __half - 1;
2756             }
2757         }
2758       return __first;
2759     }
2760
2761   /**
2762    *  @brief Finds the last position in which @a val could be inserted
2763    *         without changing the ordering.
2764    *  @param  first   An iterator.
2765    *  @param  last    Another iterator.
2766    *  @param  val     The search term.
2767    *  @param  comp    A functor to use for comparisons.
2768    *  @return  An iterator pointing to the first element greater than @a val,
2769    *           or end() if no elements are greater than @a val.
2770    *  @ingroup binarysearch
2771    *
2772    *  The comparison function should have the same effects on ordering as
2773    *  the function used for the initial sort.
2774   */
2775   template<typename _ForwardIterator, typename _Tp, typename _Compare>
2776     _ForwardIterator
2777     upper_bound(_ForwardIterator __first, _ForwardIterator __last,
2778                 const _Tp& __val, _Compare __comp)
2779     {
2780       typedef typename iterator_traits<_ForwardIterator>::value_type
2781         _ValueType;
2782       typedef typename iterator_traits<_ForwardIterator>::difference_type
2783         _DistanceType;
2784
2785       // concept requirements
2786       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2787       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2788                                   _Tp, _ValueType>)
2789       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
2790
2791       _DistanceType __len = std::distance(__first, __last);
2792       _DistanceType __half;
2793       _ForwardIterator __middle;
2794
2795       while (__len > 0)
2796         {
2797           __half = __len >> 1;
2798           __middle = __first;
2799           std::advance(__middle, __half);
2800           if (__comp(__val, *__middle))
2801             __len = __half;
2802           else
2803             {
2804               __first = __middle;
2805               ++__first;
2806               __len = __len - __half - 1;
2807             }
2808         }
2809       return __first;
2810     }
2811
2812   /**
2813    *  @if maint
2814    *  This is a helper function for the merge routines.
2815    *  @endif
2816   */
2817   template<typename _BidirectionalIterator, typename _Distance>
2818     void
2819     __merge_without_buffer(_BidirectionalIterator __first,
2820                            _BidirectionalIterator __middle,
2821                            _BidirectionalIterator __last,
2822                            _Distance __len1, _Distance __len2)
2823     {
2824       if (__len1 == 0 || __len2 == 0)
2825         return;
2826       if (__len1 + __len2 == 2)
2827         {
2828           if (*__middle < *__first)
2829             std::iter_swap(__first, __middle);
2830           return;
2831         }
2832       _BidirectionalIterator __first_cut = __first;
2833       _BidirectionalIterator __second_cut = __middle;
2834       _Distance __len11 = 0;
2835       _Distance __len22 = 0;
2836       if (__len1 > __len2)
2837         {
2838           __len11 = __len1 / 2;
2839           std::advance(__first_cut, __len11);
2840           __second_cut = std::lower_bound(__middle, __last, *__first_cut);
2841           __len22 = std::distance(__middle, __second_cut);
2842         }
2843       else
2844         {
2845           __len22 = __len2 / 2;
2846           std::advance(__second_cut, __len22);
2847           __first_cut = std::upper_bound(__first, __middle, *__second_cut);
2848           __len11 = std::distance(__first, __first_cut);
2849         }
2850       std::rotate(__first_cut, __middle, __second_cut);
2851       _BidirectionalIterator __new_middle = __first_cut;
2852       std::advance(__new_middle, std::distance(__middle, __second_cut));
2853       std::__merge_without_buffer(__first, __first_cut, __new_middle,
2854                                   __len11, __len22);
2855       std::__merge_without_buffer(__new_middle, __second_cut, __last,
2856                                   __len1 - __len11, __len2 - __len22);
2857     }
2858
2859   /**
2860    *  @if maint
2861    *  This is a helper function for the merge routines.
2862    *  @endif
2863   */
2864   template<typename _BidirectionalIterator, typename _Distance,
2865            typename _Compare>
2866     void
2867     __merge_without_buffer(_BidirectionalIterator __first,
2868                            _BidirectionalIterator __middle,
2869                            _BidirectionalIterator __last,
2870                            _Distance __len1, _Distance __len2,
2871                            _Compare __comp)
2872     {
2873       if (__len1 == 0 || __len2 == 0)
2874         return;
2875       if (__len1 + __len2 == 2)
2876         {
2877           if (__comp(*__middle, *__first))
2878             std::iter_swap(__first, __middle);
2879           return;
2880         }
2881       _BidirectionalIterator __first_cut = __first;
2882       _BidirectionalIterator __second_cut = __middle;
2883       _Distance __len11 = 0;
2884       _Distance __len22 = 0;
2885       if (__len1 > __len2)
2886         {
2887           __len11 = __len1 / 2;
2888           std::advance(__first_cut, __len11);
2889           __second_cut = std::lower_bound(__middle, __last, *__first_cut,
2890                                           __comp);
2891           __len22 = std::distance(__middle, __second_cut);
2892         }
2893       else
2894         {
2895           __len22 = __len2 / 2;
2896           std::advance(__second_cut, __len22);
2897           __first_cut = std::upper_bound(__first, __middle, *__second_cut,
2898                                          __comp);
2899           __len11 = std::distance(__first, __first_cut);
2900         }
2901       std::rotate(__first_cut, __middle, __second_cut);
2902       _BidirectionalIterator __new_middle = __first_cut;
2903       std::advance(__new_middle, std::distance(__middle, __second_cut));
2904       std::__merge_without_buffer(__first, __first_cut, __new_middle,
2905                                   __len11, __len22, __comp);
2906       std::__merge_without_buffer(__new_middle, __second_cut, __last,
2907                                   __len1 - __len11, __len2 - __len22, __comp);
2908     }
2909
2910   /**
2911    *  @if maint
2912    *  This is a helper function for the stable sorting routines.
2913    *  @endif
2914   */
2915   template<typename _RandomAccessIterator>
2916     void
2917     __inplace_stable_sort(_RandomAccessIterator __first,
2918                           _RandomAccessIterator __last)
2919     {
2920       if (__last - __first < 15)
2921         {
2922           std::__insertion_sort(__first, __last);
2923           return;
2924         }
2925       _RandomAccessIterator __middle = __first + (__last - __first) / 2;
2926       std::__inplace_stable_sort(__first, __middle);
2927       std::__inplace_stable_sort(__middle, __last);
2928       std::__merge_without_buffer(__first, __middle, __last,
2929                                   __middle - __first,
2930                                   __last - __middle);
2931     }
2932
2933   /**
2934    *  @if maint
2935    *  This is a helper function for the stable sorting routines.
2936    *  @endif
2937   */
2938   template<typename _RandomAccessIterator, typename _Compare>
2939     void
2940     __inplace_stable_sort(_RandomAccessIterator __first,
2941                           _RandomAccessIterator __last, _Compare __comp)
2942     {
2943       if (__last - __first < 15)
2944         {
2945           std::__insertion_sort(__first, __last, __comp);
2946           return;
2947         }
2948       _RandomAccessIterator __middle = __first + (__last - __first) / 2;
2949       std::__inplace_stable_sort(__first, __middle, __comp);
2950       std::__inplace_stable_sort(__middle, __last, __comp);
2951       std::__merge_without_buffer(__first, __middle, __last,
2952                                   __middle - __first,
2953                                   __last - __middle,
2954                                   __comp);
2955     }
2956
2957   /**
2958    *  @brief Merges two sorted ranges.
2959    *  @param  first1  An iterator.
2960    *  @param  first2  Another iterator.
2961    *  @param  last1   Another iterator.
2962    *  @param  last2   Another iterator.
2963    *  @param  result  An iterator pointing to the end of the merged range.
2964    *  @return  An iterator pointing to the first element "not less than" @a val.
2965    *
2966    *  Merges the ranges [first1,last1) and [first2,last2) into the sorted range
2967    *  [result, result + (last1-first1) + (last2-first2)).  Both input ranges
2968    *  must be sorted, and the output range must not overlap with either of
2969    *  the input ranges.  The sort is @e stable, that is, for equivalent
2970    *  elements in the two ranges, elements from the first range will always
2971    *  come before elements from the second.
2972   */
2973   template<typename _InputIterator1, typename _InputIterator2,
2974            typename _OutputIterator>
2975     _OutputIterator
2976     merge(_InputIterator1 __first1, _InputIterator1 __last1,
2977           _InputIterator2 __first2, _InputIterator2 __last2,
2978           _OutputIterator __result)
2979     {
2980       // concept requirements
2981       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
2982       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
2983       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
2984             typename iterator_traits<_InputIterator1>::value_type>)
2985       __glibcxx_function_requires(_SameTypeConcept<
2986             typename iterator_traits<_InputIterator1>::value_type,
2987             typename iterator_traits<_InputIterator2>::value_type>)
2988       __glibcxx_function_requires(_LessThanComparableConcept<
2989             typename iterator_traits<_InputIterator1>::value_type>)
2990       __glibcxx_requires_sorted(__first1, __last1);
2991       __glibcxx_requires_sorted(__first2, __last2);
2992
2993       while (__first1 != __last1 && __first2 != __last2)
2994         {
2995           if (*__first2 < *__first1)
2996             {
2997               *__result = *__first2;
2998               ++__first2;
2999             }
3000           else
3001             {
3002               *__result = *__first1;
3003               ++__first1;
3004             }
3005           ++__result;
3006         }
3007       return std::copy(__first2, __last2, std::copy(__first1, __last1,
3008                                                     __result));
3009     }
3010
3011   /**
3012    *  @brief Merges two sorted ranges.
3013    *  @param  first1  An iterator.
3014    *  @param  first2  Another iterator.
3015    *  @param  last1   Another iterator.
3016    *  @param  last2   Another iterator.
3017    *  @param  result  An iterator pointing to the end of the merged range.
3018    *  @param  comp    A functor to use for comparisons.
3019    *  @return  An iterator pointing to the first element "not less than" @a val.
3020    *
3021    *  Merges the ranges [first1,last1) and [first2,last2) into the sorted range
3022    *  [result, result + (last1-first1) + (last2-first2)).  Both input ranges
3023    *  must be sorted, and the output range must not overlap with either of
3024    *  the input ranges.  The sort is @e stable, that is, for equivalent
3025    *  elements in the two ranges, elements from the first range will always
3026    *  come before elements from the second.
3027    *
3028    *  The comparison function should have the same effects on ordering as
3029    *  the function used for the initial sort.
3030   */
3031   template<typename _InputIterator1, typename _InputIterator2,
3032            typename _OutputIterator, typename _Compare>
3033     _OutputIterator
3034     merge(_InputIterator1 __first1, _InputIterator1 __last1,
3035           _InputIterator2 __first2, _InputIterator2 __last2,
3036           _OutputIterator __result, _Compare __comp)
3037     {
3038       // concept requirements
3039       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
3040       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
3041       __glibcxx_function_requires(_SameTypeConcept<
3042             typename iterator_traits<_InputIterator1>::value_type,
3043             typename iterator_traits<_InputIterator2>::value_type>)
3044       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
3045             typename iterator_traits<_InputIterator1>::value_type>)
3046       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3047             typename iterator_traits<_InputIterator1>::value_type,
3048             typename iterator_traits<_InputIterator2>::value_type>)
3049       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
3050       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
3051
3052       while (__first1 != __last1 && __first2 != __last2)
3053         {
3054           if (__comp(*__first2, *__first1))
3055             {
3056               *__result = *__first2;
3057               ++__first2;
3058             }
3059           else
3060             {
3061               *__result = *__first1;
3062               ++__first1;
3063             }
3064           ++__result;
3065         }
3066       return std::copy(__first2, __last2, std::copy(__first1, __last1,
3067                                                     __result));
3068     }
3069
3070   template<typename _RandomAccessIterator1, typename _RandomAccessIterator2,
3071            typename _Distance>
3072     void
3073     __merge_sort_loop(_RandomAccessIterator1 __first,
3074                       _RandomAccessIterator1 __last,
3075                       _RandomAccessIterator2 __result,
3076                       _Distance __step_size)
3077     {
3078       const _Distance __two_step = 2 * __step_size;
3079
3080       while (__last - __first >= __two_step)
3081         {
3082           __result = std::merge(__first, __first + __step_size,
3083                                 __first + __step_size, __first + __two_step,
3084                                 __result);
3085           __first += __two_step;
3086         }
3087
3088       __step_size = std::min(_Distance(__last - __first), __step_size);
3089       std::merge(__first, __first + __step_size, __first + __step_size, __last,
3090                  __result);
3091     }
3092
3093   template<typename _RandomAccessIterator1, typename _RandomAccessIterator2,
3094            typename _Distance, typename _Compare>
3095     void
3096     __merge_sort_loop(_RandomAccessIterator1 __first,
3097                       _RandomAccessIterator1 __last,
3098                       _RandomAccessIterator2 __result, _Distance __step_size,
3099                       _Compare __comp)
3100     {
3101       const _Distance __two_step = 2 * __step_size;
3102
3103       while (__last - __first >= __two_step)
3104         {
3105           __result = std::merge(__first, __first + __step_size,
3106                                 __first + __step_size, __first + __two_step,
3107                                 __result,
3108                                 __comp);
3109           __first += __two_step;
3110         }
3111       __step_size = std::min(_Distance(__last - __first), __step_size);
3112
3113       std::merge(__first, __first + __step_size,
3114                  __first + __step_size, __last,
3115                  __result,
3116                  __comp);
3117     }
3118
3119   enum { _S_chunk_size = 7 };
3120
3121   template<typename _RandomAccessIterator, typename _Distance>
3122     void
3123     __chunk_insertion_sort(_RandomAccessIterator __first,
3124                            _RandomAccessIterator __last,
3125                            _Distance __chunk_size)
3126     {
3127       while (__last - __first >= __chunk_size)
3128         {
3129           std::__insertion_sort(__first, __first + __chunk_size);
3130           __first += __chunk_size;
3131         }
3132       std::__insertion_sort(__first, __last);
3133     }
3134
3135   template<typename _RandomAccessIterator, typename _Distance, typename _Compare>
3136     void
3137     __chunk_insertion_sort(_RandomAccessIterator __first,
3138                            _RandomAccessIterator __last,
3139                            _Distance __chunk_size, _Compare __comp)
3140     {
3141       while (__last - __first >= __chunk_size)
3142         {
3143           std::__insertion_sort(__first, __first + __chunk_size, __comp);
3144           __first += __chunk_size;
3145         }
3146       std::__insertion_sort(__first, __last, __comp);
3147     }
3148
3149   template<typename _RandomAccessIterator, typename _Pointer>
3150     void
3151     __merge_sort_with_buffer(_RandomAccessIterator __first,
3152                              _RandomAccessIterator __last,
3153                              _Pointer __buffer)
3154     {
3155       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
3156         _Distance;
3157
3158       const _Distance __len = __last - __first;
3159       const _Pointer __buffer_last = __buffer + __len;
3160
3161       _Distance __step_size = _S_chunk_size;
3162       std::__chunk_insertion_sort(__first, __last, __step_size);
3163
3164       while (__step_size < __len)
3165         {
3166           std::__merge_sort_loop(__first, __last, __buffer, __step_size);
3167           __step_size *= 2;
3168           std::__merge_sort_loop(__buffer, __buffer_last, __first, __step_size);
3169           __step_size *= 2;
3170         }
3171     }
3172
3173   template<typename _RandomAccessIterator, typename _Pointer, typename _Compare>
3174     void
3175     __merge_sort_with_buffer(_RandomAccessIterator __first,
3176                              _RandomAccessIterator __last,
3177                              _Pointer __buffer, _Compare __comp)
3178     {
3179       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
3180         _Distance;
3181
3182       const _Distance __len = __last - __first;
3183       const _Pointer __buffer_last = __buffer + __len;
3184
3185       _Distance __step_size = _S_chunk_size;
3186       std::__chunk_insertion_sort(__first, __last, __step_size, __comp);
3187
3188       while (__step_size < __len)
3189         {
3190           std::__merge_sort_loop(__first, __last, __buffer,
3191                                  __step_size, __comp);
3192           __step_size *= 2;
3193           std::__merge_sort_loop(__buffer, __buffer_last, __first,
3194                                  __step_size, __comp);
3195           __step_size *= 2;
3196         }
3197     }
3198
3199   /**
3200    *  @if maint
3201    *  This is a helper function for the merge routines.
3202    *  @endif
3203   */
3204   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
3205            typename _BidirectionalIterator3>
3206     _BidirectionalIterator3
3207     __merge_backward(_BidirectionalIterator1 __first1,
3208                      _BidirectionalIterator1 __last1,
3209                      _BidirectionalIterator2 __first2,
3210                      _BidirectionalIterator2 __last2,
3211                      _BidirectionalIterator3 __result)
3212     {
3213       if (__first1 == __last1)
3214         return std::copy_backward(__first2, __last2, __result);
3215       if (__first2 == __last2)
3216         return std::copy_backward(__first1, __last1, __result);
3217       --__last1;
3218       --__last2;
3219       while (true)
3220         {
3221           if (*__last2 < *__last1)
3222             {
3223               *--__result = *__last1;
3224               if (__first1 == __last1)
3225                 return std::copy_backward(__first2, ++__last2, __result);
3226               --__last1;
3227             }
3228           else
3229             {
3230               *--__result = *__last2;
3231               if (__first2 == __last2)
3232                 return std::copy_backward(__first1, ++__last1, __result);
3233               --__last2;
3234             }
3235         }
3236     }
3237
3238   /**
3239    *  @if maint
3240    *  This is a helper function for the merge routines.
3241    *  @endif
3242   */
3243   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
3244            typename _BidirectionalIterator3, typename _Compare>
3245     _BidirectionalIterator3
3246     __merge_backward(_BidirectionalIterator1 __first1,
3247                      _BidirectionalIterator1 __last1,
3248                      _BidirectionalIterator2 __first2,
3249                      _BidirectionalIterator2 __last2,
3250                      _BidirectionalIterator3 __result,
3251                      _Compare __comp)
3252     {
3253       if (__first1 == __last1)
3254         return std::copy_backward(__first2, __last2, __result);
3255       if (__first2 == __last2)
3256         return std::copy_backward(__first1, __last1, __result);
3257       --__last1;
3258       --__last2;
3259       while (true)
3260         {
3261           if (__comp(*__last2, *__last1))
3262             {
3263               *--__result = *__last1;
3264               if (__first1 == __last1)
3265                 return std::copy_backward(__first2, ++__last2, __result);
3266               --__last1;
3267             }
3268           else
3269             {
3270               *--__result = *__last2;
3271               if (__first2 == __last2)
3272                 return std::copy_backward(__first1, ++__last1, __result);
3273               --__last2;
3274             }
3275         }
3276     }
3277
3278   /**
3279    *  @if maint
3280    *  This is a helper function for the merge routines.
3281    *  @endif
3282   */
3283   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
3284            typename _Distance>
3285     _BidirectionalIterator1
3286     __rotate_adaptive(_BidirectionalIterator1 __first,
3287                       _BidirectionalIterator1 __middle,
3288                       _BidirectionalIterator1 __last,
3289                       _Distance __len1, _Distance __len2,
3290                       _BidirectionalIterator2 __buffer,
3291                       _Distance __buffer_size)
3292     {
3293       _BidirectionalIterator2 __buffer_end;
3294       if (__len1 > __len2 && __len2 <= __buffer_size)
3295         {
3296           __buffer_end = std::copy(__middle, __last, __buffer);
3297           std::copy_backward(__first, __middle, __last);
3298           return std::copy(__buffer, __buffer_end, __first);
3299         }
3300       else if (__len1 <= __buffer_size)
3301         {
3302           __buffer_end = std::copy(__first, __middle, __buffer);
3303           std::copy(__middle, __last, __first);
3304           return std::copy_backward(__buffer, __buffer_end, __last);
3305         }
3306       else
3307         {
3308           std::rotate(__first, __middle, __last);
3309           std::advance(__first, std::distance(__middle, __last));
3310           return __first;
3311         }
3312     }
3313
3314   /**
3315    *  @if maint
3316    *  This is a helper function for the merge routines.
3317    *  @endif
3318   */
3319   template<typename _BidirectionalIterator, typename _Distance,
3320            typename _Pointer>
3321     void
3322     __merge_adaptive(_BidirectionalIterator __first,
3323                      _BidirectionalIterator __middle,
3324                      _BidirectionalIterator __last,
3325                      _Distance __len1, _Distance __len2,
3326                      _Pointer __buffer, _Distance __buffer_size)
3327     {
3328       if (__len1 <= __len2 && __len1 <= __buffer_size)
3329         {
3330           _Pointer __buffer_end = std::copy(__first, __middle, __buffer);
3331           std::merge(__buffer, __buffer_end, __middle, __last, __first);
3332         }
3333       else if (__len2 <= __buffer_size)
3334         {
3335           _Pointer __buffer_end = std::copy(__middle, __last, __buffer);
3336           std::__merge_backward(__first, __middle, __buffer,
3337                                 __buffer_end, __last);
3338         }
3339       else
3340         {
3341           _BidirectionalIterator __first_cut = __first;
3342           _BidirectionalIterator __second_cut = __middle;
3343           _Distance __len11 = 0;
3344           _Distance __len22 = 0;
3345           if (__len1 > __len2)
3346             {
3347               __len11 = __len1 / 2;
3348               std::advance(__first_cut, __len11);
3349               __second_cut = std::lower_bound(__middle, __last,
3350                                               *__first_cut);
3351               __len22 = std::distance(__middle, __second_cut);
3352             }
3353           else
3354             {
3355               __len22 = __len2 / 2;
3356               std::advance(__second_cut, __len22);
3357               __first_cut = std::upper_bound(__first, __middle,
3358                                              *__second_cut);
3359               __len11 = std::distance(__first, __first_cut);
3360             }
3361           _BidirectionalIterator __new_middle =
3362             std::__rotate_adaptive(__first_cut, __middle, __second_cut,
3363                                    __len1 - __len11, __len22, __buffer,
3364                                    __buffer_size);
3365           std::__merge_adaptive(__first, __first_cut, __new_middle, __len11,
3366                                 __len22, __buffer, __buffer_size);
3367           std::__merge_adaptive(__new_middle, __second_cut, __last,
3368                                 __len1 - __len11,
3369                                 __len2 - __len22, __buffer, __buffer_size);
3370         }
3371     }
3372
3373   /**
3374    *  @if maint
3375    *  This is a helper function for the merge routines.
3376    *  @endif
3377   */
3378   template<typename _BidirectionalIterator, typename _Distance, typename _Pointer,
3379            typename _Compare>
3380     void
3381     __merge_adaptive(_BidirectionalIterator __first,
3382                      _BidirectionalIterator __middle,
3383                      _BidirectionalIterator __last,
3384                      _Distance __len1, _Distance __len2,
3385                      _Pointer __buffer, _Distance __buffer_size,
3386                      _Compare __comp)
3387     {
3388       if (__len1 <= __len2 && __len1 <= __buffer_size)
3389         {
3390           _Pointer __buffer_end = std::copy(__first, __middle, __buffer);
3391           std::merge(__buffer, __buffer_end, __middle, __last, __first, __comp);
3392         }
3393       else if (__len2 <= __buffer_size)
3394         {
3395           _Pointer __buffer_end = std::copy(__middle, __last, __buffer);
3396           std::__merge_backward(__first, __middle, __buffer, __buffer_end,
3397                                 __last, __comp);
3398         }
3399       else
3400         {
3401           _BidirectionalIterator __first_cut = __first;
3402           _BidirectionalIterator __second_cut = __middle;
3403           _Distance __len11 = 0;
3404           _Distance __len22 = 0;
3405           if (__len1 > __len2)
3406             {
3407               __len11 = __len1 / 2;
3408               std::advance(__first_cut, __len11);
3409               __second_cut = std::lower_bound(__middle, __last, *__first_cut,
3410                                               __comp);
3411               __len22 = std::distance(__middle, __second_cut);
3412             }
3413           else
3414             {
3415               __len22 = __len2 / 2;
3416               std::advance(__second_cut, __len22);
3417               __first_cut = std::upper_bound(__first, __middle, *__second_cut,
3418                                              __comp);
3419               __len11 = std::distance(__first, __first_cut);
3420             }
3421           _BidirectionalIterator __new_middle =
3422             std::__rotate_adaptive(__first_cut, __middle, __second_cut,
3423                                    __len1 - __len11, __len22, __buffer,
3424                                    __buffer_size);
3425           std::__merge_adaptive(__first, __first_cut, __new_middle, __len11,
3426                                 __len22, __buffer, __buffer_size, __comp);
3427           std::__merge_adaptive(__new_middle, __second_cut, __last,
3428                                 __len1 - __len11,
3429                                 __len2 - __len22, __buffer,
3430                                 __buffer_size, __comp);
3431         }
3432     }
3433
3434   /**
3435    *  @brief Merges two sorted ranges in place.
3436    *  @param  first   An iterator.
3437    *  @param  middle  Another iterator.
3438    *  @param  last    Another iterator.
3439    *  @return  Nothing.
3440    *
3441    *  Merges two sorted and consecutive ranges, [first,middle) and
3442    *  [middle,last), and puts the result in [first,last).  The output will
3443    *  be sorted.  The sort is @e stable, that is, for equivalent
3444    *  elements in the two ranges, elements from the first range will always
3445    *  come before elements from the second.
3446    *
3447    *  If enough additional memory is available, this takes (last-first)-1
3448    *  comparisons.  Otherwise an NlogN algorithm is used, where N is
3449    *  distance(first,last).
3450   */
3451   template<typename _BidirectionalIterator>
3452     void
3453     inplace_merge(_BidirectionalIterator __first,
3454                   _BidirectionalIterator __middle,
3455                   _BidirectionalIterator __last)
3456     {
3457       typedef typename iterator_traits<_BidirectionalIterator>::value_type
3458           _ValueType;
3459       typedef typename iterator_traits<_BidirectionalIterator>::difference_type
3460           _DistanceType;
3461
3462       // concept requirements
3463       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
3464             _BidirectionalIterator>)
3465       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
3466       __glibcxx_requires_sorted(__first, __middle);
3467       __glibcxx_requires_sorted(__middle, __last);
3468
3469       if (__first == __middle || __middle == __last)
3470         return;
3471
3472       _DistanceType __len1 = std::distance(__first, __middle);
3473       _DistanceType __len2 = std::distance(__middle, __last);
3474
3475       _Temporary_buffer<_BidirectionalIterator, _ValueType> __buf(__first,
3476                                                                   __last);
3477       if (__buf.begin() == 0)
3478         std::__merge_without_buffer(__first, __middle, __last, __len1, __len2);
3479       else
3480         std::__merge_adaptive(__first, __middle, __last, __len1, __len2,
3481                               __buf.begin(), _DistanceType(__buf.size()));
3482     }
3483
3484   /**
3485    *  @brief Merges two sorted ranges in place.
3486    *  @param  first   An iterator.
3487    *  @param  middle  Another iterator.
3488    *  @param  last    Another iterator.
3489    *  @param  comp    A functor to use for comparisons.
3490    *  @return  Nothing.
3491    *
3492    *  Merges two sorted and consecutive ranges, [first,middle) and
3493    *  [middle,last), and puts the result in [first,last).  The output will
3494    *  be sorted.  The sort is @e stable, that is, for equivalent
3495    *  elements in the two ranges, elements from the first range will always
3496    *  come before elements from the second.
3497    *
3498    *  If enough additional memory is available, this takes (last-first)-1
3499    *  comparisons.  Otherwise an NlogN algorithm is used, where N is
3500    *  distance(first,last).
3501    *
3502    *  The comparison function should have the same effects on ordering as
3503    *  the function used for the initial sort.
3504   */
3505   template<typename _BidirectionalIterator, typename _Compare>
3506     void
3507     inplace_merge(_BidirectionalIterator __first,
3508                   _BidirectionalIterator __middle,
3509                   _BidirectionalIterator __last,
3510                   _Compare __comp)
3511     {
3512       typedef typename iterator_traits<_BidirectionalIterator>::value_type
3513           _ValueType;
3514       typedef typename iterator_traits<_BidirectionalIterator>::difference_type
3515           _DistanceType;
3516
3517       // concept requirements
3518       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
3519             _BidirectionalIterator>)
3520       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3521             _ValueType, _ValueType>)
3522       __glibcxx_requires_sorted_pred(__first, __middle, __comp);
3523       __glibcxx_requires_sorted_pred(__middle, __last, __comp);
3524
3525       if (__first == __middle || __middle == __last)
3526         return;
3527
3528       const _DistanceType __len1 = std::distance(__first, __middle);
3529       const _DistanceType __len2 = std::distance(__middle, __last);
3530
3531       _Temporary_buffer<_BidirectionalIterator, _ValueType> __buf(__first,
3532                                                                   __last);
3533       if (__buf.begin() == 0)
3534         std::__merge_without_buffer(__first, __middle, __last, __len1,
3535                                     __len2, __comp);
3536       else
3537         std::__merge_adaptive(__first, __middle, __last, __len1, __len2,
3538                               __buf.begin(), _DistanceType(__buf.size()),
3539                               __comp);
3540     }
3541
3542   template<typename _RandomAccessIterator, typename _Pointer,
3543            typename _Distance>
3544     void
3545     __stable_sort_adaptive(_RandomAccessIterator __first,
3546                            _RandomAccessIterator __last,
3547                            _Pointer __buffer, _Distance __buffer_size)
3548     {
3549       const _Distance __len = (__last - __first + 1) / 2;
3550       const _RandomAccessIterator __middle = __first + __len;
3551       if (__len > __buffer_size)
3552         {
3553           std::__stable_sort_adaptive(__first, __middle,
3554                                       __buffer, __buffer_size);
3555           std::__stable_sort_adaptive(__middle, __last,
3556                                       __buffer, __buffer_size);
3557         }
3558       else
3559         {
3560           std::__merge_sort_with_buffer(__first, __middle, __buffer);
3561           std::__merge_sort_with_buffer(__middle, __last, __buffer);
3562         }
3563       std::__merge_adaptive(__first, __middle, __last,
3564                             _Distance(__middle - __first),
3565                             _Distance(__last - __middle),
3566                             __buffer, __buffer_size);
3567     }
3568
3569   template<typename _RandomAccessIterator, typename _Pointer,
3570            typename _Distance, typename _Compare>
3571     void
3572     __stable_sort_adaptive(_RandomAccessIterator __first,
3573                            _RandomAccessIterator __last,
3574                            _Pointer __buffer, _Distance __buffer_size,
3575                            _Compare __comp)
3576     {
3577       const _Distance __len = (__last - __first + 1) / 2;
3578       const _RandomAccessIterator __middle = __first + __len;
3579       if (__len > __buffer_size)
3580         {
3581           std::__stable_sort_adaptive(__first, __middle, __buffer,
3582                                       __buffer_size, __comp);
3583           std::__stable_sort_adaptive(__middle, __last, __buffer,
3584                                       __buffer_size, __comp);
3585         }
3586       else
3587         {
3588           std::__merge_sort_with_buffer(__first, __middle, __buffer, __comp);
3589           std::__merge_sort_with_buffer(__middle, __last, __buffer, __comp);
3590         }
3591       std::__merge_adaptive(__first, __middle, __last,
3592                             _Distance(__middle - __first),
3593                             _Distance(__last - __middle),
3594                             __buffer, __buffer_size,
3595                             __comp);
3596     }
3597
3598   /**
3599    *  @brief Sort the elements of a sequence, preserving the relative order
3600    *         of equivalent elements.
3601    *  @param  first   An iterator.
3602    *  @param  last    Another iterator.
3603    *  @return  Nothing.
3604    *
3605    *  Sorts the elements in the range @p [first,last) in ascending order,
3606    *  such that @p *(i+1)<*i is false for each iterator @p i in the range
3607    *  @p [first,last-1).
3608    *
3609    *  The relative ordering of equivalent elements is preserved, so any two
3610    *  elements @p x and @p y in the range @p [first,last) such that
3611    *  @p x<y is false and @p y<x is false will have the same relative
3612    *  ordering after calling @p stable_sort().
3613   */
3614   template<typename _RandomAccessIterator>
3615     inline void
3616     stable_sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
3617     {
3618       typedef typename iterator_traits<_RandomAccessIterator>::value_type
3619         _ValueType;
3620       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
3621         _DistanceType;
3622
3623       // concept requirements
3624       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
3625             _RandomAccessIterator>)
3626       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
3627       __glibcxx_requires_valid_range(__first, __last);
3628
3629       _Temporary_buffer<_RandomAccessIterator, _ValueType>
3630         buf(__first, __last);
3631       if (buf.begin() == 0)
3632         std::__inplace_stable_sort(__first, __last);
3633       else
3634         std::__stable_sort_adaptive(__first, __last, buf.begin(),
3635                                     _DistanceType(buf.size()));
3636     }
3637
3638   /**
3639    *  @brief Sort the elements of a sequence using a predicate for comparison,
3640    *         preserving the relative order of equivalent elements.
3641    *  @param  first   An iterator.
3642    *  @param  last    Another iterator.
3643    *  @param  comp    A comparison functor.
3644    *  @return  Nothing.
3645    *
3646    *  Sorts the elements in the range @p [first,last) in ascending order,
3647    *  such that @p comp(*(i+1),*i) is false for each iterator @p i in the
3648    *  range @p [first,last-1).
3649    *
3650    *  The relative ordering of equivalent elements is preserved, so any two
3651    *  elements @p x and @p y in the range @p [first,last) such that
3652    *  @p comp(x,y) is false and @p comp(y,x) is false will have the same
3653    *  relative ordering after calling @p stable_sort().
3654   */
3655   template<typename _RandomAccessIterator, typename _Compare>
3656     inline void
3657     stable_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
3658                 _Compare __comp)
3659     {
3660       typedef typename iterator_traits<_RandomAccessIterator>::value_type
3661         _ValueType;
3662       typedef typename iterator_traits<_RandomAccessIterator>::difference_type
3663         _DistanceType;
3664
3665       // concept requirements
3666       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
3667             _RandomAccessIterator>)
3668       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3669                                   _ValueType,
3670                                   _ValueType>)
3671       __glibcxx_requires_valid_range(__first, __last);
3672
3673       _Temporary_buffer<_RandomAccessIterator, _ValueType> buf(__first, __last);
3674       if (buf.begin() == 0)
3675         std::__inplace_stable_sort(__first, __last, __comp);
3676       else
3677         std::__stable_sort_adaptive(__first, __last, buf.begin(),
3678                                     _DistanceType(buf.size()), __comp);
3679     }
3680
3681   /**
3682    *  @brief Sort a sequence just enough to find a particular position.
3683    *  @param  first   An iterator.
3684    *  @param  nth     Another iterator.
3685    *  @param  last    Another iterator.
3686    *  @return  Nothing.
3687    *
3688    *  Rearranges the elements in the range @p [first,last) so that @p *nth
3689    *  is the same element that would have been in that position had the
3690    *  whole sequence been sorted.
3691    *  whole sequence been sorted. The elements either side of @p *nth are
3692    *  not completely sorted, but for any iterator @i in the range
3693    *  @p [first,nth) and any iterator @j in the range @p [nth,last) it
3694    *  holds that @p *j<*i is false.
3695   */
3696   template<typename _RandomAccessIterator>
3697     void
3698     nth_element(_RandomAccessIterator __first,
3699                 _RandomAccessIterator __nth,
3700                 _RandomAccessIterator __last)
3701     {
3702       typedef typename iterator_traits<_RandomAccessIterator>::value_type
3703         _ValueType;
3704
3705       // concept requirements
3706       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
3707                                   _RandomAccessIterator>)
3708       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
3709       __glibcxx_requires_valid_range(__first, __nth);
3710       __glibcxx_requires_valid_range(__nth, __last);
3711
3712       while (__last - __first > 3)
3713         {
3714           _RandomAccessIterator __cut =
3715             std::__unguarded_partition(__first, __last,
3716                                        _ValueType(std::__median(*__first,
3717                                                                 *(__first
3718                                                                   + (__last
3719                                                                      - __first)
3720                                                                   / 2),
3721                                                                 *(__last
3722                                                                   - 1))));
3723           if (__cut <= __nth)
3724             __first = __cut;
3725           else
3726             __last = __cut;
3727         }
3728       std::__insertion_sort(__first, __last);
3729     }
3730
3731   /**
3732    *  @brief Sort a sequence just enough to find a particular position
3733    *         using a predicate for comparison.
3734    *  @param  first   An iterator.
3735    *  @param  nth     Another iterator.
3736    *  @param  last    Another iterator.
3737    *  @param  comp    A comparison functor.
3738    *  @return  Nothing.
3739    *
3740    *  Rearranges the elements in the range @p [first,last) so that @p *nth
3741    *  is the same element that would have been in that position had the
3742    *  whole sequence been sorted. The elements either side of @p *nth are
3743    *  not completely sorted, but for any iterator @i in the range
3744    *  @p [first,nth) and any iterator @j in the range @p [nth,last) it
3745    *  holds that @p comp(*j,*i) is false.
3746   */
3747   template<typename _RandomAccessIterator, typename _Compare>
3748     void
3749     nth_element(_RandomAccessIterator __first,
3750                 _RandomAccessIterator __nth,
3751                 _RandomAccessIterator __last,
3752                             _Compare __comp)
3753     {
3754       typedef typename iterator_traits<_RandomAccessIterator>::value_type
3755         _ValueType;
3756
3757       // concept requirements
3758       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
3759                                   _RandomAccessIterator>)
3760       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3761                                   _ValueType, _ValueType>)
3762       __glibcxx_requires_valid_range(__first, __nth);
3763       __glibcxx_requires_valid_range(__nth, __last);
3764
3765       while (__last - __first > 3)
3766         {
3767           _RandomAccessIterator __cut =
3768             std::__unguarded_partition(__first, __last,
3769                                        _ValueType(std::__median(*__first,
3770                                                                 *(__first
3771                                                                   + (__last
3772                                                                      - __first)
3773                                                                   / 2),
3774                                                                 *(__last - 1),
3775                                                               __comp)), __comp);
3776           if (__cut <= __nth)
3777             __first = __cut;
3778           else
3779             __last = __cut;
3780         }
3781       std::__insertion_sort(__first, __last, __comp);
3782     }
3783
3784   /**
3785    *  @brief Finds the largest subrange in which @a val could be inserted
3786    *         at any place in it without changing the ordering.
3787    *  @param  first   An iterator.
3788    *  @param  last    Another iterator.
3789    *  @param  val     The search term.
3790    *  @return  An pair of iterators defining the subrange.
3791    *  @ingroup binarysearch
3792    *
3793    *  This is equivalent to
3794    *  @code
3795    *    std::make_pair(lower_bound(first, last, val),
3796    *                   upper_bound(first, last, val))
3797    *  @endcode
3798    *  but does not actually call those functions.
3799   */
3800   template<typename _ForwardIterator, typename _Tp>
3801     pair<_ForwardIterator, _ForwardIterator>
3802     equal_range(_ForwardIterator __first, _ForwardIterator __last,
3803                 const _Tp& __val)
3804     {
3805       typedef typename iterator_traits<_ForwardIterator>::value_type
3806         _ValueType;
3807       typedef typename iterator_traits<_ForwardIterator>::difference_type
3808         _DistanceType;
3809
3810       // concept requirements
3811       // See comments on lower_bound.
3812       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
3813       __glibcxx_function_requires(_SameTypeConcept<_Tp, _ValueType>)
3814       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
3815       __glibcxx_requires_partitioned(__first, __last, __val);
3816
3817       _DistanceType __len = std::distance(__first, __last);
3818       _DistanceType __half;
3819       _ForwardIterator __middle, __left, __right;
3820
3821       while (__len > 0)
3822         {
3823           __half = __len >> 1;
3824           __middle = __first;
3825           std::advance(__middle, __half);
3826           if (*__middle < __val)
3827             {
3828               __first = __middle;
3829               ++__first;
3830               __len = __len - __half - 1;
3831             }
3832           else if (__val < *__middle)
3833             __len = __half;
3834           else
3835             {
3836               __left = std::lower_bound(__first, __middle, __val);
3837               std::advance(__first, __len);
3838               __right = std::upper_bound(++__middle, __first, __val);
3839               return pair<_ForwardIterator, _ForwardIterator>(__left, __right);
3840             }
3841         }
3842       return pair<_ForwardIterator, _ForwardIterator>(__first, __first);
3843     }
3844
3845   /**
3846    *  @brief Finds the largest subrange in which @a val could be inserted
3847    *         at any place in it without changing the ordering.
3848    *  @param  first   An iterator.
3849    *  @param  last    Another iterator.
3850    *  @param  val     The search term.
3851    *  @param  comp    A functor to use for comparisons.
3852    *  @return  An pair of iterators defining the subrange.
3853    *  @ingroup binarysearch
3854    *
3855    *  This is equivalent to
3856    *  @code
3857    *    std::make_pair(lower_bound(first, last, val, comp),
3858    *                   upper_bound(first, last, val, comp))
3859    *  @endcode
3860    *  but does not actually call those functions.
3861   */
3862   template<typename _ForwardIterator, typename _Tp, typename _Compare>
3863     pair<_ForwardIterator, _ForwardIterator>
3864     equal_range(_ForwardIterator __first, _ForwardIterator __last,
3865                 const _Tp& __val,
3866                 _Compare __comp)
3867     {
3868       typedef typename iterator_traits<_ForwardIterator>::value_type
3869         _ValueType;
3870       typedef typename iterator_traits<_ForwardIterator>::difference_type
3871         _DistanceType;
3872
3873       // concept requirements
3874       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
3875       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3876                                   _ValueType, _Tp>)
3877       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3878                                   _Tp, _ValueType>)
3879       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
3880
3881       _DistanceType __len = std::distance(__first, __last);
3882       _DistanceType __half;
3883       _ForwardIterator __middle, __left, __right;
3884
3885       while (__len > 0)
3886         {
3887           __half = __len >> 1;
3888           __middle = __first;
3889           std::advance(__middle, __half);
3890           if (__comp(*__middle, __val))
3891             {
3892               __first = __middle;
3893               ++__first;
3894               __len = __len - __half - 1;
3895             }
3896           else if (__comp(__val, *__middle))
3897             __len = __half;
3898           else
3899             {
3900               __left = std::lower_bound(__first, __middle, __val, __comp);
3901               std::advance(__first, __len);
3902               __right = std::upper_bound(++__middle, __first, __val, __comp);
3903               return pair<_ForwardIterator, _ForwardIterator>(__left, __right);
3904             }
3905         }
3906       return pair<_ForwardIterator, _ForwardIterator>(__first, __first);
3907     }
3908
3909   /**
3910    *  @brief Determines whether an element exists in a range.
3911    *  @param  first   An iterator.
3912    *  @param  last    Another iterator.
3913    *  @param  val     The search term.
3914    *  @return  True if @a val (or its equivelent) is in [@a first,@a last ].
3915    *  @ingroup binarysearch
3916    *
3917    *  Note that this does not actually return an iterator to @a val.  For
3918    *  that, use std::find or a container's specialized find member functions.
3919   */
3920   template<typename _ForwardIterator, typename _Tp>
3921     bool
3922     binary_search(_ForwardIterator __first, _ForwardIterator __last,
3923                   const _Tp& __val)
3924     {
3925       // concept requirements
3926       // See comments on lower_bound.
3927       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
3928       __glibcxx_function_requires(_SameTypeConcept<_Tp,
3929                 typename iterator_traits<_ForwardIterator>::value_type>)
3930       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
3931       __glibcxx_requires_partitioned(__first, __last, __val);
3932
3933       _ForwardIterator __i = std::lower_bound(__first, __last, __val);
3934       return __i != __last && !(__val < *__i);
3935     }
3936
3937   /**
3938    *  @brief Determines whether an element exists in a range.
3939    *  @param  first   An iterator.
3940    *  @param  last    Another iterator.
3941    *  @param  val     The search term.
3942    *  @param  comp    A functor to use for comparisons.
3943    *  @return  True if @a val (or its equivelent) is in [@a first,@a last ].
3944    *  @ingroup binarysearch
3945    *
3946    *  Note that this does not actually return an iterator to @a val.  For
3947    *  that, use std::find or a container's specialized find member functions.
3948    *
3949    *  The comparison function should have the same effects on ordering as
3950    *  the function used for the initial sort.
3951   */
3952   template<typename _ForwardIterator, typename _Tp, typename _Compare>
3953     bool
3954     binary_search(_ForwardIterator __first, _ForwardIterator __last,
3955                   const _Tp& __val, _Compare __comp)
3956     {
3957       // concept requirements
3958       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
3959       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
3960                 typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
3961       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare, _Tp,
3962                 typename iterator_traits<_ForwardIterator>::value_type>)
3963       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
3964
3965       _ForwardIterator __i = std::lower_bound(__first, __last, __val, __comp);
3966       return __i != __last && !__comp(__val, *__i);
3967     }
3968
3969   // Set algorithms: includes, set_union, set_intersection, set_difference,
3970   // set_symmetric_difference.  All of these algorithms have the precondition
3971   // that their input ranges are sorted and the postcondition that their output
3972   // ranges are sorted.
3973
3974   /**
3975    *  @brief Determines whether all elements of a sequence exists in a range.
3976    *  @param  first1  Start of search range.
3977    *  @param  last1   End of search range.
3978    *  @param  first2  Start of sequence
3979    *  @param  last2   End of sequence.
3980    *  @return  True if each element in [first2,last2) is contained in order
3981    *  within [first1,last1).  False otherwise.
3982    *  @ingroup setoperations
3983    *
3984    *  This operation expects both [first1,last1) and [first2,last2) to be
3985    *  sorted.  Searches for the presence of each element in [first2,last2)
3986    *  within [first1,last1).  The iterators over each range only move forward,
3987    *  so this is a linear algorithm.  If an element in [first2,last2) is not
3988    *  found before the search iterator reaches @a last2, false is returned.
3989   */
3990   template<typename _InputIterator1, typename _InputIterator2>
3991     bool
3992     includes(_InputIterator1 __first1, _InputIterator1 __last1,
3993              _InputIterator2 __first2, _InputIterator2 __last2)
3994     {
3995       // concept requirements
3996       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
3997       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
3998       __glibcxx_function_requires(_SameTypeConcept<
3999             typename iterator_traits<_InputIterator1>::value_type,
4000             typename iterator_traits<_InputIterator2>::value_type>)
4001       __glibcxx_function_requires(_LessThanComparableConcept<
4002             typename iterator_traits<_InputIterator1>::value_type>)
4003       __glibcxx_requires_sorted(__first1, __last1);
4004       __glibcxx_requires_sorted(__first2, __last2);
4005
4006       while (__first1 != __last1 && __first2 != __last2)
4007         if (*__first2 < *__first1)
4008           return false;
4009         else if(*__first1 < *__first2)
4010           ++__first1;
4011         else
4012           ++__first1, ++__first2;
4013
4014       return __first2 == __last2;
4015     }
4016
4017   /**
4018    *  @brief Determines whether all elements of a sequence exists in a range
4019    *  using comparison.
4020    *  @param  first1  Start of search range.
4021    *  @param  last1   End of search range.
4022    *  @param  first2  Start of sequence
4023    *  @param  last2   End of sequence.
4024    *  @param  comp    Comparison function to use.
4025    *  @return  True if each element in [first2,last2) is contained in order
4026    *  within [first1,last1) according to comp.  False otherwise.
4027    *  @ingroup setoperations
4028    *
4029    *  This operation expects both [first1,last1) and [first2,last2) to be
4030    *  sorted.  Searches for the presence of each element in [first2,last2)
4031    *  within [first1,last1), using comp to decide.  The iterators over each
4032    *  range only move forward, so this is a linear algorithm.  If an element
4033    *  in [first2,last2) is not found before the search iterator reaches @a
4034    *  last2, false is returned.
4035   */
4036   template<typename _InputIterator1, typename _InputIterator2,
4037            typename _Compare>
4038     bool
4039     includes(_InputIterator1 __first1, _InputIterator1 __last1,
4040              _InputIterator2 __first2, _InputIterator2 __last2, _Compare __comp)
4041     {
4042       // concept requirements
4043       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4044       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4045       __glibcxx_function_requires(_SameTypeConcept<
4046             typename iterator_traits<_InputIterator1>::value_type,
4047             typename iterator_traits<_InputIterator2>::value_type>)
4048       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4049             typename iterator_traits<_InputIterator1>::value_type,
4050             typename iterator_traits<_InputIterator2>::value_type>)
4051       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
4052       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
4053
4054       while (__first1 != __last1 && __first2 != __last2)
4055         if (__comp(*__first2, *__first1))
4056           return false;
4057         else if(__comp(*__first1, *__first2))
4058           ++__first1;
4059         else
4060           ++__first1, ++__first2;
4061
4062       return __first2 == __last2;
4063     }
4064
4065   /**
4066    *  @brief Return the union of two sorted ranges.
4067    *  @param  first1  Start of first range.
4068    *  @param  last1   End of first range.
4069    *  @param  first2  Start of second range.
4070    *  @param  last2   End of second range.
4071    *  @return  End of the output range.
4072    *  @ingroup setoperations
4073    *
4074    *  This operation iterates over both ranges, copying elements present in
4075    *  each range in order to the output range.  Iterators increment for each
4076    *  range.  When the current element of one range is less than the other,
4077    *  that element is copied and the iterator advanced.  If an element is
4078    *  contained in both ranges, the element from the first range is copied and
4079    *  both ranges advance.  The output range may not overlap either input
4080    *  range.
4081   */
4082   template<typename _InputIterator1, typename _InputIterator2,
4083            typename _OutputIterator>
4084     _OutputIterator
4085     set_union(_InputIterator1 __first1, _InputIterator1 __last1,
4086               _InputIterator2 __first2, _InputIterator2 __last2,
4087               _OutputIterator __result)
4088     {
4089       // concept requirements
4090       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4091       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4092       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4093             typename iterator_traits<_InputIterator1>::value_type>)
4094       __glibcxx_function_requires(_SameTypeConcept<
4095             typename iterator_traits<_InputIterator1>::value_type,
4096             typename iterator_traits<_InputIterator2>::value_type>)
4097       __glibcxx_function_requires(_LessThanComparableConcept<
4098             typename iterator_traits<_InputIterator1>::value_type>)
4099       __glibcxx_requires_sorted(__first1, __last1);
4100       __glibcxx_requires_sorted(__first2, __last2);
4101
4102       while (__first1 != __last1 && __first2 != __last2)
4103         {
4104           if (*__first1 < *__first2)
4105             {
4106               *__result = *__first1;
4107               ++__first1;
4108             }
4109           else if (*__first2 < *__first1)
4110             {
4111               *__result = *__first2;
4112               ++__first2;
4113             }
4114           else
4115             {
4116               *__result = *__first1;
4117               ++__first1;
4118               ++__first2;
4119             }
4120           ++__result;
4121         }
4122       return std::copy(__first2, __last2, std::copy(__first1, __last1,
4123                                                     __result));
4124     }
4125
4126   /**
4127    *  @brief Return the union of two sorted ranges using a comparison functor.
4128    *  @param  first1  Start of first range.
4129    *  @param  last1   End of first range.
4130    *  @param  first2  Start of second range.
4131    *  @param  last2   End of second range.
4132    *  @param  comp    The comparison functor.
4133    *  @return  End of the output range.
4134    *  @ingroup setoperations
4135    *
4136    *  This operation iterates over both ranges, copying elements present in
4137    *  each range in order to the output range.  Iterators increment for each
4138    *  range.  When the current element of one range is less than the other
4139    *  according to @a comp, that element is copied and the iterator advanced.
4140    *  If an equivalent element according to @a comp is contained in both
4141    *  ranges, the element from the first range is copied and both ranges
4142    *  advance.  The output range may not overlap either input range.
4143   */
4144   template<typename _InputIterator1, typename _InputIterator2,
4145            typename _OutputIterator, typename _Compare>
4146     _OutputIterator
4147     set_union(_InputIterator1 __first1, _InputIterator1 __last1,
4148               _InputIterator2 __first2, _InputIterator2 __last2,
4149               _OutputIterator __result, _Compare __comp)
4150     {
4151       // concept requirements
4152       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4153       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4154       __glibcxx_function_requires(_SameTypeConcept<
4155             typename iterator_traits<_InputIterator1>::value_type,
4156             typename iterator_traits<_InputIterator2>::value_type>)
4157       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4158             typename iterator_traits<_InputIterator1>::value_type>)
4159       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4160             typename iterator_traits<_InputIterator1>::value_type,
4161             typename iterator_traits<_InputIterator2>::value_type>)
4162       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
4163       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
4164
4165       while (__first1 != __last1 && __first2 != __last2)
4166         {
4167           if (__comp(*__first1, *__first2))
4168             {
4169               *__result = *__first1;
4170               ++__first1;
4171             }
4172           else if (__comp(*__first2, *__first1))
4173             {
4174               *__result = *__first2;
4175               ++__first2;
4176             }
4177           else
4178             {
4179               *__result = *__first1;
4180               ++__first1;
4181               ++__first2;
4182             }
4183           ++__result;
4184         }
4185       return std::copy(__first2, __last2, std::copy(__first1, __last1,
4186                                                     __result));
4187     }
4188
4189   /**
4190    *  @brief Return the intersection of two sorted ranges.
4191    *  @param  first1  Start of first range.
4192    *  @param  last1   End of first range.
4193    *  @param  first2  Start of second range.
4194    *  @param  last2   End of second range.
4195    *  @return  End of the output range.
4196    *  @ingroup setoperations
4197    *
4198    *  This operation iterates over both ranges, copying elements present in
4199    *  both ranges in order to the output range.  Iterators increment for each
4200    *  range.  When the current element of one range is less than the other,
4201    *  that iterator advances.  If an element is contained in both ranges, the
4202    *  element from the first range is copied and both ranges advance.  The
4203    *  output range may not overlap either input range.
4204   */
4205   template<typename _InputIterator1, typename _InputIterator2,
4206            typename _OutputIterator>
4207     _OutputIterator
4208     set_intersection(_InputIterator1 __first1, _InputIterator1 __last1,
4209                      _InputIterator2 __first2, _InputIterator2 __last2,
4210                      _OutputIterator __result)
4211     {
4212       // concept requirements
4213       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4214       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4215       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4216             typename iterator_traits<_InputIterator1>::value_type>)
4217       __glibcxx_function_requires(_SameTypeConcept<
4218             typename iterator_traits<_InputIterator1>::value_type,
4219             typename iterator_traits<_InputIterator2>::value_type>)
4220       __glibcxx_function_requires(_LessThanComparableConcept<
4221             typename iterator_traits<_InputIterator1>::value_type>)
4222       __glibcxx_requires_sorted(__first1, __last1);
4223       __glibcxx_requires_sorted(__first2, __last2);
4224
4225       while (__first1 != __last1 && __first2 != __last2)
4226         if (*__first1 < *__first2)
4227           ++__first1;
4228         else if (*__first2 < *__first1)
4229           ++__first2;
4230         else
4231           {
4232             *__result = *__first1;
4233             ++__first1;
4234             ++__first2;
4235             ++__result;
4236           }
4237       return __result;
4238     }
4239
4240   /**
4241    *  @brief Return the intersection of two sorted ranges using comparison
4242    *  functor.
4243    *  @param  first1  Start of first range.
4244    *  @param  last1   End of first range.
4245    *  @param  first2  Start of second range.
4246    *  @param  last2   End of second range.
4247    *  @param  comp    The comparison functor.
4248    *  @return  End of the output range.
4249    *  @ingroup setoperations
4250    *
4251    *  This operation iterates over both ranges, copying elements present in
4252    *  both ranges in order to the output range.  Iterators increment for each
4253    *  range.  When the current element of one range is less than the other
4254    *  according to @a comp, that iterator advances.  If an element is
4255    *  contained in both ranges according to @a comp, the element from the
4256    *  first range is copied and both ranges advance.  The output range may not
4257    *  overlap either input range.
4258   */
4259   template<typename _InputIterator1, typename _InputIterator2,
4260            typename _OutputIterator, typename _Compare>
4261     _OutputIterator
4262     set_intersection(_InputIterator1 __first1, _InputIterator1 __last1,
4263                      _InputIterator2 __first2, _InputIterator2 __last2,
4264                      _OutputIterator __result, _Compare __comp)
4265     {
4266       // concept requirements
4267       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4268       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4269       __glibcxx_function_requires(_SameTypeConcept<
4270             typename iterator_traits<_InputIterator1>::value_type,
4271             typename iterator_traits<_InputIterator2>::value_type>)
4272       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4273             typename iterator_traits<_InputIterator1>::value_type>)
4274       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4275             typename iterator_traits<_InputIterator1>::value_type,
4276             typename iterator_traits<_InputIterator2>::value_type>)
4277       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
4278       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
4279
4280       while (__first1 != __last1 && __first2 != __last2)
4281         if (__comp(*__first1, *__first2))
4282           ++__first1;
4283         else if (__comp(*__first2, *__first1))
4284           ++__first2;
4285         else
4286           {
4287             *__result = *__first1;
4288             ++__first1;
4289             ++__first2;
4290             ++__result;
4291           }
4292       return __result;
4293     }
4294
4295   /**
4296    *  @brief Return the difference of two sorted ranges.
4297    *  @param  first1  Start of first range.
4298    *  @param  last1   End of first range.
4299    *  @param  first2  Start of second range.
4300    *  @param  last2   End of second range.
4301    *  @return  End of the output range.
4302    *  @ingroup setoperations
4303    *
4304    *  This operation iterates over both ranges, copying elements present in
4305    *  the first range but not the second in order to the output range.
4306    *  Iterators increment for each range.  When the current element of the
4307    *  first range is less than the second, that element is copied and the
4308    *  iterator advances.  If the current element of the second range is less,
4309    *  the iterator advances, but no element is copied.  If an element is
4310    *  contained in both ranges, no elements are copied and both ranges
4311    *  advance.  The output range may not overlap either input range.
4312   */
4313   template<typename _InputIterator1, typename _InputIterator2,
4314            typename _OutputIterator>
4315     _OutputIterator
4316     set_difference(_InputIterator1 __first1, _InputIterator1 __last1,
4317                    _InputIterator2 __first2, _InputIterator2 __last2,
4318                    _OutputIterator __result)
4319     {
4320       // concept requirements
4321       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4322       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4323       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4324             typename iterator_traits<_InputIterator1>::value_type>)
4325       __glibcxx_function_requires(_SameTypeConcept<
4326             typename iterator_traits<_InputIterator1>::value_type,
4327             typename iterator_traits<_InputIterator2>::value_type>)
4328       __glibcxx_function_requires(_LessThanComparableConcept<
4329             typename iterator_traits<_InputIterator1>::value_type>)
4330       __glibcxx_requires_sorted(__first1, __last1);
4331       __glibcxx_requires_sorted(__first2, __last2);
4332
4333       while (__first1 != __last1 && __first2 != __last2)
4334         if (*__first1 < *__first2)
4335           {
4336             *__result = *__first1;
4337             ++__first1;
4338             ++__result;
4339           }
4340         else if (*__first2 < *__first1)
4341           ++__first2;
4342         else
4343           {
4344             ++__first1;
4345             ++__first2;
4346           }
4347       return std::copy(__first1, __last1, __result);
4348     }
4349
4350   /**
4351    *  @brief  Return the difference of two sorted ranges using comparison
4352    *  functor.
4353    *  @param  first1  Start of first range.
4354    *  @param  last1   End of first range.
4355    *  @param  first2  Start of second range.
4356    *  @param  last2   End of second range.
4357    *  @param  comp    The comparison functor.
4358    *  @return  End of the output range.
4359    *  @ingroup setoperations
4360    *
4361    *  This operation iterates over both ranges, copying elements present in
4362    *  the first range but not the second in order to the output range.
4363    *  Iterators increment for each range.  When the current element of the
4364    *  first range is less than the second according to @a comp, that element
4365    *  is copied and the iterator advances.  If the current element of the
4366    *  second range is less, no element is copied and the iterator advances.
4367    *  If an element is contained in both ranges according to @a comp, no
4368    *  elements are copied and both ranges advance.  The output range may not
4369    *  overlap either input range.
4370   */
4371   template<typename _InputIterator1, typename _InputIterator2,
4372            typename _OutputIterator, typename _Compare>
4373     _OutputIterator
4374     set_difference(_InputIterator1 __first1, _InputIterator1 __last1,
4375                    _InputIterator2 __first2, _InputIterator2 __last2,
4376                    _OutputIterator __result, _Compare __comp)
4377     {
4378       // concept requirements
4379       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4380       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4381       __glibcxx_function_requires(_SameTypeConcept<
4382             typename iterator_traits<_InputIterator1>::value_type,
4383             typename iterator_traits<_InputIterator2>::value_type>)
4384       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4385             typename iterator_traits<_InputIterator1>::value_type>)
4386       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4387             typename iterator_traits<_InputIterator1>::value_type,
4388             typename iterator_traits<_InputIterator2>::value_type>)
4389       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
4390       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
4391
4392       while (__first1 != __last1 && __first2 != __last2)
4393         if (__comp(*__first1, *__first2))
4394           {
4395             *__result = *__first1;
4396             ++__first1;
4397             ++__result;
4398           }
4399         else if (__comp(*__first2, *__first1))
4400           ++__first2;
4401         else
4402           {
4403             ++__first1;
4404             ++__first2;
4405           }
4406       return std::copy(__first1, __last1, __result);
4407     }
4408
4409   /**
4410    *  @brief  Return the symmetric difference of two sorted ranges.
4411    *  @param  first1  Start of first range.
4412    *  @param  last1   End of first range.
4413    *  @param  first2  Start of second range.
4414    *  @param  last2   End of second range.
4415    *  @return  End of the output range.
4416    *  @ingroup setoperations
4417    *
4418    *  This operation iterates over both ranges, copying elements present in
4419    *  one range but not the other in order to the output range.  Iterators
4420    *  increment for each range.  When the current element of one range is less
4421    *  than the other, that element is copied and the iterator advances.  If an
4422    *  element is contained in both ranges, no elements are copied and both
4423    *  ranges advance.  The output range may not overlap either input range.
4424   */
4425   template<typename _InputIterator1, typename _InputIterator2,
4426            typename _OutputIterator>
4427     _OutputIterator
4428     set_symmetric_difference(_InputIterator1 __first1, _InputIterator1 __last1,
4429                              _InputIterator2 __first2, _InputIterator2 __last2,
4430                              _OutputIterator __result)
4431     {
4432       // concept requirements
4433       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4434       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4435       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4436             typename iterator_traits<_InputIterator1>::value_type>)
4437       __glibcxx_function_requires(_SameTypeConcept<
4438             typename iterator_traits<_InputIterator1>::value_type,
4439             typename iterator_traits<_InputIterator2>::value_type>)
4440       __glibcxx_function_requires(_LessThanComparableConcept<
4441             typename iterator_traits<_InputIterator1>::value_type>)
4442       __glibcxx_requires_sorted(__first1, __last1);
4443       __glibcxx_requires_sorted(__first2, __last2);
4444
4445       while (__first1 != __last1 && __first2 != __last2)
4446         if (*__first1 < *__first2)
4447           {
4448             *__result = *__first1;
4449             ++__first1;
4450             ++__result;
4451           }
4452         else if (*__first2 < *__first1)
4453           {
4454             *__result = *__first2;
4455             ++__first2;
4456             ++__result;
4457           }
4458         else
4459           {
4460             ++__first1;
4461             ++__first2;
4462           }
4463       return std::copy(__first2, __last2, std::copy(__first1,
4464                                                     __last1, __result));
4465     }
4466
4467   /**
4468    *  @brief  Return the symmetric difference of two sorted ranges using
4469    *  comparison functor.
4470    *  @param  first1  Start of first range.
4471    *  @param  last1   End of first range.
4472    *  @param  first2  Start of second range.
4473    *  @param  last2   End of second range.
4474    *  @param  comp    The comparison functor.
4475    *  @return  End of the output range.
4476    *  @ingroup setoperations
4477    *
4478    *  This operation iterates over both ranges, copying elements present in
4479    *  one range but not the other in order to the output range.  Iterators
4480    *  increment for each range.  When the current element of one range is less
4481    *  than the other according to @a comp, that element is copied and the
4482    *  iterator advances.  If an element is contained in both ranges according
4483    *  to @a comp, no elements are copied and both ranges advance.  The output
4484    *  range may not overlap either input range.
4485   */
4486   template<typename _InputIterator1, typename _InputIterator2,
4487            typename _OutputIterator, typename _Compare>
4488     _OutputIterator
4489     set_symmetric_difference(_InputIterator1 __first1, _InputIterator1 __last1,
4490                              _InputIterator2 __first2, _InputIterator2 __last2,
4491                              _OutputIterator __result,
4492                              _Compare __comp)
4493     {
4494       // concept requirements
4495       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
4496       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
4497       __glibcxx_function_requires(_SameTypeConcept<
4498             typename iterator_traits<_InputIterator1>::value_type,
4499             typename iterator_traits<_InputIterator2>::value_type>)
4500       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
4501             typename iterator_traits<_InputIterator1>::value_type>)
4502       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4503             typename iterator_traits<_InputIterator1>::value_type,
4504             typename iterator_traits<_InputIterator2>::value_type>)
4505       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
4506       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
4507
4508       while (__first1 != __last1 && __first2 != __last2)
4509         if (__comp(*__first1, *__first2))
4510           {
4511             *__result = *__first1;
4512             ++__first1;
4513             ++__result;
4514           }
4515         else if (__comp(*__first2, *__first1))
4516           {
4517             *__result = *__first2;
4518             ++__first2;
4519             ++__result;
4520           }
4521         else
4522           {
4523             ++__first1;
4524             ++__first2;
4525           }
4526       return std::copy(__first2, __last2, std::copy(__first1,
4527                                                     __last1, __result));
4528     }
4529
4530   // min_element and max_element, with and without an explicitly supplied
4531   // comparison function.
4532
4533   /**
4534    *  @brief  Return the maximum element in a range.
4535    *  @param  first  Start of range.
4536    *  @param  last   End of range.
4537    *  @return  Iterator referencing the first instance of the largest value.
4538   */
4539   template<typename _ForwardIterator>
4540     _ForwardIterator
4541     max_element(_ForwardIterator __first, _ForwardIterator __last)
4542     {
4543       // concept requirements
4544       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4545       __glibcxx_function_requires(_LessThanComparableConcept<
4546             typename iterator_traits<_ForwardIterator>::value_type>)
4547       __glibcxx_requires_valid_range(__first, __last);
4548
4549       if (__first == __last)
4550         return __first;
4551       _ForwardIterator __result = __first;
4552       while (++__first != __last)
4553         if (*__result < *__first)
4554           __result = __first;
4555       return __result;
4556     }
4557
4558   /**
4559    *  @brief  Return the maximum element in a range using comparison functor.
4560    *  @param  first  Start of range.
4561    *  @param  last   End of range.
4562    *  @param  comp   Comparison functor.
4563    *  @return  Iterator referencing the first instance of the largest value
4564    *  according to comp.
4565   */
4566   template<typename _ForwardIterator, typename _Compare>
4567     _ForwardIterator
4568     max_element(_ForwardIterator __first, _ForwardIterator __last,
4569                 _Compare __comp)
4570     {
4571       // concept requirements
4572       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4573       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4574             typename iterator_traits<_ForwardIterator>::value_type,
4575             typename iterator_traits<_ForwardIterator>::value_type>)
4576       __glibcxx_requires_valid_range(__first, __last);
4577
4578       if (__first == __last) return __first;
4579       _ForwardIterator __result = __first;
4580       while (++__first != __last)
4581         if (__comp(*__result, *__first)) __result = __first;
4582       return __result;
4583     }
4584
4585   /**
4586    *  @brief  Return the minimum element in a range.
4587    *  @param  first  Start of range.
4588    *  @param  last   End of range.
4589    *  @return  Iterator referencing the first instance of the smallest value.
4590   */
4591   template<typename _ForwardIterator>
4592     _ForwardIterator
4593     min_element(_ForwardIterator __first, _ForwardIterator __last)
4594     {
4595       // concept requirements
4596       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4597       __glibcxx_function_requires(_LessThanComparableConcept<
4598             typename iterator_traits<_ForwardIterator>::value_type>)
4599       __glibcxx_requires_valid_range(__first, __last);
4600
4601       if (__first == __last)
4602         return __first;
4603       _ForwardIterator __result = __first;
4604       while (++__first != __last)
4605         if (*__first < *__result)
4606           __result = __first;
4607       return __result;
4608     }
4609
4610   /**
4611    *  @brief  Return the minimum element in a range using comparison functor.
4612    *  @param  first  Start of range.
4613    *  @param  last   End of range.
4614    *  @param  comp   Comparison functor.
4615    *  @return  Iterator referencing the first instance of the smallest value
4616    *  according to comp.
4617   */
4618   template<typename _ForwardIterator, typename _Compare>
4619     _ForwardIterator
4620     min_element(_ForwardIterator __first, _ForwardIterator __last,
4621                 _Compare __comp)
4622     {
4623       // concept requirements
4624       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4625       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4626             typename iterator_traits<_ForwardIterator>::value_type,
4627             typename iterator_traits<_ForwardIterator>::value_type>)
4628       __glibcxx_requires_valid_range(__first, __last);
4629
4630       if (__first == __last)
4631         return __first;
4632       _ForwardIterator __result = __first;
4633       while (++__first != __last)
4634         if (__comp(*__first, *__result))
4635           __result = __first;
4636       return __result;
4637     }
4638
4639   // next_permutation and prev_permutation, with and without an explicitly
4640   // supplied comparison function.
4641
4642   /**
4643    *  @brief  Permute range into the next "dictionary" ordering.
4644    *  @param  first  Start of range.
4645    *  @param  last   End of range.
4646    *  @return  False if wrapped to first permutation, true otherwise.
4647    *
4648    *  Treats all permutations of the range as a set of "dictionary" sorted
4649    *  sequences.  Permutes the current sequence into the next one of this set.
4650    *  Returns true if there are more sequences to generate.  If the sequence
4651    *  is the largest of the set, the smallest is generated and false returned.
4652   */
4653   template<typename _BidirectionalIterator>
4654     bool
4655     next_permutation(_BidirectionalIterator __first,
4656                      _BidirectionalIterator __last)
4657     {
4658       // concept requirements
4659       __glibcxx_function_requires(_BidirectionalIteratorConcept<
4660                                   _BidirectionalIterator>)
4661       __glibcxx_function_requires(_LessThanComparableConcept<
4662             typename iterator_traits<_BidirectionalIterator>::value_type>)
4663       __glibcxx_requires_valid_range(__first, __last);
4664
4665       if (__first == __last)
4666         return false;
4667       _BidirectionalIterator __i = __first;
4668       ++__i;
4669       if (__i == __last)
4670         return false;
4671       __i = __last;
4672       --__i;
4673
4674       for(;;)
4675         {
4676           _BidirectionalIterator __ii = __i;
4677           --__i;
4678           if (*__i < *__ii)
4679             {
4680               _BidirectionalIterator __j = __last;
4681               while (!(*__i < *--__j))
4682                 {}
4683               std::iter_swap(__i, __j);
4684               std::reverse(__ii, __last);
4685               return true;
4686             }
4687           if (__i == __first)
4688             {
4689               std::reverse(__first, __last);
4690               return false;
4691             }
4692         }
4693     }
4694
4695   /**
4696    *  @brief  Permute range into the next "dictionary" ordering using
4697    *  comparison functor.
4698    *  @param  first  Start of range.
4699    *  @param  last   End of range.
4700    *  @param  comp
4701    *  @return  False if wrapped to first permutation, true otherwise.
4702    *
4703    *  Treats all permutations of the range [first,last) as a set of
4704    *  "dictionary" sorted sequences ordered by @a comp.  Permutes the current
4705    *  sequence into the next one of this set.  Returns true if there are more
4706    *  sequences to generate.  If the sequence is the largest of the set, the
4707    *  smallest is generated and false returned.
4708   */
4709   template<typename _BidirectionalIterator, typename _Compare>
4710     bool
4711     next_permutation(_BidirectionalIterator __first,
4712                      _BidirectionalIterator __last, _Compare __comp)
4713     {
4714       // concept requirements
4715       __glibcxx_function_requires(_BidirectionalIteratorConcept<
4716                                   _BidirectionalIterator>)
4717       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4718             typename iterator_traits<_BidirectionalIterator>::value_type,
4719             typename iterator_traits<_BidirectionalIterator>::value_type>)
4720       __glibcxx_requires_valid_range(__first, __last);
4721
4722       if (__first == __last)
4723         return false;
4724       _BidirectionalIterator __i = __first;
4725       ++__i;
4726       if (__i == __last)
4727         return false;
4728       __i = __last;
4729       --__i;
4730
4731       for(;;)
4732         {
4733           _BidirectionalIterator __ii = __i;
4734           --__i;
4735           if (__comp(*__i, *__ii))
4736             {
4737               _BidirectionalIterator __j = __last;
4738               while (!__comp(*__i, *--__j))
4739                 {}
4740               std::iter_swap(__i, __j);
4741               std::reverse(__ii, __last);
4742               return true;
4743             }
4744           if (__i == __first)
4745             {
4746               std::reverse(__first, __last);
4747               return false;
4748             }
4749         }
4750     }
4751
4752   /**
4753    *  @brief  Permute range into the previous "dictionary" ordering.
4754    *  @param  first  Start of range.
4755    *  @param  last   End of range.
4756    *  @return  False if wrapped to last permutation, true otherwise.
4757    *
4758    *  Treats all permutations of the range as a set of "dictionary" sorted
4759    *  sequences.  Permutes the current sequence into the previous one of this
4760    *  set.  Returns true if there are more sequences to generate.  If the
4761    *  sequence is the smallest of the set, the largest is generated and false
4762    *  returned.
4763   */
4764   template<typename _BidirectionalIterator>
4765     bool
4766     prev_permutation(_BidirectionalIterator __first,
4767                      _BidirectionalIterator __last)
4768     {
4769       // concept requirements
4770       __glibcxx_function_requires(_BidirectionalIteratorConcept<
4771                                   _BidirectionalIterator>)
4772       __glibcxx_function_requires(_LessThanComparableConcept<
4773             typename iterator_traits<_BidirectionalIterator>::value_type>)
4774       __glibcxx_requires_valid_range(__first, __last);
4775
4776       if (__first == __last)
4777         return false;
4778       _BidirectionalIterator __i = __first;
4779       ++__i;
4780       if (__i == __last)
4781         return false;
4782       __i = __last;
4783       --__i;
4784
4785       for(;;)
4786         {
4787           _BidirectionalIterator __ii = __i;
4788           --__i;
4789           if (*__ii < *__i)
4790             {
4791               _BidirectionalIterator __j = __last;
4792               while (!(*--__j < *__i))
4793                 {}
4794               std::iter_swap(__i, __j);
4795               std::reverse(__ii, __last);
4796               return true;
4797             }
4798           if (__i == __first)
4799             {
4800               std::reverse(__first, __last);
4801               return false;
4802             }
4803         }
4804     }
4805
4806   /**
4807    *  @brief  Permute range into the previous "dictionary" ordering using
4808    *  comparison functor.
4809    *  @param  first  Start of range.
4810    *  @param  last   End of range.
4811    *  @param  comp
4812    *  @return  False if wrapped to last permutation, true otherwise.
4813    *
4814    *  Treats all permutations of the range [first,last) as a set of
4815    *  "dictionary" sorted sequences ordered by @a comp.  Permutes the current
4816    *  sequence into the previous one of this set.  Returns true if there are
4817    *  more sequences to generate.  If the sequence is the smallest of the set,
4818    *  the largest is generated and false returned.
4819   */
4820   template<typename _BidirectionalIterator, typename _Compare>
4821     bool
4822     prev_permutation(_BidirectionalIterator __first,
4823                      _BidirectionalIterator __last, _Compare __comp)
4824     {
4825       // concept requirements
4826       __glibcxx_function_requires(_BidirectionalIteratorConcept<
4827                                   _BidirectionalIterator>)
4828       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
4829             typename iterator_traits<_BidirectionalIterator>::value_type,
4830             typename iterator_traits<_BidirectionalIterator>::value_type>)
4831       __glibcxx_requires_valid_range(__first, __last);
4832
4833       if (__first == __last)
4834         return false;
4835       _BidirectionalIterator __i = __first;
4836       ++__i;
4837       if (__i == __last)
4838         return false;
4839       __i = __last;
4840       --__i;
4841
4842       for(;;)
4843         {
4844           _BidirectionalIterator __ii = __i;
4845           --__i;
4846           if (__comp(*__ii, *__i))
4847             {
4848               _BidirectionalIterator __j = __last;
4849               while (!__comp(*--__j, *__i))
4850                 {}
4851               std::iter_swap(__i, __j);
4852               std::reverse(__ii, __last);
4853               return true;
4854             }
4855           if (__i == __first)
4856             {
4857               std::reverse(__first, __last);
4858               return false;
4859             }
4860         }
4861     }
4862
4863   // find_first_of, with and without an explicitly supplied comparison function.
4864
4865   /**
4866    *  @brief  Find element from a set in a sequence.
4867    *  @param  first1  Start of range to search.
4868    *  @param  last1   End of range to search.
4869    *  @param  first2  Start of match candidates.
4870    *  @param  last2   End of match candidates.
4871    *  @return   The first iterator @c i in the range
4872    *  @p [first1,last1) such that @c *i == @p *(i2) such that i2 is an
4873    *  interator in [first2,last2), or @p last1 if no such iterator exists.
4874    *
4875    *  Searches the range @p [first1,last1) for an element that is equal to
4876    *  some element in the range [first2,last2).  If found, returns an iterator
4877    *  in the range [first1,last1), otherwise returns @p last1.
4878   */
4879   template<typename _InputIterator, typename _ForwardIterator>
4880     _InputIterator
4881     find_first_of(_InputIterator __first1, _InputIterator __last1,
4882                   _ForwardIterator __first2, _ForwardIterator __last2)
4883     {
4884       // concept requirements
4885       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
4886       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4887       __glibcxx_function_requires(_EqualOpConcept<
4888             typename iterator_traits<_InputIterator>::value_type,
4889             typename iterator_traits<_ForwardIterator>::value_type>)
4890       __glibcxx_requires_valid_range(__first1, __last1);
4891       __glibcxx_requires_valid_range(__first2, __last2);
4892
4893       for ( ; __first1 != __last1; ++__first1)
4894         for (_ForwardIterator __iter = __first2; __iter != __last2; ++__iter)
4895           if (*__first1 == *__iter)
4896             return __first1;
4897       return __last1;
4898     }
4899
4900   /**
4901    *  @brief  Find element from a set in a sequence using a predicate.
4902    *  @param  first1  Start of range to search.
4903    *  @param  last1   End of range to search.
4904    *  @param  first2  Start of match candidates.
4905    *  @param  last2   End of match candidates.
4906    *  @param  comp    Predicate to use.
4907    *  @return   The first iterator @c i in the range
4908    *  @p [first1,last1) such that @c comp(*i, @p *(i2)) is true and i2 is an
4909    *  interator in [first2,last2), or @p last1 if no such iterator exists.
4910    *
4911    *  Searches the range @p [first1,last1) for an element that is equal to
4912    *  some element in the range [first2,last2).  If found, returns an iterator in
4913    *  the range [first1,last1), otherwise returns @p last1.
4914   */
4915   template<typename _InputIterator, typename _ForwardIterator,
4916            typename _BinaryPredicate>
4917     _InputIterator
4918     find_first_of(_InputIterator __first1, _InputIterator __last1,
4919                   _ForwardIterator __first2, _ForwardIterator __last2,
4920                   _BinaryPredicate __comp)
4921     {
4922       // concept requirements
4923       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
4924       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
4925       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
4926             typename iterator_traits<_InputIterator>::value_type,
4927             typename iterator_traits<_ForwardIterator>::value_type>)
4928       __glibcxx_requires_valid_range(__first1, __last1);
4929       __glibcxx_requires_valid_range(__first2, __last2);
4930
4931       for ( ; __first1 != __last1; ++__first1)
4932         for (_ForwardIterator __iter = __first2; __iter != __last2; ++__iter)
4933           if (__comp(*__first1, *__iter))
4934             return __first1;
4935       return __last1;
4936     }
4937
4938
4939   // find_end, with and without an explicitly supplied comparison function.
4940   // Search [first2, last2) as a subsequence in [first1, last1), and return
4941   // the *last* possible match.  Note that find_end for bidirectional iterators
4942   // is much faster than for forward iterators.
4943
4944   // find_end for forward iterators.
4945   template<typename _ForwardIterator1, typename _ForwardIterator2>
4946     _ForwardIterator1
4947     __find_end(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
4948                _ForwardIterator2 __first2, _ForwardIterator2 __last2,
4949                forward_iterator_tag, forward_iterator_tag)
4950     {
4951       if (__first2 == __last2)
4952         return __last1;
4953       else
4954         {
4955           _ForwardIterator1 __result = __last1;
4956           while (1)
4957             {
4958               _ForwardIterator1 __new_result
4959                 = std::search(__first1, __last1, __first2, __last2);
4960               if (__new_result == __last1)
4961                 return __result;
4962               else
4963                 {
4964                   __result = __new_result;
4965                   __first1 = __new_result;
4966                   ++__first1;
4967                 }
4968             }
4969         }
4970     }
4971
4972   template<typename _ForwardIterator1, typename _ForwardIterator2,
4973            typename _BinaryPredicate>
4974     _ForwardIterator1
4975     __find_end(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
4976                _ForwardIterator2 __first2, _ForwardIterator2 __last2,
4977                forward_iterator_tag, forward_iterator_tag,
4978                _BinaryPredicate __comp)
4979     {
4980       if (__first2 == __last2)
4981         return __last1;
4982       else
4983         {
4984           _ForwardIterator1 __result = __last1;
4985           while (1)
4986             {
4987               _ForwardIterator1 __new_result
4988                 = std::search(__first1, __last1, __first2, __last2, __comp);
4989               if (__new_result == __last1)
4990                 return __result;
4991               else
4992                 {
4993                   __result = __new_result;
4994                   __first1 = __new_result;
4995                   ++__first1;
4996                 }
4997             }
4998         }
4999     }
5000
5001   // find_end for bidirectional iterators.  Requires partial specialization.
5002   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2>
5003     _BidirectionalIterator1
5004     __find_end(_BidirectionalIterator1 __first1,
5005                _BidirectionalIterator1 __last1,
5006                _BidirectionalIterator2 __first2,
5007                _BidirectionalIterator2 __last2,
5008                bidirectional_iterator_tag, bidirectional_iterator_tag)
5009     {
5010       // concept requirements
5011       __glibcxx_function_requires(_BidirectionalIteratorConcept<
5012                                   _BidirectionalIterator1>)
5013       __glibcxx_function_requires(_BidirectionalIteratorConcept<
5014                                   _BidirectionalIterator2>)
5015
5016       typedef reverse_iterator<_BidirectionalIterator1> _RevIterator1;
5017       typedef reverse_iterator<_BidirectionalIterator2> _RevIterator2;
5018
5019       _RevIterator1 __rlast1(__first1);
5020       _RevIterator2 __rlast2(__first2);
5021       _RevIterator1 __rresult = std::search(_RevIterator1(__last1), __rlast1,
5022                                             _RevIterator2(__last2), __rlast2);
5023
5024       if (__rresult == __rlast1)
5025         return __last1;
5026       else
5027         {
5028           _BidirectionalIterator1 __result = __rresult.base();
5029           std::advance(__result, -std::distance(__first2, __last2));
5030           return __result;
5031         }
5032     }
5033
5034   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
5035            typename _BinaryPredicate>
5036     _BidirectionalIterator1
5037     __find_end(_BidirectionalIterator1 __first1,
5038                _BidirectionalIterator1 __last1,
5039                _BidirectionalIterator2 __first2,
5040                _BidirectionalIterator2 __last2,
5041                bidirectional_iterator_tag, bidirectional_iterator_tag,
5042                _BinaryPredicate __comp)
5043     {
5044       // concept requirements
5045       __glibcxx_function_requires(_BidirectionalIteratorConcept<
5046                                   _BidirectionalIterator1>)
5047       __glibcxx_function_requires(_BidirectionalIteratorConcept<
5048                                   _BidirectionalIterator2>)
5049
5050       typedef reverse_iterator<_BidirectionalIterator1> _RevIterator1;
5051       typedef reverse_iterator<_BidirectionalIterator2> _RevIterator2;
5052
5053       _RevIterator1 __rlast1(__first1);
5054       _RevIterator2 __rlast2(__first2);
5055       _RevIterator1 __rresult = std::search(_RevIterator1(__last1), __rlast1,
5056                                             _RevIterator2(__last2), __rlast2,
5057                                             __comp);
5058
5059       if (__rresult == __rlast1)
5060         return __last1;
5061       else
5062         {
5063           _BidirectionalIterator1 __result = __rresult.base();
5064           std::advance(__result, -std::distance(__first2, __last2));
5065           return __result;
5066         }
5067     }
5068
5069   // Dispatching functions for find_end.
5070
5071   /**
5072    *  @brief  Find last matching subsequence in a sequence.
5073    *  @param  first1  Start of range to search.
5074    *  @param  last1   End of range to search.
5075    *  @param  first2  Start of sequence to match.
5076    *  @param  last2   End of sequence to match.
5077    *  @return   The last iterator @c i in the range
5078    *  @p [first1,last1-(last2-first2)) such that @c *(i+N) == @p *(first2+N)
5079    *  for each @c N in the range @p [0,last2-first2), or @p last1 if no
5080    *  such iterator exists.
5081    *
5082    *  Searches the range @p [first1,last1) for a sub-sequence that compares
5083    *  equal value-by-value with the sequence given by @p [first2,last2) and
5084    *  returns an iterator to the first element of the sub-sequence, or
5085    *  @p last1 if the sub-sequence is not found.  The sub-sequence will be the
5086    *  last such subsequence contained in [first,last1).
5087    *
5088    *  Because the sub-sequence must lie completely within the range
5089    *  @p [first1,last1) it must start at a position less than
5090    *  @p last1-(last2-first2) where @p last2-first2 is the length of the
5091    *  sub-sequence.
5092    *  This means that the returned iterator @c i will be in the range
5093    *  @p [first1,last1-(last2-first2))
5094   */
5095   template<typename _ForwardIterator1, typename _ForwardIterator2>
5096     inline _ForwardIterator1
5097     find_end(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
5098              _ForwardIterator2 __first2, _ForwardIterator2 __last2)
5099     {
5100       // concept requirements
5101       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
5102       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
5103       __glibcxx_function_requires(_EqualOpConcept<
5104             typename iterator_traits<_ForwardIterator1>::value_type,
5105             typename iterator_traits<_ForwardIterator2>::value_type>)
5106       __glibcxx_requires_valid_range(__first1, __last1);
5107       __glibcxx_requires_valid_range(__first2, __last2);
5108
5109       return std::__find_end(__first1, __last1, __first2, __last2,
5110                              std::__iterator_category(__first1),
5111                              std::__iterator_category(__first2));
5112     }
5113
5114   /**
5115    *  @brief  Find last matching subsequence in a sequence using a predicate.
5116    *  @param  first1  Start of range to search.
5117    *  @param  last1   End of range to search.
5118    *  @param  first2  Start of sequence to match.
5119    *  @param  last2   End of sequence to match.
5120    *  @param  comp    The predicate to use.
5121    *  @return   The last iterator @c i in the range
5122    *  @p [first1,last1-(last2-first2)) such that @c predicate(*(i+N), @p
5123    *  (first2+N)) is true for each @c N in the range @p [0,last2-first2), or
5124    *  @p last1 if no such iterator exists.
5125    *
5126    *  Searches the range @p [first1,last1) for a sub-sequence that compares
5127    *  equal value-by-value with the sequence given by @p [first2,last2) using
5128    *  comp as a predicate and returns an iterator to the first element of the
5129    *  sub-sequence, or @p last1 if the sub-sequence is not found.  The
5130    *  sub-sequence will be the last such subsequence contained in
5131    *  [first,last1).
5132    *
5133    *  Because the sub-sequence must lie completely within the range
5134    *  @p [first1,last1) it must start at a position less than
5135    *  @p last1-(last2-first2) where @p last2-first2 is the length of the
5136    *  sub-sequence.
5137    *  This means that the returned iterator @c i will be in the range
5138    *  @p [first1,last1-(last2-first2))
5139   */
5140   template<typename _ForwardIterator1, typename _ForwardIterator2,
5141            typename _BinaryPredicate>
5142     inline _ForwardIterator1
5143     find_end(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
5144              _ForwardIterator2 __first2, _ForwardIterator2 __last2,
5145              _BinaryPredicate __comp)
5146     {
5147       // concept requirements
5148       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
5149       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
5150       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
5151             typename iterator_traits<_ForwardIterator1>::value_type,
5152             typename iterator_traits<_ForwardIterator2>::value_type>)
5153       __glibcxx_requires_valid_range(__first1, __last1);
5154       __glibcxx_requires_valid_range(__first2, __last2);
5155
5156       return std::__find_end(__first1, __last1, __first2, __last2,
5157                              std::__iterator_category(__first1),
5158                              std::__iterator_category(__first2),
5159                              __comp);
5160     }
5161
5162 } // namespace std
5163
5164 #endif /* _ALGO_H */