OSDN Git Service

2003-12-04 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / bits / stl_algo.h
1 // Algorithm implementation -*- C++ -*-
2
3 // Copyright (C) 2001, 2002, 2003 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,
171          input_iterator_tag)
172     {
173       while (__first != __last && !(*__first == __val))
174         ++__first;
175       return __first;
176     }
177
178   /**
179    *  @if maint
180    *  This is an overload used by find_if() for the Input Iterator case.
181    *  @endif
182   */
183   template<typename _InputIterator, typename _Predicate>
184     inline _InputIterator
185     find_if(_InputIterator __first, _InputIterator __last,
186             _Predicate __pred,
187             input_iterator_tag)
188     {
189       while (__first != __last && !__pred(*__first))
190         ++__first;
191       return __first;
192     }
193
194   /**
195    *  @if maint
196    *  This is an overload used by find() for the RAI case.
197    *  @endif
198   */
199   template<typename _RandomAccessIterator, typename _Tp>
200     _RandomAccessIterator
201     find(_RandomAccessIterator __first, _RandomAccessIterator __last,
202          const _Tp& __val,
203          random_access_iterator_tag)
204     {
205       typename iterator_traits<_RandomAccessIterator>::difference_type __trip_count
206         = (__last - __first) >> 2;
207
208       for ( ; __trip_count > 0 ; --__trip_count) {
209         if (*__first == __val) return __first;
210         ++__first;
211
212         if (*__first == __val) return __first;
213         ++__first;
214
215         if (*__first == __val) return __first;
216         ++__first;
217
218         if (*__first == __val) return __first;
219         ++__first;
220       }
221
222       switch(__last - __first) {
223       case 3:
224         if (*__first == __val) return __first;
225         ++__first;
226       case 2:
227         if (*__first == __val) return __first;
228         ++__first;
229       case 1:
230         if (*__first == __val) return __first;
231         ++__first;
232       case 0:
233       default:
234         return __last;
235       }
236     }
237
238   /**
239    *  @if maint
240    *  This is an overload used by find_if() for the RAI case.
241    *  @endif
242   */
243   template<typename _RandomAccessIterator, typename _Predicate>
244     _RandomAccessIterator
245     find_if(_RandomAccessIterator __first, _RandomAccessIterator __last,
246             _Predicate __pred,
247             random_access_iterator_tag)
248     {
249       typename iterator_traits<_RandomAccessIterator>::difference_type __trip_count
250         = (__last - __first) >> 2;
251
252       for ( ; __trip_count > 0 ; --__trip_count) {
253         if (__pred(*__first)) return __first;
254         ++__first;
255
256         if (__pred(*__first)) return __first;
257         ++__first;
258
259         if (__pred(*__first)) return __first;
260         ++__first;
261
262         if (__pred(*__first)) return __first;
263         ++__first;
264       }
265
266       switch(__last - __first) {
267       case 3:
268         if (__pred(*__first)) return __first;
269         ++__first;
270       case 2:
271         if (__pred(*__first)) return __first;
272         ++__first;
273       case 1:
274         if (__pred(*__first)) return __first;
275         ++__first;
276       case 0:
277       default:
278         return __last;
279       }
280     }
281
282   /**
283    *  @brief Find the first occurrence of a value in a sequence.
284    *  @param  first  An input iterator.
285    *  @param  last   An input iterator.
286    *  @param  val    The value to find.
287    *  @return   The first iterator @c i in the range @p [first,last)
288    *  such that @c *i == @p val, or @p last if no such iterator exists.
289   */
290   template<typename _InputIterator, typename _Tp>
291     inline _InputIterator
292     find(_InputIterator __first, _InputIterator __last,
293          const _Tp& __val)
294     {
295       // concept requirements
296       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
297       __glibcxx_function_requires(_EqualOpConcept<
298                 typename iterator_traits<_InputIterator>::value_type, _Tp>)
299       __glibcxx_requires_valid_range(__first, __last);
300       return std::find(__first, __last, __val, std::__iterator_category(__first));
301     }
302
303   /**
304    *  @brief Find the first element in a sequence for which a predicate is true.
305    *  @param  first  An input iterator.
306    *  @param  last   An input iterator.
307    *  @param  pred   A predicate.
308    *  @return   The first iterator @c i in the range @p [first,last)
309    *  such that @p pred(*i) is true, or @p last if no such iterator exists.
310   */
311   template<typename _InputIterator, typename _Predicate>
312     inline _InputIterator
313     find_if(_InputIterator __first, _InputIterator __last,
314             _Predicate __pred)
315     {
316       // concept requirements
317       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
318       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
319               typename iterator_traits<_InputIterator>::value_type>)
320       __glibcxx_requires_valid_range(__first, __last);
321       return std::find_if(__first, __last, __pred, std::__iterator_category(__first));
322     }
323
324   /**
325    *  @brief Find two adjacent values in a sequence that are equal.
326    *  @param  first  A forward iterator.
327    *  @param  last   A forward iterator.
328    *  @return   The first iterator @c i such that @c i and @c i+1 are both
329    *  valid iterators in @p [first,last) and such that @c *i == @c *(i+1),
330    *  or @p last if no such iterator exists.
331   */
332   template<typename _ForwardIterator>
333     _ForwardIterator
334     adjacent_find(_ForwardIterator __first, _ForwardIterator __last)
335     {
336       // concept requirements
337       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
338       __glibcxx_function_requires(_EqualityComparableConcept<
339             typename iterator_traits<_ForwardIterator>::value_type>)
340       __glibcxx_requires_valid_range(__first, __last);
341       if (__first == __last)
342         return __last;
343       _ForwardIterator __next = __first;
344       while(++__next != __last) {
345         if (*__first == *__next)
346           return __first;
347         __first = __next;
348       }
349       return __last;
350     }
351
352   /**
353    *  @brief Find two adjacent values in a sequence using a predicate.
354    *  @param  first         A forward iterator.
355    *  @param  last          A forward iterator.
356    *  @param  binary_pred   A binary predicate.
357    *  @return   The first iterator @c i such that @c i and @c i+1 are both
358    *  valid iterators in @p [first,last) and such that
359    *  @p binary_pred(*i,*(i+1)) is true, or @p last if no such iterator
360    *  exists.
361   */
362   template<typename _ForwardIterator, typename _BinaryPredicate>
363     _ForwardIterator
364     adjacent_find(_ForwardIterator __first, _ForwardIterator __last,
365                   _BinaryPredicate __binary_pred)
366     {
367       // concept requirements
368       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
369       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
370             typename iterator_traits<_ForwardIterator>::value_type,
371             typename iterator_traits<_ForwardIterator>::value_type>)
372       __glibcxx_requires_valid_range(__first, __last);
373       if (__first == __last)
374         return __last;
375       _ForwardIterator __next = __first;
376       while(++__next != __last) {
377         if (__binary_pred(*__first, *__next))
378           return __first;
379         __first = __next;
380       }
381       return __last;
382     }
383
384   /**
385    *  @brief Count the number of copies of a value in a sequence.
386    *  @param  first  An input iterator.
387    *  @param  last   An input iterator.
388    *  @param  value  The value to be counted.
389    *  @return   The number of iterators @c i in the range @p [first,last)
390    *  for which @c *i == @p value
391   */
392   template<typename _InputIterator, typename _Tp>
393     typename iterator_traits<_InputIterator>::difference_type
394     count(_InputIterator __first, _InputIterator __last, const _Tp& __value)
395     {
396       // concept requirements
397       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
398       __glibcxx_function_requires(_EqualityComparableConcept<
399             typename iterator_traits<_InputIterator>::value_type >)
400       __glibcxx_function_requires(_EqualityComparableConcept<_Tp>)
401       __glibcxx_requires_valid_range(__first, __last);
402       typename iterator_traits<_InputIterator>::difference_type __n = 0;
403       for ( ; __first != __last; ++__first)
404         if (*__first == __value)
405           ++__n;
406       return __n;
407     }
408
409   /**
410    *  @brief Count the elements of a sequence for which a predicate is true.
411    *  @param  first  An input iterator.
412    *  @param  last   An input iterator.
413    *  @param  pred   A predicate.
414    *  @return   The number of iterators @c i in the range @p [first,last)
415    *  for which @p pred(*i) is true.
416   */
417   template<typename _InputIterator, typename _Predicate>
418     typename iterator_traits<_InputIterator>::difference_type
419     count_if(_InputIterator __first, _InputIterator __last, _Predicate __pred)
420     {
421       // concept requirements
422       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
423       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
424             typename iterator_traits<_InputIterator>::value_type>)
425       __glibcxx_requires_valid_range(__first, __last);
426       typename iterator_traits<_InputIterator>::difference_type __n = 0;
427       for ( ; __first != __last; ++__first)
428         if (__pred(*__first))
429           ++__n;
430       return __n;
431     }
432
433
434   /**
435    *  @brief Search a sequence for a matching sub-sequence.
436    *  @param  first1  A forward iterator.
437    *  @param  last1   A forward iterator.
438    *  @param  first2  A forward iterator.
439    *  @param  last2   A forward iterator.
440    *  @return   The first iterator @c i in the range
441    *  @p [first1,last1-(last2-first2)) such that @c *(i+N) == @p *(first2+N)
442    *  for each @c N in the range @p [0,last2-first2), or @p last1 if no
443    *  such iterator exists.
444    *
445    *  Searches the range @p [first1,last1) for a sub-sequence that compares
446    *  equal value-by-value with the sequence given by @p [first2,last2) and
447    *  returns an iterator to the first element of the sub-sequence, or
448    *  @p last1 if the sub-sequence is not found.
449    *
450    *  Because the sub-sequence must lie completely within the range
451    *  @p [first1,last1) it must start at a position less than
452    *  @p last1-(last2-first2) where @p last2-first2 is the length of the
453    *  sub-sequence.
454    *  This means that the returned iterator @c i will be in the range
455    *  @p [first1,last1-(last2-first2))
456   */
457   template<typename _ForwardIterator1, typename _ForwardIterator2>
458     _ForwardIterator1
459     search(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
460            _ForwardIterator2 __first2, _ForwardIterator2 __last2)
461     {
462       // concept requirements
463       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
464       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
465       __glibcxx_function_requires(_EqualOpConcept<
466             typename iterator_traits<_ForwardIterator1>::value_type,
467             typename iterator_traits<_ForwardIterator2>::value_type>)
468       __glibcxx_requires_valid_range(__first1, __last1);
469       __glibcxx_requires_valid_range(__first2, __last2);
470       // Test for empty ranges
471       if (__first1 == __last1 || __first2 == __last2)
472         return __first1;
473
474       // Test for a pattern of length 1.
475       _ForwardIterator2 __tmp(__first2);
476       ++__tmp;
477       if (__tmp == __last2)
478         return std::find(__first1, __last1, *__first2);
479
480       // General case.
481
482       _ForwardIterator2 __p1, __p;
483
484       __p1 = __first2; ++__p1;
485
486       _ForwardIterator1 __current = __first1;
487
488       while (__first1 != __last1) {
489         __first1 = std::find(__first1, __last1, *__first2);
490         if (__first1 == __last1)
491           return __last1;
492
493         __p = __p1;
494         __current = __first1;
495         if (++__current == __last1)
496           return __last1;
497
498         while (*__current == *__p) {
499           if (++__p == __last2)
500             return __first1;
501           if (++__current == __last1)
502             return __last1;
503         }
504
505         ++__first1;
506       }
507       return __first1;
508     }
509
510   /**
511    *  @brief Search a sequence for a matching sub-sequence using a predicate.
512    *  @param  first1     A forward iterator.
513    *  @param  last1      A forward iterator.
514    *  @param  first2     A forward iterator.
515    *  @param  last2      A forward iterator.
516    *  @param  predicate  A binary predicate.
517    *  @return   The first iterator @c i in the range
518    *  @p [first1,last1-(last2-first2)) such that
519    *  @p predicate(*(i+N),*(first2+N)) is true for each @c N in the range
520    *  @p [0,last2-first2), or @p last1 if no such iterator exists.
521    *
522    *  Searches the range @p [first1,last1) for a sub-sequence that compares
523    *  equal value-by-value with the sequence given by @p [first2,last2),
524    *  using @p predicate to determine equality, and returns an iterator
525    *  to the first element of the sub-sequence, or @p last1 if no such
526    *  iterator exists.
527    *
528    *  @see search(_ForwardIter1, _ForwardIter1, _ForwardIter2, _ForwardIter2)
529   */
530   template<typename _ForwardIterator1, typename _ForwardIterator2, typename _BinaryPredicate>
531     _ForwardIterator1
532     search(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
533            _ForwardIterator2 __first2, _ForwardIterator2 __last2,
534            _BinaryPredicate  __predicate)
535     {
536       // concept requirements
537       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator1>)
538       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator2>)
539       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
540             typename iterator_traits<_ForwardIterator1>::value_type,
541             typename iterator_traits<_ForwardIterator2>::value_type>)
542       __glibcxx_requires_valid_range(__first1, __last1);
543       __glibcxx_requires_valid_range(__first2, __last2);
544
545       // Test for empty ranges
546       if (__first1 == __last1 || __first2 == __last2)
547         return __first1;
548
549       // Test for a pattern of length 1.
550       _ForwardIterator2 __tmp(__first2);
551       ++__tmp;
552       if (__tmp == __last2) {
553         while (__first1 != __last1 && !__predicate(*__first1, *__first2))
554           ++__first1;
555         return __first1;
556       }
557
558       // General case.
559
560       _ForwardIterator2 __p1, __p;
561
562       __p1 = __first2; ++__p1;
563
564       _ForwardIterator1 __current = __first1;
565
566       while (__first1 != __last1) {
567         while (__first1 != __last1) {
568           if (__predicate(*__first1, *__first2))
569             break;
570           ++__first1;
571         }
572         while (__first1 != __last1 && !__predicate(*__first1, *__first2))
573           ++__first1;
574         if (__first1 == __last1)
575           return __last1;
576
577         __p = __p1;
578         __current = __first1;
579         if (++__current == __last1) return __last1;
580
581         while (__predicate(*__current, *__p)) {
582           if (++__p == __last2)
583             return __first1;
584           if (++__current == __last1)
585             return __last1;
586         }
587
588         ++__first1;
589       }
590       return __first1;
591     }
592
593   /**
594    *  @brief Search a sequence for a number of consecutive values.
595    *  @param  first  A forward iterator.
596    *  @param  last   A forward iterator.
597    *  @param  count  The number of consecutive values.
598    *  @param  val    The value to find.
599    *  @return   The first iterator @c i in the range @p [first,last-count)
600    *  such that @c *(i+N) == @p val for each @c N in the range @p [0,count),
601    *  or @p last if no such iterator exists.
602    *
603    *  Searches the range @p [first,last) for @p count consecutive elements
604    *  equal to @p val.
605   */
606   template<typename _ForwardIterator, typename _Integer, typename _Tp>
607     _ForwardIterator
608     search_n(_ForwardIterator __first, _ForwardIterator __last,
609              _Integer __count, const _Tp& __val)
610     {
611       // concept requirements
612       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
613       __glibcxx_function_requires(_EqualityComparableConcept<
614             typename iterator_traits<_ForwardIterator>::value_type>)
615       __glibcxx_function_requires(_EqualityComparableConcept<_Tp>)
616       __glibcxx_requires_valid_range(__first, __last);
617
618       if (__count <= 0)
619         return __first;
620       else {
621         __first = std::find(__first, __last, __val);
622         while (__first != __last) {
623           typename iterator_traits<_ForwardIterator>::difference_type __n = __count;
624           _ForwardIterator __i = __first;
625           ++__i;
626           while (__i != __last && __n != 1 && *__i == __val) {
627             ++__i;
628             --__n;
629           }
630           if (__n == 1)
631             return __first;
632           else
633             __first = std::find(__i, __last, __val);
634         }
635         return __last;
636       }
637     }
638
639   /**
640    *  @brief Search a sequence for a number of consecutive values using a
641    *         predicate.
642    *  @param  first        A forward iterator.
643    *  @param  last         A forward iterator.
644    *  @param  count        The number of consecutive values.
645    *  @param  val          The value to find.
646    *  @param  binary_pred  A binary predicate.
647    *  @return   The first iterator @c i in the range @p [first,last-count)
648    *  such that @p binary_pred(*(i+N),val) is true for each @c N in the
649    *  range @p [0,count), or @p last if no such iterator exists.
650    *
651    *  Searches the range @p [first,last) for @p count consecutive elements
652    *  for which the predicate returns true.
653   */
654   template<typename _ForwardIterator, typename _Integer, typename _Tp,
655            typename _BinaryPredicate>
656     _ForwardIterator
657     search_n(_ForwardIterator __first, _ForwardIterator __last,
658              _Integer __count, const _Tp& __val,
659              _BinaryPredicate __binary_pred)
660     {
661       // concept requirements
662       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
663       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
664             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
665       __glibcxx_requires_valid_range(__first, __last);
666
667       if (__count <= 0)
668         return __first;
669       else {
670         while (__first != __last) {
671           if (__binary_pred(*__first, __val))
672             break;
673           ++__first;
674         }
675         while (__first != __last) {
676           typename iterator_traits<_ForwardIterator>::difference_type __n = __count;
677           _ForwardIterator __i = __first;
678           ++__i;
679           while (__i != __last && __n != 1 && __binary_pred(*__i, __val)) {
680             ++__i;
681             --__n;
682           }
683           if (__n == 1)
684             return __first;
685           else {
686             while (__i != __last) {
687               if (__binary_pred(*__i, __val))
688                 break;
689               ++__i;
690             }
691             __first = __i;
692           }
693         }
694         return __last;
695       }
696     }
697
698   /**
699    *  @brief Swap the elements of two sequences.
700    *  @param  first1  A forward iterator.
701    *  @param  last1   A forward iterator.
702    *  @param  first2  A forward iterator.
703    *  @return   An iterator equal to @p first2+(last1-first1).
704    *
705    *  Swaps each element in the range @p [first1,last1) with the
706    *  corresponding element in the range @p [first2,(last1-first1)).
707    *  The ranges must not overlap.
708   */
709   template<typename _ForwardIterator1, typename _ForwardIterator2>
710     _ForwardIterator2
711     swap_ranges(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
712                 _ForwardIterator2 __first2)
713     {
714       // concept requirements
715       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator1>)
716       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator2>)
717       __glibcxx_function_requires(_ConvertibleConcept<
718             typename iterator_traits<_ForwardIterator1>::value_type,
719             typename iterator_traits<_ForwardIterator2>::value_type>)
720       __glibcxx_function_requires(_ConvertibleConcept<
721             typename iterator_traits<_ForwardIterator2>::value_type,
722             typename iterator_traits<_ForwardIterator1>::value_type>)
723       __glibcxx_requires_valid_range(__first1, __last1);
724
725       for ( ; __first1 != __last1; ++__first1, ++__first2)
726         std::iter_swap(__first1, __first2);
727       return __first2;
728     }
729
730   /**
731    *  @brief Perform an operation on a sequence.
732    *  @param  first     An input iterator.
733    *  @param  last      An input iterator.
734    *  @param  result    An output iterator.
735    *  @param  unary_op  A unary operator.
736    *  @return   An output iterator equal to @p result+(last-first).
737    *
738    *  Applies the operator to each element in the input range and assigns
739    *  the results to successive elements of the output sequence.
740    *  Evaluates @p *(result+N)=unary_op(*(first+N)) for each @c N in the
741    *  range @p [0,last-first).
742    *
743    *  @p unary_op must not alter its argument.
744   */
745   template<typename _InputIterator, typename _OutputIterator, typename _UnaryOperation>
746     _OutputIterator
747     transform(_InputIterator __first, _InputIterator __last,
748               _OutputIterator __result, _UnaryOperation __unary_op)
749     {
750       // concept requirements
751       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
752       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
753             // "the type returned by a _UnaryOperation"
754             __typeof__(__unary_op(*__first))>)
755       __glibcxx_requires_valid_range(__first, __last);
756
757       for ( ; __first != __last; ++__first, ++__result)
758         *__result = __unary_op(*__first);
759       return __result;
760     }
761
762   /**
763    *  @brief Perform an operation on corresponding elements of two sequences.
764    *  @param  first1     An input iterator.
765    *  @param  last1      An input iterator.
766    *  @param  first2     An input iterator.
767    *  @param  result     An output iterator.
768    *  @param  binary_op  A binary operator.
769    *  @return   An output iterator equal to @p result+(last-first).
770    *
771    *  Applies the operator to the corresponding elements in the two
772    *  input ranges and assigns the results to successive elements of the
773    *  output sequence.
774    *  Evaluates @p *(result+N)=binary_op(*(first1+N),*(first2+N)) for each
775    *  @c N in the range @p [0,last1-first1).
776    *
777    *  @p binary_op must not alter either of its arguments.
778   */
779   template<typename _InputIterator1, typename _InputIterator2, typename _OutputIterator,
780            typename _BinaryOperation>
781     _OutputIterator
782     transform(_InputIterator1 __first1, _InputIterator1 __last1,
783               _InputIterator2 __first2, _OutputIterator __result,
784               _BinaryOperation __binary_op)
785     {
786       // concept requirements
787       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
788       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
789       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
790             // "the type returned by a _BinaryOperation"
791             __typeof__(__binary_op(*__first1,*__first2))>)
792       __glibcxx_requires_valid_range(__first1, __last1);
793
794       for ( ; __first1 != __last1; ++__first1, ++__first2, ++__result)
795         *__result = __binary_op(*__first1, *__first2);
796       return __result;
797     }
798
799   /**
800    *  @brief Replace each occurrence of one value in a sequence with another
801    *         value.
802    *  @param  first      A forward iterator.
803    *  @param  last       A forward iterator.
804    *  @param  old_value  The value to be replaced.
805    *  @param  new_value  The replacement value.
806    *  @return   replace() returns no value.
807    *
808    *  For each iterator @c i in the range @p [first,last) if @c *i ==
809    *  @p old_value then the assignment @c *i = @p new_value is performed.
810   */
811   template<typename _ForwardIterator, typename _Tp>
812     void
813     replace(_ForwardIterator __first, _ForwardIterator __last,
814             const _Tp& __old_value, const _Tp& __new_value)
815     {
816       // concept requirements
817       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
818       __glibcxx_function_requires(_EqualOpConcept<
819             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
820       __glibcxx_function_requires(_ConvertibleConcept<_Tp,
821             typename iterator_traits<_ForwardIterator>::value_type>)
822       __glibcxx_requires_valid_range(__first, __last);
823
824       for ( ; __first != __last; ++__first)
825         if (*__first == __old_value)
826           *__first = __new_value;
827     }
828
829   /**
830    *  @brief Replace each value in a sequence for which a predicate returns
831    *         true with another value.
832    *  @param  first      A forward iterator.
833    *  @param  last       A forward iterator.
834    *  @param  pred       A predicate.
835    *  @param  new_value  The replacement value.
836    *  @return   replace_if() returns no value.
837    *
838    *  For each iterator @c i in the range @p [first,last) if @p pred(*i)
839    *  is true then the assignment @c *i = @p new_value is performed.
840   */
841   template<typename _ForwardIterator, typename _Predicate, typename _Tp>
842     void
843     replace_if(_ForwardIterator __first, _ForwardIterator __last,
844                _Predicate __pred, const _Tp& __new_value)
845     {
846       // concept requirements
847       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
848       __glibcxx_function_requires(_ConvertibleConcept<_Tp,
849             typename iterator_traits<_ForwardIterator>::value_type>)
850       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
851             typename iterator_traits<_ForwardIterator>::value_type>)
852       __glibcxx_requires_valid_range(__first, __last);
853
854       for ( ; __first != __last; ++__first)
855         if (__pred(*__first))
856           *__first = __new_value;
857     }
858
859   /**
860    *  @brief Copy a sequence, replacing each element of one value with another
861    *         value.
862    *  @param  first      An input iterator.
863    *  @param  last       An input iterator.
864    *  @param  result     An output iterator.
865    *  @param  old_value  The value to be replaced.
866    *  @param  new_value  The replacement value.
867    *  @return   The end of the output sequence, @p result+(last-first).
868    *
869    *  Copies each element in the input range @p [first,last) to the
870    *  output range @p [result,result+(last-first)) replacing elements
871    *  equal to @p old_value with @p new_value.
872   */
873   template<typename _InputIterator, typename _OutputIterator, typename _Tp>
874     _OutputIterator
875     replace_copy(_InputIterator __first, _InputIterator __last,
876                  _OutputIterator __result,
877                  const _Tp& __old_value, const _Tp& __new_value)
878     {
879       // concept requirements
880       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
881       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
882             typename iterator_traits<_InputIterator>::value_type>)
883       __glibcxx_function_requires(_EqualOpConcept<
884             typename iterator_traits<_InputIterator>::value_type, _Tp>)
885       __glibcxx_requires_valid_range(__first, __last);
886
887       for ( ; __first != __last; ++__first, ++__result)
888         *__result = *__first == __old_value ? __new_value : *__first;
889       return __result;
890     }
891
892   /**
893    *  @brief Copy a sequence, replacing each value for which a predicate
894    *         returns true with another value.
895    *  @param  first      An input iterator.
896    *  @param  last       An input iterator.
897    *  @param  result     An output iterator.
898    *  @param  pred       A predicate.
899    *  @param  new_value  The replacement value.
900    *  @return   The end of the output sequence, @p result+(last-first).
901    *
902    *  Copies each element in the range @p [first,last) to the range
903    *  @p [result,result+(last-first)) replacing elements for which
904    *  @p pred returns true with @p new_value.
905   */
906   template<typename _InputIterator, typename _OutputIterator, typename _Predicate,
907            typename _Tp>
908     _OutputIterator
909     replace_copy_if(_InputIterator __first, _InputIterator __last,
910                     _OutputIterator __result,
911                     _Predicate __pred, const _Tp& __new_value)
912     {
913       // concept requirements
914       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
915       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
916             typename iterator_traits<_InputIterator>::value_type>)
917       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
918             typename iterator_traits<_InputIterator>::value_type>)
919       __glibcxx_requires_valid_range(__first, __last);
920
921       for ( ; __first != __last; ++__first, ++__result)
922         *__result = __pred(*__first) ? __new_value : *__first;
923       return __result;
924     }
925
926   /**
927    *  @brief Assign the result of a function object to each value in a
928    *         sequence.
929    *  @param  first  A forward iterator.
930    *  @param  last   A forward iterator.
931    *  @param  gen    A function object taking no arguments.
932    *  @return   generate() returns no value.
933    *
934    *  Performs the assignment @c *i = @p gen() for each @c i in the range
935    *  @p [first,last).
936   */
937   template<typename _ForwardIterator, typename _Generator>
938     void
939     generate(_ForwardIterator __first, _ForwardIterator __last, _Generator __gen)
940     {
941       // concept requirements
942       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
943       __glibcxx_function_requires(_GeneratorConcept<_Generator,
944             typename iterator_traits<_ForwardIterator>::value_type>)
945       __glibcxx_requires_valid_range(__first, __last);
946
947       for ( ; __first != __last; ++__first)
948         *__first = __gen();
949     }
950
951   /**
952    *  @brief Assign the result of a function object to each value in a
953    *         sequence.
954    *  @param  first  A forward iterator.
955    *  @param  n      The length of the sequence.
956    *  @param  gen    A function object taking no arguments.
957    *  @return   The end of the sequence, @p first+n
958    *
959    *  Performs the assignment @c *i = @p gen() for each @c i in the range
960    *  @p [first,first+n).
961   */
962   template<typename _OutputIterator, typename _Size, typename _Generator>
963     _OutputIterator
964     generate_n(_OutputIterator __first, _Size __n, _Generator __gen)
965     {
966       // concept requirements
967       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
968             // "the type returned by a _Generator"
969             __typeof__(__gen())>)
970
971       for ( ; __n > 0; --__n, ++__first)
972         *__first = __gen();
973       return __first;
974     }
975
976   /**
977    *  @brief Copy a sequence, removing elements of a given value.
978    *  @param  first   An input iterator.
979    *  @param  last    An input iterator.
980    *  @param  result  An output iterator.
981    *  @param  value   The value to be removed.
982    *  @return   An iterator designating the end of the resulting sequence.
983    *
984    *  Copies each element in the range @p [first,last) not equal to @p value
985    *  to the range beginning at @p result.
986    *  remove_copy() is stable, so the relative order of elements that are
987    *  copied is unchanged.
988   */
989   template<typename _InputIterator, typename _OutputIterator, typename _Tp>
990     _OutputIterator
991     remove_copy(_InputIterator __first, _InputIterator __last,
992                 _OutputIterator __result, const _Tp& __value)
993     {
994       // concept requirements
995       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
996       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
997             typename iterator_traits<_InputIterator>::value_type>)
998       __glibcxx_function_requires(_EqualOpConcept<
999             typename iterator_traits<_InputIterator>::value_type, _Tp>)
1000       __glibcxx_requires_valid_range(__first, __last);
1001
1002       for ( ; __first != __last; ++__first)
1003         if (!(*__first == __value)) {
1004           *__result = *__first;
1005           ++__result;
1006         }
1007       return __result;
1008     }
1009
1010   /**
1011    *  @brief Copy a sequence, removing elements for which a predicate is true.
1012    *  @param  first   An input iterator.
1013    *  @param  last    An input iterator.
1014    *  @param  result  An output iterator.
1015    *  @param  pred    A predicate.
1016    *  @return   An iterator designating the end of the resulting sequence.
1017    *
1018    *  Copies each element in the range @p [first,last) for which
1019    *  @p pred returns true to the range beginning at @p result.
1020    *
1021    *  remove_copy_if() is stable, so the relative order of elements that are
1022    *  copied is unchanged.
1023   */
1024   template<typename _InputIterator, typename _OutputIterator, typename _Predicate>
1025     _OutputIterator
1026     remove_copy_if(_InputIterator __first, _InputIterator __last,
1027                    _OutputIterator __result, _Predicate __pred)
1028     {
1029       // concept requirements
1030       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1031       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1032             typename iterator_traits<_InputIterator>::value_type>)
1033       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1034             typename iterator_traits<_InputIterator>::value_type>)
1035       __glibcxx_requires_valid_range(__first, __last);
1036
1037       for ( ; __first != __last; ++__first)
1038         if (!__pred(*__first)) {
1039           *__result = *__first;
1040           ++__result;
1041         }
1042       return __result;
1043     }
1044
1045   /**
1046    *  @brief Remove elements from a sequence.
1047    *  @param  first  An input iterator.
1048    *  @param  last   An input iterator.
1049    *  @param  value  The value to be removed.
1050    *  @return   An iterator designating the end of the resulting sequence.
1051    *
1052    *  All elements equal to @p value are removed from the range
1053    *  @p [first,last).
1054    *
1055    *  remove() is stable, so the relative order of elements that are
1056    *  not removed is unchanged.
1057    *
1058    *  Elements between the end of the resulting sequence and @p last
1059    *  are still present, but their value is unspecified.
1060   */
1061   template<typename _ForwardIterator, typename _Tp>
1062     _ForwardIterator
1063     remove(_ForwardIterator __first, _ForwardIterator __last,
1064            const _Tp& __value)
1065     {
1066       // concept requirements
1067       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1068       __glibcxx_function_requires(_ConvertibleConcept<_Tp,
1069             typename iterator_traits<_ForwardIterator>::value_type>)
1070       __glibcxx_function_requires(_EqualOpConcept<
1071             typename iterator_traits<_ForwardIterator>::value_type, _Tp>)
1072       __glibcxx_requires_valid_range(__first, __last);
1073
1074       __first = std::find(__first, __last, __value);
1075       _ForwardIterator __i = __first;
1076       return __first == __last ? __first
1077                                : std::remove_copy(++__i, __last, __first, __value);
1078     }
1079
1080   /**
1081    *  @brief Remove elements from a sequence using a predicate.
1082    *  @param  first  A forward iterator.
1083    *  @param  last   A forward iterator.
1084    *  @param  pred   A predicate.
1085    *  @return   An iterator designating the end of the resulting sequence.
1086    *
1087    *  All elements for which @p pred returns true are removed from the range
1088    *  @p [first,last).
1089    *
1090    *  remove_if() 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 _Predicate>
1097     _ForwardIterator
1098     remove_if(_ForwardIterator __first, _ForwardIterator __last,
1099               _Predicate __pred)
1100     {
1101       // concept requirements
1102       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1103       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1104             typename iterator_traits<_ForwardIterator>::value_type>)
1105       __glibcxx_requires_valid_range(__first, __last);
1106
1107       __first = std::find_if(__first, __last, __pred);
1108       _ForwardIterator __i = __first;
1109       return __first == __last ? __first
1110                                : std::remove_copy_if(++__i, __last, __first, __pred);
1111     }
1112
1113   /**
1114    *  @if maint
1115    *  This is an uglified unique_copy(_InputIterator, _InputIterator, _OutputIterator)
1116    *  overloaded for output iterators.
1117    *  @endif
1118   */
1119   template<typename _InputIterator, typename _OutputIterator>
1120     _OutputIterator
1121     __unique_copy(_InputIterator __first, _InputIterator __last,
1122                   _OutputIterator __result,
1123                   output_iterator_tag)
1124     {
1125       // concept requirements -- taken care of in dispatching function
1126       typename iterator_traits<_InputIterator>::value_type __value = *__first;
1127       *__result = __value;
1128       while (++__first != __last)
1129         if (!(__value == *__first)) {
1130           __value = *__first;
1131           *++__result = __value;
1132         }
1133       return ++__result;
1134     }
1135
1136   /**
1137    *  @if maint
1138    *  This is an uglified unique_copy(_InputIterator, _InputIterator, _OutputIterator)
1139    *  overloaded for forward iterators.
1140    *  @endif
1141   */
1142   template<typename _InputIterator, typename _ForwardIterator>
1143     _ForwardIterator
1144     __unique_copy(_InputIterator __first, _InputIterator __last,
1145                   _ForwardIterator __result,
1146                   forward_iterator_tag)
1147     {
1148       // concept requirements -- taken care of in dispatching function
1149       *__result = *__first;
1150       while (++__first != __last)
1151         if (!(*__result == *__first))
1152           *++__result = *__first;
1153       return ++__result;
1154     }
1155
1156   /**
1157    *  @if maint
1158    *  This is an uglified
1159    *  unique_copy(_InputIterator, _InputIterator, _OutputIterator, _BinaryPredicate)
1160    *  overloaded for output iterators.
1161    *  @endif
1162   */
1163   template<typename _InputIterator, typename _OutputIterator, typename _BinaryPredicate>
1164     _OutputIterator
1165     __unique_copy(_InputIterator __first, _InputIterator __last,
1166                   _OutputIterator __result,
1167                   _BinaryPredicate __binary_pred,
1168                   output_iterator_tag)
1169     {
1170       // concept requirements -- iterators already checked
1171       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1172           typename iterator_traits<_InputIterator>::value_type,
1173           typename iterator_traits<_InputIterator>::value_type>)
1174
1175       typename iterator_traits<_InputIterator>::value_type __value = *__first;
1176       *__result = __value;
1177       while (++__first != __last)
1178         if (!__binary_pred(__value, *__first)) {
1179           __value = *__first;
1180           *++__result = __value;
1181         }
1182       return ++__result;
1183     }
1184
1185   /**
1186    *  @if maint
1187    *  This is an uglified
1188    *  unique_copy(_InputIterator, _InputIterator, _OutputIterator, _BinaryPredicate)
1189    *  overloaded for forward iterators.
1190    *  @endif
1191   */
1192   template<typename _InputIterator, typename _ForwardIterator, typename _BinaryPredicate>
1193     _ForwardIterator
1194     __unique_copy(_InputIterator __first, _InputIterator __last,
1195                   _ForwardIterator __result,
1196                   _BinaryPredicate __binary_pred,
1197                   forward_iterator_tag)
1198     {
1199       // concept requirements -- iterators already checked
1200       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1201             typename iterator_traits<_ForwardIterator>::value_type,
1202             typename iterator_traits<_InputIterator>::value_type>)
1203
1204       *__result = *__first;
1205       while (++__first != __last)
1206         if (!__binary_pred(*__result, *__first)) *++__result = *__first;
1207       return ++__result;
1208     }
1209
1210   /**
1211    *  @brief Copy a sequence, removing consecutive duplicate values.
1212    *  @param  first   An input iterator.
1213    *  @param  last    An input iterator.
1214    *  @param  result  An output iterator.
1215    *  @return   An iterator designating the end of the resulting sequence.
1216    *
1217    *  Copies each element in the range @p [first,last) to the range
1218    *  beginning at @p result, except that only the first element is copied
1219    *  from groups of consecutive elements that compare equal.
1220    *  unique_copy() is stable, so the relative order of elements that are
1221    *  copied is unchanged.
1222   */
1223   template<typename _InputIterator, typename _OutputIterator>
1224     inline _OutputIterator
1225     unique_copy(_InputIterator __first, _InputIterator __last,
1226                 _OutputIterator __result)
1227     {
1228       // concept requirements
1229       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1230       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1231             typename iterator_traits<_InputIterator>::value_type>)
1232       __glibcxx_function_requires(_EqualityComparableConcept<
1233             typename iterator_traits<_InputIterator>::value_type>)
1234       __glibcxx_requires_valid_range(__first, __last);
1235
1236       typedef typename iterator_traits<_OutputIterator>::iterator_category _IterType;
1237
1238       if (__first == __last) return __result;
1239       return std::__unique_copy(__first, __last, __result, _IterType());
1240     }
1241
1242   /**
1243    *  @brief Copy a sequence, removing consecutive values using a predicate.
1244    *  @param  first        An input iterator.
1245    *  @param  last         An input iterator.
1246    *  @param  result       An output iterator.
1247    *  @param  binary_pred  A binary predicate.
1248    *  @return   An iterator designating the end of the resulting sequence.
1249    *
1250    *  Copies each element in the range @p [first,last) to the range
1251    *  beginning at @p result, except that only the first element is copied
1252    *  from groups of consecutive elements for which @p binary_pred returns
1253    *  true.
1254    *  unique_copy() is stable, so the relative order of elements that are
1255    *  copied is unchanged.
1256   */
1257   template<typename _InputIterator, typename _OutputIterator, typename _BinaryPredicate>
1258     inline _OutputIterator
1259     unique_copy(_InputIterator __first, _InputIterator __last,
1260                 _OutputIterator __result,
1261                 _BinaryPredicate __binary_pred)
1262     {
1263       // concept requirements -- predicates checked later
1264       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
1265       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1266             typename iterator_traits<_InputIterator>::value_type>)
1267       __glibcxx_requires_valid_range(__first, __last);
1268
1269       typedef typename iterator_traits<_OutputIterator>::iterator_category _IterType;
1270
1271       if (__first == __last) return __result;
1272       return std::__unique_copy(__first, __last, __result, __binary_pred, _IterType());
1273     }
1274
1275   /**
1276    *  @brief Remove consecutive duplicate values from a sequence.
1277    *  @param  first  A forward iterator.
1278    *  @param  last   A forward iterator.
1279    *  @return  An iterator designating the end of the resulting sequence.
1280    *
1281    *  Removes all but the first element from each group of consecutive
1282    *  values that compare equal.
1283    *  unique() is stable, so the relative order of elements that are
1284    *  not removed is unchanged.
1285    *  Elements between the end of the resulting sequence and @p last
1286    *  are still present, but their value is unspecified.
1287   */
1288   template<typename _ForwardIterator>
1289     _ForwardIterator
1290     unique(_ForwardIterator __first, _ForwardIterator __last)
1291     {
1292       // concept requirements
1293       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1294       __glibcxx_function_requires(_EqualityComparableConcept<
1295                      typename iterator_traits<_ForwardIterator>::value_type>)
1296       __glibcxx_requires_valid_range(__first, __last);
1297
1298       // Skip the beginning, if already unique.
1299       __first = std::adjacent_find(__first, __last);
1300       if (__first == __last)
1301         return __last;
1302
1303       // Do the real copy work.
1304       _ForwardIterator __dest = __first;
1305       ++__first;
1306       while (++__first != __last)
1307         if (!(*__dest == *__first))
1308           *++__dest = *__first;
1309       return ++__dest;
1310     }
1311
1312   /**
1313    *  @brief Remove consecutive values from a sequence using a predicate.
1314    *  @param  first        A forward iterator.
1315    *  @param  last         A forward iterator.
1316    *  @param  binary_pred  A binary predicate.
1317    *  @return  An iterator designating the end of the resulting sequence.
1318    *
1319    *  Removes all but the first element from each group of consecutive
1320    *  values for which @p binary_pred returns true.
1321    *  unique() is stable, so the relative order of elements that are
1322    *  not removed is unchanged.
1323    *  Elements between the end of the resulting sequence and @p last
1324    *  are still present, but their value is unspecified.
1325   */
1326   template<typename _ForwardIterator, typename _BinaryPredicate>
1327     _ForwardIterator
1328     unique(_ForwardIterator __first, _ForwardIterator __last,
1329            _BinaryPredicate __binary_pred)
1330     {
1331       // concept requirements
1332       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1333       __glibcxx_function_requires(_BinaryPredicateConcept<_BinaryPredicate,
1334                 typename iterator_traits<_ForwardIterator>::value_type,
1335                 typename iterator_traits<_ForwardIterator>::value_type>)
1336       __glibcxx_requires_valid_range(__first, __last);
1337
1338       // Skip the beginning, if already unique.
1339       __first = std::adjacent_find(__first, __last, __binary_pred);
1340       if (__first == __last)
1341         return __last;
1342
1343       // Do the real copy work.
1344       _ForwardIterator __dest = __first;
1345       ++__first;
1346       while (++__first != __last)
1347         if (!__binary_pred(*__dest, *__first))
1348           *++__dest = *__first;
1349       return ++__dest;
1350     }
1351
1352   /**
1353    *  @if maint
1354    *  This is an uglified reverse(_BidirectionalIterator, _BidirectionalIterator)
1355    *  overloaded for bidirectional iterators.
1356    *  @endif
1357   */
1358   template<typename _BidirectionalIterator>
1359     void
1360     __reverse(_BidirectionalIterator __first, _BidirectionalIterator __last,
1361                           bidirectional_iterator_tag)
1362     {
1363       while (true)
1364         if (__first == __last || __first == --__last)
1365           return;
1366         else
1367           std::iter_swap(__first++, __last);
1368     }
1369
1370   /**
1371    *  @if maint
1372    *  This is an uglified reverse(_BidirectionalIterator, _BidirectionalIterator)
1373    *  overloaded for bidirectional iterators.
1374    *  @endif
1375   */
1376   template<typename _RandomAccessIterator>
1377     void
1378     __reverse(_RandomAccessIterator __first, _RandomAccessIterator __last,
1379                           random_access_iterator_tag)
1380     {
1381       while (__first < __last)
1382         std::iter_swap(__first++, --__last);
1383     }
1384
1385   /**
1386    *  @brief Reverse a sequence.
1387    *  @param  first  A bidirectional iterator.
1388    *  @param  last   A bidirectional iterator.
1389    *  @return   reverse() returns no value.
1390    *
1391    *  Reverses the order of the elements in the range @p [first,last),
1392    *  so that the first element becomes the last etc.
1393    *  For every @c i such that @p 0<=i<=(last-first)/2), @p reverse()
1394    *  swaps @p *(first+i) and @p *(last-(i+1))
1395   */
1396   template<typename _BidirectionalIterator>
1397     inline void
1398     reverse(_BidirectionalIterator __first, _BidirectionalIterator __last)
1399     {
1400       // concept requirements
1401       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
1402                     _BidirectionalIterator>)
1403       __glibcxx_requires_valid_range(__first, __last);
1404       std::__reverse(__first, __last, std::__iterator_category(__first));
1405     }
1406
1407   /**
1408    *  @brief Copy a sequence, reversing its elements.
1409    *  @param  first   A bidirectional iterator.
1410    *  @param  last    A bidirectional iterator.
1411    *  @param  result  An output iterator.
1412    *  @return  An iterator designating the end of the resulting sequence.
1413    *
1414    *  Copies the elements in the range @p [first,last) to the range
1415    *  @p [result,result+(last-first)) such that the order of the
1416    *  elements is reversed.
1417    *  For every @c i such that @p 0<=i<=(last-first), @p reverse_copy()
1418    *  performs the assignment @p *(result+(last-first)-i) = *(first+i).
1419    *  The ranges @p [first,last) and @p [result,result+(last-first))
1420    *  must not overlap.
1421   */
1422   template<typename _BidirectionalIterator, typename _OutputIterator>
1423     _OutputIterator
1424     reverse_copy(_BidirectionalIterator __first, _BidirectionalIterator __last,
1425                              _OutputIterator __result)
1426     {
1427       // concept requirements
1428       __glibcxx_function_requires(_BidirectionalIteratorConcept<_BidirectionalIterator>)
1429       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1430                 typename iterator_traits<_BidirectionalIterator>::value_type>)
1431       __glibcxx_requires_valid_range(__first, __last);
1432
1433       while (__first != __last) {
1434         --__last;
1435         *__result = *__last;
1436         ++__result;
1437       }
1438       return __result;
1439     }
1440
1441
1442   /**
1443    *  @if maint
1444    *  This is a helper function for the rotate algorithm specialized on RAIs.
1445    *  It returns the greatest common divisor of two integer values.
1446    *  @endif
1447   */
1448   template<typename _EuclideanRingElement>
1449     _EuclideanRingElement
1450     __gcd(_EuclideanRingElement __m, _EuclideanRingElement __n)
1451     {
1452       while (__n != 0) {
1453         _EuclideanRingElement __t = __m % __n;
1454         __m = __n;
1455         __n = __t;
1456       }
1457       return __m;
1458     }
1459
1460   /**
1461    *  @if maint
1462    *  This is a helper function for the rotate algorithm.
1463    *  @endif
1464   */
1465   template<typename _ForwardIterator>
1466     void
1467     __rotate(_ForwardIterator __first,
1468              _ForwardIterator __middle,
1469              _ForwardIterator __last,
1470               forward_iterator_tag)
1471     {
1472       if ((__first == __middle) || (__last  == __middle))
1473         return;
1474
1475       _ForwardIterator __first2 = __middle;
1476       do {
1477         swap(*__first++, *__first2++);
1478         if (__first == __middle)
1479           __middle = __first2;
1480       } while (__first2 != __last);
1481
1482       __first2 = __middle;
1483
1484       while (__first2 != __last) {
1485         swap(*__first++, *__first2++);
1486         if (__first == __middle)
1487           __middle = __first2;
1488         else if (__first2 == __last)
1489           __first2 = __middle;
1490       }
1491     }
1492
1493   /**
1494    *  @if maint
1495    *  This is a helper function for the rotate algorithm.
1496    *  @endif
1497   */
1498   template<typename _BidirectionalIterator>
1499     void
1500     __rotate(_BidirectionalIterator __first,
1501              _BidirectionalIterator __middle,
1502              _BidirectionalIterator __last,
1503               bidirectional_iterator_tag)
1504     {
1505       // concept requirements
1506       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<
1507             _BidirectionalIterator>)
1508
1509       if ((__first == __middle) || (__last  == __middle))
1510         return;
1511
1512       std::__reverse(__first,  __middle, bidirectional_iterator_tag());
1513       std::__reverse(__middle, __last,   bidirectional_iterator_tag());
1514
1515       while (__first != __middle && __middle != __last)
1516         swap(*__first++, *--__last);
1517
1518       if (__first == __middle) {
1519         std::__reverse(__middle, __last,   bidirectional_iterator_tag());
1520       }
1521       else {
1522         std::__reverse(__first,  __middle, bidirectional_iterator_tag());
1523       }
1524     }
1525
1526   /**
1527    *  @if maint
1528    *  This is a helper function for the rotate algorithm.
1529    *  @endif
1530   */
1531   template<typename _RandomAccessIterator>
1532     void
1533     __rotate(_RandomAccessIterator __first,
1534              _RandomAccessIterator __middle,
1535              _RandomAccessIterator __last,
1536              random_access_iterator_tag)
1537     {
1538       // concept requirements
1539       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1540             _RandomAccessIterator>)
1541
1542       if ((__first == __middle) || (__last  == __middle))
1543         return;
1544
1545       typedef typename iterator_traits<_RandomAccessIterator>::difference_type _Distance;
1546       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
1547
1548       _Distance __n = __last   - __first;
1549       _Distance __k = __middle - __first;
1550       _Distance __l = __n - __k;
1551
1552       if (__k == __l) {
1553         std::swap_ranges(__first, __middle, __middle);
1554         return;
1555       }
1556
1557       _Distance __d = __gcd(__n, __k);
1558
1559       for (_Distance __i = 0; __i < __d; __i++) {
1560         _ValueType __tmp = *__first;
1561         _RandomAccessIterator __p = __first;
1562
1563         if (__k < __l) {
1564           for (_Distance __j = 0; __j < __l/__d; __j++) {
1565             if (__p > __first + __l) {
1566               *__p = *(__p - __l);
1567               __p -= __l;
1568             }
1569
1570             *__p = *(__p + __k);
1571             __p += __k;
1572           }
1573         }
1574
1575         else {
1576           for (_Distance __j = 0; __j < __k/__d - 1; __j ++) {
1577             if (__p < __last - __k) {
1578               *__p = *(__p + __k);
1579               __p += __k;
1580             }
1581
1582             *__p = * (__p - __l);
1583             __p -= __l;
1584           }
1585         }
1586
1587         *__p = __tmp;
1588         ++__first;
1589       }
1590     }
1591
1592   /**
1593    *  @brief Rotate the elements of a sequence.
1594    *  @param  first   A forward iterator.
1595    *  @param  middle  A forward iterator.
1596    *  @param  last    A forward iterator.
1597    *  @return  Nothing.
1598    *
1599    *  Rotates the elements of the range @p [first,last) by @p (middle-first)
1600    *  positions so that the element at @p middle is moved to @p first, the
1601    *  element at @p middle+1 is moved to @first+1 and so on for each element
1602    *  in the range @p [first,last).
1603    *
1604    *  This effectively swaps the ranges @p [first,middle) and
1605    *  @p [middle,last).
1606    *
1607    *  Performs @p *(first+(n+(last-middle))%(last-first))=*(first+n) for
1608    *  each @p n in the range @p [0,last-first).
1609   */
1610   template<typename _ForwardIterator>
1611     inline void
1612     rotate(_ForwardIterator __first, _ForwardIterator __middle, _ForwardIterator __last)
1613     {
1614       // concept requirements
1615       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1616       __glibcxx_requires_valid_range(__first, __middle);
1617       __glibcxx_requires_valid_range(__middle, __last);
1618
1619       typedef typename iterator_traits<_ForwardIterator>::iterator_category _IterType;
1620       std::__rotate(__first, __middle, __last, _IterType());
1621     }
1622
1623   /**
1624    *  @brief Copy a sequence, rotating its elements.
1625    *  @param  first   A forward iterator.
1626    *  @param  middle  A forward iterator.
1627    *  @param  last    A forward iterator.
1628    *  @param  result  An output iterator.
1629    *  @return   An iterator designating the end of the resulting sequence.
1630    *
1631    *  Copies the elements of the range @p [first,last) to the range
1632    *  beginning at @result, rotating the copied elements by @p (middle-first)
1633    *  positions so that the element at @p middle is moved to @p result, the
1634    *  element at @p middle+1 is moved to @result+1 and so on for each element
1635    *  in the range @p [first,last).
1636    *
1637    *  Performs @p *(result+(n+(last-middle))%(last-first))=*(first+n) for
1638    *  each @p n in the range @p [0,last-first).
1639   */
1640   template<typename _ForwardIterator, typename _OutputIterator>
1641     _OutputIterator
1642     rotate_copy(_ForwardIterator __first, _ForwardIterator __middle,
1643                 _ForwardIterator __last, _OutputIterator __result)
1644     {
1645       // concept requirements
1646       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
1647       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
1648                 typename iterator_traits<_ForwardIterator>::value_type>)
1649       __glibcxx_requires_valid_range(__first, __middle);
1650       __glibcxx_requires_valid_range(__middle, __last);
1651
1652       return std::copy(__first, __middle, copy(__middle, __last, __result));
1653     }
1654
1655   /**
1656    *  @brief Randomly shuffle the elements of a sequence.
1657    *  @param  first   A forward iterator.
1658    *  @param  last    A forward iterator.
1659    *  @return  Nothing.
1660    *
1661    *  Reorder the elements in the range @p [first,last) using a random
1662    *  distribution, so that every possible ordering of the sequence is
1663    *  equally likely.
1664   */
1665   template<typename _RandomAccessIterator>
1666     inline void
1667     random_shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last)
1668     {
1669       // concept requirements
1670       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1671             _RandomAccessIterator>)
1672       __glibcxx_requires_valid_range(__first, __last);
1673
1674       if (__first != __last) 
1675         for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
1676           std::iter_swap(__i, __first + (std::rand() % ((__i - __first) + 1)));
1677     }
1678
1679   /**
1680    *  @brief Shuffle the elements of a sequence using a random number
1681    *         generator.
1682    *  @param  first   A forward iterator.
1683    *  @param  last    A forward iterator.
1684    *  @param  rand    The RNG functor or function.
1685    *  @return  Nothing.
1686    *
1687    *  Reorders the elements in the range @p [first,last) using @p rand to
1688    *  provide a random distribution. Calling @p rand(N) for a positive
1689    *  integer @p N should return a randomly chosen integer from the
1690    *  range [0,N).
1691   */
1692   template<typename _RandomAccessIterator, typename _RandomNumberGenerator>
1693     void
1694     random_shuffle(_RandomAccessIterator __first, _RandomAccessIterator __last,
1695                    _RandomNumberGenerator& __rand)
1696     {
1697       // concept requirements
1698       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
1699             _RandomAccessIterator>)
1700       __glibcxx_requires_valid_range(__first, __last);
1701
1702       if (__first == __last) return;
1703       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
1704         std::iter_swap(__i, __first + __rand((__i - __first) + 1));
1705     }
1706
1707
1708   /**
1709    *  @if maint
1710    *  This is a helper function...
1711    *  @endif
1712   */
1713   template<typename _ForwardIterator, typename _Predicate>
1714     _ForwardIterator
1715     __partition(_ForwardIterator __first, _ForwardIterator __last,
1716                 _Predicate   __pred,
1717                 forward_iterator_tag)
1718     {
1719       if (__first == __last) return __first;
1720
1721       while (__pred(*__first))
1722         if (++__first == __last) return __first;
1723
1724       _ForwardIterator __next = __first;
1725
1726       while (++__next != __last)
1727         if (__pred(*__next)) {
1728           swap(*__first, *__next);
1729           ++__first;
1730         }
1731
1732       return __first;
1733     }
1734
1735   /**
1736    *  @if maint
1737    *  This is a helper function...
1738    *  @endif
1739   */
1740   template<typename _BidirectionalIterator, typename _Predicate>
1741     _BidirectionalIterator
1742     __partition(_BidirectionalIterator __first, _BidirectionalIterator __last,
1743                 _Predicate __pred,
1744                 bidirectional_iterator_tag)
1745     {
1746       while (true) {
1747         while (true)
1748           if (__first == __last)
1749             return __first;
1750           else if (__pred(*__first))
1751             ++__first;
1752           else
1753             break;
1754         --__last;
1755         while (true)
1756           if (__first == __last)
1757             return __first;
1758           else if (!__pred(*__last))
1759             --__last;
1760           else
1761             break;
1762         std::iter_swap(__first, __last);
1763         ++__first;
1764       }
1765     }
1766
1767   /**
1768    *  @brief Move elements for which a predicate is true to the beginning
1769    *         of a sequence.
1770    *  @param  first   A forward iterator.
1771    *  @param  last    A forward iterator.
1772    *  @param  pred    A predicate functor.
1773    *  @return  An iterator @p middle such that @p pred(i) is true for each
1774    *  iterator @p i in the range @p [first,middle) and false for each @p i
1775    *  in the range @p [middle,last).
1776    *  
1777    *  @p pred must not modify its operand. @p partition() does not preserve
1778    *  the relative ordering of elements in each group, use
1779    *  @p stable_partition() if this is needed.
1780   */
1781   template<typename _ForwardIterator, typename _Predicate>
1782     inline _ForwardIterator
1783     partition(_ForwardIterator __first, _ForwardIterator __last,
1784               _Predicate   __pred)
1785     {
1786       // concept requirements
1787       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1788       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1789             typename iterator_traits<_ForwardIterator>::value_type>)
1790       __glibcxx_requires_valid_range(__first, __last);
1791
1792       return std::__partition(__first, __last, __pred, std::__iterator_category(__first));
1793     }
1794
1795
1796   /**
1797    *  @if maint
1798    *  This is a helper function...
1799    *  @endif
1800   */
1801   template<typename _ForwardIterator, typename _Predicate, typename _Distance>
1802     _ForwardIterator
1803     __inplace_stable_partition(_ForwardIterator __first, _ForwardIterator __last,
1804                                _Predicate __pred, _Distance __len)
1805     {
1806       if (__len == 1)
1807         return __pred(*__first) ? __last : __first;
1808       _ForwardIterator __middle = __first;
1809       std::advance(__middle, __len / 2);
1810       _ForwardIterator __begin = std::__inplace_stable_partition(__first, __middle,
1811                                                                  __pred,
1812                                                                  __len / 2);
1813       _ForwardIterator __end = std::__inplace_stable_partition(__middle, __last,
1814                                                                __pred,
1815                                                                __len - __len / 2);
1816       std::rotate(__begin, __middle, __end);
1817       std::advance(__begin, std::distance(__middle, __end));
1818       return __begin;
1819     }
1820
1821   /**
1822    *  @if maint
1823    *  This is a helper function...
1824    *  @endif
1825   */
1826   template<typename _ForwardIterator, typename _Pointer, typename _Predicate,
1827            typename _Distance>
1828     _ForwardIterator
1829     __stable_partition_adaptive(_ForwardIterator __first, _ForwardIterator __last,
1830                                 _Predicate __pred, _Distance __len,
1831                                 _Pointer __buffer,
1832                                 _Distance __buffer_size)
1833     {
1834       if (__len <= __buffer_size) {
1835         _ForwardIterator __result1 = __first;
1836         _Pointer __result2 = __buffer;
1837         for ( ; __first != __last ; ++__first)
1838           if (__pred(*__first)) {
1839             *__result1 = *__first;
1840             ++__result1;
1841           }
1842           else {
1843             *__result2 = *__first;
1844             ++__result2;
1845           }
1846         std::copy(__buffer, __result2, __result1);
1847         return __result1;
1848       }
1849       else {
1850         _ForwardIterator __middle = __first;
1851         std::advance(__middle, __len / 2);
1852         _ForwardIterator __begin = std::__stable_partition_adaptive(__first, __middle,
1853                                                                     __pred,
1854                                                                     __len / 2,
1855                                                                     __buffer, __buffer_size);
1856         _ForwardIterator __end = std::__stable_partition_adaptive( __middle, __last,
1857                                                                    __pred,
1858                                                                    __len - __len / 2,
1859                                                                    __buffer, __buffer_size);
1860         std::rotate(__begin, __middle, __end);
1861         std::advance(__begin, std::distance(__middle, __end));
1862         return __begin;
1863       }
1864     }
1865
1866   /**
1867    *  @brief Move elements for which a predicate is true to the beginning
1868    *         of a sequence, preserving relative ordering.
1869    *  @param  first   A forward iterator.
1870    *  @param  last    A forward iterator.
1871    *  @param  pred    A predicate functor.
1872    *  @return  An iterator @p middle such that @p pred(i) is true for each
1873    *  iterator @p i in the range @p [first,middle) and false for each @p i
1874    *  in the range @p [middle,last).
1875    *  
1876    *  Performs the same function as @p partition() with the additional
1877    *  guarantee that the relative ordering of elements in each group is
1878    *  preserved, so any two elements @p x and @p y in the range
1879    *  @p [first,last) such that @p pred(x)==pred(y) will have the same
1880    *  relative ordering after calling @p stable_partition().
1881   */
1882   template<typename _ForwardIterator, typename _Predicate>
1883     _ForwardIterator
1884     stable_partition(_ForwardIterator __first, _ForwardIterator __last,
1885                      _Predicate __pred)
1886     {
1887       // concept requirements
1888       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<_ForwardIterator>)
1889       __glibcxx_function_requires(_UnaryPredicateConcept<_Predicate,
1890             typename iterator_traits<_ForwardIterator>::value_type>)
1891       __glibcxx_requires_valid_range(__first, __last);
1892
1893       if (__first == __last)
1894         return __first;
1895       else
1896       {
1897         typedef typename iterator_traits<_ForwardIterator>::value_type _ValueType;
1898         typedef typename iterator_traits<_ForwardIterator>::difference_type _DistanceType;
1899
1900         _Temporary_buffer<_ForwardIterator, _ValueType> __buf(__first, __last);
1901         if (__buf.size() > 0)
1902           return std::__stable_partition_adaptive(__first, __last, __pred,
1903                                                   _DistanceType(__buf.requested_size()),
1904                                                   __buf.begin(), __buf.size());
1905         else
1906           return std::__inplace_stable_partition(__first, __last, __pred,
1907                                                  _DistanceType(__buf.requested_size()));
1908       }
1909     }
1910
1911   /**
1912    *  @if maint
1913    *  This is a helper function...
1914    *  @endif
1915   */
1916   template<typename _RandomAccessIterator, typename _Tp>
1917     _RandomAccessIterator
1918     __unguarded_partition(_RandomAccessIterator __first, _RandomAccessIterator __last,
1919                           _Tp __pivot)
1920     {
1921       while (true) {
1922         while (*__first < __pivot)
1923           ++__first;
1924         --__last;
1925         while (__pivot < *__last)
1926           --__last;
1927         if (!(__first < __last))
1928           return __first;
1929         std::iter_swap(__first, __last);
1930         ++__first;
1931       }
1932     }
1933
1934   /**
1935    *  @if maint
1936    *  This is a helper function...
1937    *  @endif
1938   */
1939   template<typename _RandomAccessIterator, typename _Tp, typename _Compare>
1940     _RandomAccessIterator
1941     __unguarded_partition(_RandomAccessIterator __first, _RandomAccessIterator __last,
1942                           _Tp __pivot, _Compare __comp)
1943     {
1944       while (true) {
1945         while (__comp(*__first, __pivot))
1946           ++__first;
1947         --__last;
1948         while (__comp(__pivot, *__last))
1949           --__last;
1950         if (!(__first < __last))
1951           return __first;
1952         std::iter_swap(__first, __last);
1953         ++__first;
1954       }
1955     }
1956
1957
1958   /**
1959    *  @if maint
1960    *  @doctodo
1961    *  This controls some aspect of the sort routines.
1962    *  @endif
1963   */
1964   enum { _S_threshold = 16 };
1965
1966   /**
1967    *  @if maint
1968    *  This is a helper function for the sort routine.
1969    *  @endif
1970   */
1971   template<typename _RandomAccessIterator, typename _Tp>
1972     void
1973     __unguarded_linear_insert(_RandomAccessIterator __last, _Tp __val)
1974     {
1975       _RandomAccessIterator __next = __last;
1976       --__next;
1977       while (__val < *__next) {
1978         *__last = *__next;
1979         __last = __next;
1980         --__next;
1981       }
1982       *__last = __val;
1983     }
1984
1985   /**
1986    *  @if maint
1987    *  This is a helper function for the sort routine.
1988    *  @endif
1989   */
1990   template<typename _RandomAccessIterator, typename _Tp, typename _Compare>
1991     void
1992     __unguarded_linear_insert(_RandomAccessIterator __last, _Tp __val, _Compare __comp)
1993     {
1994       _RandomAccessIterator __next = __last;
1995       --__next;
1996       while (__comp(__val, *__next)) {
1997         *__last = *__next;
1998         __last = __next;
1999         --__next;
2000       }
2001       *__last = __val;
2002     }
2003
2004   /**
2005    *  @if maint
2006    *  This is a helper function for the sort routine.
2007    *  @endif
2008   */
2009   template<typename _RandomAccessIterator>
2010     void
2011     __insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2012     {
2013       if (__first == __last) return;
2014
2015       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
2016       {
2017         typename iterator_traits<_RandomAccessIterator>::value_type __val = *__i;
2018         if (__val < *__first) {
2019           std::copy_backward(__first, __i, __i + 1);
2020           *__first = __val;
2021         }
2022         else
2023           std::__unguarded_linear_insert(__i, __val);
2024       }
2025     }
2026
2027   /**
2028    *  @if maint
2029    *  This is a helper function for the sort routine.
2030    *  @endif
2031   */
2032   template<typename _RandomAccessIterator, typename _Compare>
2033     void
2034     __insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2035                      _Compare __comp)
2036     {
2037       if (__first == __last) return;
2038
2039       for (_RandomAccessIterator __i = __first + 1; __i != __last; ++__i)
2040       {
2041         typename iterator_traits<_RandomAccessIterator>::value_type __val = *__i;
2042         if (__comp(__val, *__first)) {
2043           std::copy_backward(__first, __i, __i + 1);
2044           *__first = __val;
2045         }
2046         else
2047           std::__unguarded_linear_insert(__i, __val, __comp);
2048       }
2049     }
2050
2051   /**
2052    *  @if maint
2053    *  This is a helper function for the sort routine.
2054    *  @endif
2055   */
2056   template<typename _RandomAccessIterator>
2057     inline void
2058     __unguarded_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2059     {
2060       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2061
2062       for (_RandomAccessIterator __i = __first; __i != __last; ++__i)
2063         std::__unguarded_linear_insert(__i, _ValueType(*__i));
2064     }
2065
2066   /**
2067    *  @if maint
2068    *  This is a helper function for the sort routine.
2069    *  @endif
2070   */
2071   template<typename _RandomAccessIterator, typename _Compare>
2072     inline void
2073     __unguarded_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2074                                _Compare __comp)
2075     {
2076       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2077
2078       for (_RandomAccessIterator __i = __first; __i != __last; ++__i)
2079         std::__unguarded_linear_insert(__i, _ValueType(*__i), __comp);
2080     }
2081
2082   /**
2083    *  @if maint
2084    *  This is a helper function for the sort routine.
2085    *  @endif
2086   */
2087   template<typename _RandomAccessIterator>
2088     void
2089     __final_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2090     {
2091       if (__last - __first > _S_threshold) {
2092         std::__insertion_sort(__first, __first + _S_threshold);
2093         std::__unguarded_insertion_sort(__first + _S_threshold, __last);
2094       }
2095       else
2096         std::__insertion_sort(__first, __last);
2097     }
2098
2099   /**
2100    *  @if maint
2101    *  This is a helper function for the sort routine.
2102    *  @endif
2103   */
2104   template<typename _RandomAccessIterator, typename _Compare>
2105     void
2106     __final_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2107                            _Compare __comp)
2108     {
2109       if (__last - __first > _S_threshold) {
2110         std::__insertion_sort(__first, __first + _S_threshold, __comp);
2111         std::__unguarded_insertion_sort(__first + _S_threshold, __last, __comp);
2112       }
2113       else
2114         std::__insertion_sort(__first, __last, __comp);
2115     }
2116
2117   /**
2118    *  @if maint
2119    *  This is a helper function for the sort routine.
2120    *  @endif
2121   */
2122   template<typename _Size>
2123     inline _Size
2124     __lg(_Size __n)
2125     {
2126       _Size __k;
2127       for (__k = 0; __n != 1; __n >>= 1) ++__k;
2128       return __k;
2129     }
2130
2131   /**
2132    *  @brief Sort the smallest elements of a sequence.
2133    *  @param  first   An iterator.
2134    *  @param  middle  Another iterator.
2135    *  @param  last    Another iterator.
2136    *  @return  Nothing.
2137    *
2138    *  Sorts the smallest @p (middle-first) elements in the range
2139    *  @p [first,last) and moves them to the range @p [first,middle). The
2140    *  order of the remaining elements in the range @p [middle,last) is
2141    *  undefined.
2142    *  After the sort if @p i and @j are iterators in the range
2143    *  @p [first,middle) such that @i precedes @j and @k is an iterator in
2144    *  the range @p [middle,last) then @p *j<*i and @p *k<*i are both false.
2145   */
2146   template<typename _RandomAccessIterator>
2147     void
2148     partial_sort(_RandomAccessIterator __first,
2149                  _RandomAccessIterator __middle,
2150                  _RandomAccessIterator __last)
2151     {
2152       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2153
2154       // concept requirements
2155       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2156             _RandomAccessIterator>)
2157       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
2158       __glibcxx_requires_valid_range(__first, __middle);
2159       __glibcxx_requires_valid_range(__middle, __last);
2160
2161       std::make_heap(__first, __middle);
2162       for (_RandomAccessIterator __i = __middle; __i < __last; ++__i)
2163         if (*__i < *__first)
2164           std::__pop_heap(__first, __middle, __i, _ValueType(*__i));
2165       std::sort_heap(__first, __middle);
2166     }
2167
2168   /**
2169    *  @brief Sort the smallest elements of a sequence using a predicate
2170    *         for comparison.
2171    *  @param  first   An iterator.
2172    *  @param  middle  Another iterator.
2173    *  @param  last    Another iterator.
2174    *  @param  comp    A comparison functor.
2175    *  @return  Nothing.
2176    *
2177    *  Sorts the smallest @p (middle-first) elements in the range
2178    *  @p [first,last) and moves them to the range @p [first,middle). The
2179    *  order of the remaining elements in the range @p [middle,last) is
2180    *  undefined.
2181    *  After the sort if @p i and @j are iterators in the range
2182    *  @p [first,middle) such that @i precedes @j and @k is an iterator in
2183    *  the range @p [middle,last) then @p *comp(j,*i) and @p comp(*k,*i)
2184    *  are both false.
2185   */
2186   template<typename _RandomAccessIterator, typename _Compare>
2187     void
2188     partial_sort(_RandomAccessIterator __first,
2189                  _RandomAccessIterator __middle,
2190                  _RandomAccessIterator __last,
2191                  _Compare __comp)
2192     {
2193       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2194
2195       // concept requirements
2196       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2197             _RandomAccessIterator>)
2198       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2199                                                           _ValueType, _ValueType>)
2200       __glibcxx_requires_valid_range(__first, __middle);
2201       __glibcxx_requires_valid_range(__middle, __last);
2202
2203       std::make_heap(__first, __middle, __comp);
2204       for (_RandomAccessIterator __i = __middle; __i < __last; ++__i)
2205         if (__comp(*__i, *__first))
2206           std::__pop_heap(__first, __middle, __i, _ValueType(*__i), __comp);
2207       std::sort_heap(__first, __middle, __comp);
2208     }
2209
2210   /**
2211    *  @brief Copy the smallest elements of a sequence.
2212    *  @param  first   An iterator.
2213    *  @param  last    Another iterator.
2214    *  @param  result_first   A random-access iterator.
2215    *  @param  result_last    Another random-access iterator.
2216    *  @return   An iterator indicating the end of the resulting sequence.
2217    *
2218    *  Copies and sorts the smallest N values from the range @p [first,last)
2219    *  to the range beginning at @p result_first, where the number of
2220    *  elements to be copied, @p N, is the smaller of @p (last-first) and
2221    *  @p (result_last-result_first).
2222    *  After the sort if @p i and @j are iterators in the range
2223    *  @p [result_first,result_first+N) such that @i precedes @j then
2224    *  @p *j<*i is false.
2225    *  The value returned is @p result_first+N.
2226   */
2227   template<typename _InputIterator, typename _RandomAccessIterator>
2228     _RandomAccessIterator
2229     partial_sort_copy(_InputIterator __first, _InputIterator __last,
2230                       _RandomAccessIterator __result_first,
2231                       _RandomAccessIterator __result_last)
2232     {
2233       typedef typename iterator_traits<_InputIterator>::value_type _InputValueType;
2234       typedef typename iterator_traits<_RandomAccessIterator>::value_type _OutputValueType;
2235       typedef typename iterator_traits<_RandomAccessIterator>::difference_type _DistanceType;
2236
2237       // concept requirements
2238       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
2239       __glibcxx_function_requires(_ConvertibleConcept<_InputValueType, _OutputValueType>)
2240       __glibcxx_function_requires(_LessThanComparableConcept<_OutputValueType>)
2241       __glibcxx_function_requires(_LessThanComparableConcept<_InputValueType>)
2242       __glibcxx_requires_valid_range(__first, __last);
2243       __glibcxx_requires_valid_range(__result_first, __result_last);
2244
2245       if (__result_first == __result_last) return __result_last;
2246       _RandomAccessIterator __result_real_last = __result_first;
2247       while(__first != __last && __result_real_last != __result_last) {
2248         *__result_real_last = *__first;
2249         ++__result_real_last;
2250         ++__first;
2251       }
2252       std::make_heap(__result_first, __result_real_last);
2253       while (__first != __last) {
2254         if (*__first < *__result_first)
2255           std::__adjust_heap(__result_first, _DistanceType(0),
2256                              _DistanceType(__result_real_last - __result_first),
2257                              _InputValueType(*__first));
2258         ++__first;
2259       }
2260       std::sort_heap(__result_first, __result_real_last);
2261       return __result_real_last;
2262     }
2263
2264   /**
2265    *  @brief Copy the smallest elements of a sequence using a predicate for
2266    *         comparison.
2267    *  @param  first   An input iterator.
2268    *  @param  last    Another input iterator.
2269    *  @param  result_first   A random-access iterator.
2270    *  @param  result_last    Another random-access iterator.
2271    *  @param  comp    A comparison functor.
2272    *  @return   An iterator indicating the end of the resulting sequence.
2273    *
2274    *  Copies and sorts the smallest N values from the range @p [first,last)
2275    *  to the range beginning at @p result_first, where the number of
2276    *  elements to be copied, @p N, is the smaller of @p (last-first) and
2277    *  @p (result_last-result_first).
2278    *  After the sort if @p i and @j are iterators in the range
2279    *  @p [result_first,result_first+N) such that @i precedes @j then
2280    *  @p comp(*j,*i) is false.
2281    *  The value returned is @p result_first+N.
2282   */
2283   template<typename _InputIterator, typename _RandomAccessIterator, typename _Compare>
2284     _RandomAccessIterator
2285     partial_sort_copy(_InputIterator __first, _InputIterator __last,
2286                       _RandomAccessIterator __result_first,
2287                       _RandomAccessIterator __result_last,
2288                       _Compare __comp)
2289     {
2290       typedef typename iterator_traits<_InputIterator>::value_type _InputValueType;
2291       typedef typename iterator_traits<_RandomAccessIterator>::value_type _OutputValueType;
2292       typedef typename iterator_traits<_RandomAccessIterator>::difference_type _DistanceType;
2293
2294       // concept requirements
2295       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator>)
2296       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<_RandomAccessIterator>)
2297       __glibcxx_function_requires(_ConvertibleConcept<_InputValueType, _OutputValueType>)
2298       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2299                                   _OutputValueType, _OutputValueType>)
2300       __glibcxx_requires_valid_range(__first, __last);
2301       __glibcxx_requires_valid_range(__result_first, __result_last);
2302
2303       if (__result_first == __result_last) return __result_last;
2304       _RandomAccessIterator __result_real_last = __result_first;
2305       while(__first != __last && __result_real_last != __result_last) {
2306         *__result_real_last = *__first;
2307         ++__result_real_last;
2308         ++__first;
2309       }
2310       std::make_heap(__result_first, __result_real_last, __comp);
2311       while (__first != __last) {
2312         if (__comp(*__first, *__result_first))
2313           std::__adjust_heap(__result_first, _DistanceType(0),
2314                              _DistanceType(__result_real_last - __result_first),
2315                              _InputValueType(*__first),
2316                              __comp);
2317         ++__first;
2318       }
2319       std::sort_heap(__result_first, __result_real_last, __comp);
2320       return __result_real_last;
2321     }
2322
2323   /**
2324    *  @if maint
2325    *  This is a helper function for the sort routine.
2326    *  @endif
2327   */
2328   template<typename _RandomAccessIterator, typename _Size>
2329     void
2330     __introsort_loop(_RandomAccessIterator __first, _RandomAccessIterator __last,
2331                      _Size __depth_limit)
2332     {
2333       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2334
2335       while (__last - __first > _S_threshold) {
2336         if (__depth_limit == 0) {
2337           std::partial_sort(__first, __last, __last);
2338           return;
2339         }
2340         --__depth_limit;
2341         _RandomAccessIterator __cut =
2342           std::__unguarded_partition(__first, __last,
2343                                      _ValueType(std::__median(*__first,
2344                                                               *(__first + (__last - __first)/2),
2345                                                               *(__last - 1))));
2346         std::__introsort_loop(__cut, __last, __depth_limit);
2347         __last = __cut;
2348       }
2349     }
2350
2351   /**
2352    *  @if maint
2353    *  This is a helper function for the sort routine.
2354    *  @endif
2355   */
2356   template<typename _RandomAccessIterator, typename _Size, typename _Compare>
2357     void
2358     __introsort_loop(_RandomAccessIterator __first, _RandomAccessIterator __last,
2359                      _Size __depth_limit, _Compare __comp)
2360     {
2361       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2362
2363       while (__last - __first > _S_threshold) {
2364         if (__depth_limit == 0) {
2365           std::partial_sort(__first, __last, __last, __comp);
2366           return;
2367         }
2368         --__depth_limit;
2369         _RandomAccessIterator __cut =
2370           std::__unguarded_partition(__first, __last,
2371                                      _ValueType(std::__median(*__first,
2372                                                               *(__first + (__last - __first)/2),
2373                                                               *(__last - 1), __comp)), __comp);
2374         std::__introsort_loop(__cut, __last, __depth_limit, __comp);
2375         __last = __cut;
2376       }
2377     }
2378
2379   /**
2380    *  @brief Sort the elements of a sequence.
2381    *  @param  first   An iterator.
2382    *  @param  last    Another iterator.
2383    *  @return  Nothing.
2384    *
2385    *  Sorts the elements in the range @p [first,last) in ascending order,
2386    *  such that @p *(i+1)<*i is false for each iterator @p i in the range
2387    *  @p [first,last-1).
2388    *
2389    *  The relative ordering of equivalent elements is not preserved, use
2390    *  @p stable_sort() if this is needed.
2391   */
2392   template<typename _RandomAccessIterator>
2393     inline void
2394     sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2395     {
2396       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2397
2398       // concept requirements
2399       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2400             _RandomAccessIterator>)
2401       __glibcxx_function_requires(_LessThanComparableConcept<_ValueType>)
2402       __glibcxx_requires_valid_range(__first, __last);
2403
2404       if (__first != __last) {
2405         std::__introsort_loop(__first, __last, __lg(__last - __first) * 2);
2406         std::__final_insertion_sort(__first, __last);
2407       }
2408     }
2409
2410   /**
2411    *  @brief Sort the elements of a sequence using a predicate for comparison.
2412    *  @param  first   An iterator.
2413    *  @param  last    Another iterator.
2414    *  @param  comp    A comparison functor.
2415    *  @return  Nothing.
2416    *
2417    *  Sorts the elements in the range @p [first,last) in ascending order,
2418    *  such that @p comp(*(i+1),*i) is false for every iterator @p i in the
2419    *  range @p [first,last-1).
2420    *
2421    *  The relative ordering of equivalent elements is not preserved, use
2422    *  @p stable_sort() if this is needed.
2423   */
2424   template<typename _RandomAccessIterator, typename _Compare>
2425     inline void
2426     sort(_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
2427     {
2428       typedef typename iterator_traits<_RandomAccessIterator>::value_type _ValueType;
2429
2430       // concept requirements
2431       __glibcxx_function_requires(_Mutable_RandomAccessIteratorConcept<
2432             _RandomAccessIterator>)
2433       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare, _ValueType, _ValueType>)
2434       __glibcxx_requires_valid_range(__first, __last);
2435
2436       if (__first != __last) {
2437         std::__introsort_loop(__first, __last, __lg(__last - __first) * 2, __comp);
2438         std::__final_insertion_sort(__first, __last, __comp);
2439       }
2440     }
2441
2442   /**
2443    *  @brief Finds the first position in which @a val could be inserted
2444    *         without changing the ordering.
2445    *  @param  first   An iterator.
2446    *  @param  last    Another iterator.
2447    *  @param  val     The search term.
2448    *  @return  An iterator pointing to the first element "not less than" @a val,
2449    *           or end() if every element is less than @a val.
2450    *  @ingroup binarysearch
2451   */
2452   template<typename _ForwardIterator, typename _Tp>
2453     _ForwardIterator
2454     lower_bound(_ForwardIterator __first, _ForwardIterator __last, const _Tp& __val)
2455     {
2456       typedef typename iterator_traits<_ForwardIterator>::value_type _ValueType;
2457       typedef typename iterator_traits<_ForwardIterator>::difference_type _DistanceType;
2458
2459       // concept requirements
2460       // Note that these are slightly stricter than those of the 4-argument
2461       // version, defined next.  The difference is in the strictness of the
2462       // comparison operations... so for looser checking, define your own
2463       // comparison function, as was intended.
2464       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2465       __glibcxx_function_requires(_SameTypeConcept<_Tp, _ValueType>)
2466       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
2467       __glibcxx_requires_partitioned(__first, __last, __val);
2468
2469       _DistanceType __len = std::distance(__first, __last);
2470       _DistanceType __half;
2471       _ForwardIterator __middle;
2472
2473       while (__len > 0) {
2474         __half = __len >> 1;
2475         __middle = __first;
2476         std::advance(__middle, __half);
2477         if (*__middle < __val) {
2478           __first = __middle;
2479           ++__first;
2480           __len = __len - __half - 1;
2481         }
2482         else
2483           __len = __half;
2484       }
2485       return __first;
2486     }
2487
2488   /**
2489    *  @brief Finds the first position in which @a val could be inserted
2490    *         without changing the ordering.
2491    *  @param  first   An iterator.
2492    *  @param  last    Another iterator.
2493    *  @param  val     The search term.
2494    *  @param  comp    A functor to use for comparisons.
2495    *  @return  An iterator pointing to the first element "not less than" @a val,
2496    *           or end() if every element is less than @a val.
2497    *  @ingroup binarysearch
2498    *
2499    *  The comparison function should have the same effects on ordering as
2500    *  the function used for the initial sort.
2501   */
2502   template<typename _ForwardIterator, typename _Tp, typename _Compare>
2503     _ForwardIterator
2504     lower_bound(_ForwardIterator __first, _ForwardIterator __last,
2505                 const _Tp& __val, _Compare __comp)
2506     {
2507       typedef typename iterator_traits<_ForwardIterator>::value_type _ValueType;
2508       typedef typename iterator_traits<_ForwardIterator>::difference_type _DistanceType;
2509
2510       // concept requirements
2511       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2512       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare, _ValueType, _Tp>)
2513       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
2514
2515       _DistanceType __len = std::distance(__first, __last);
2516       _DistanceType __half;
2517       _ForwardIterator __middle;
2518
2519       while (__len > 0) {
2520         __half = __len >> 1;
2521         __middle = __first;
2522         std::advance(__middle, __half);
2523         if (__comp(*__middle, __val)) {
2524           __first = __middle;
2525           ++__first;
2526           __len = __len - __half - 1;
2527         }
2528         else
2529           __len = __half;
2530       }
2531       return __first;
2532     }
2533
2534   /**
2535    *  @brief Finds the last position in which @a val could be inserted
2536    *         without changing the ordering.
2537    *  @param  first   An iterator.
2538    *  @param  last    Another iterator.
2539    *  @param  val     The search term.
2540    *  @return  An iterator pointing to the first element greater than @a val,
2541    *           or end() if no elements are greater than @a val.
2542    *  @ingroup binarysearch
2543   */
2544   template<typename _ForwardIterator, typename _Tp>
2545     _ForwardIterator
2546     upper_bound(_ForwardIterator __first, _ForwardIterator __last, const _Tp& __val)
2547     {
2548       typedef typename iterator_traits<_ForwardIterator>::value_type _ValueType;
2549       typedef typename iterator_traits<_ForwardIterator>::difference_type _DistanceType;
2550
2551       // concept requirements
2552       // See comments on lower_bound.
2553       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2554       __glibcxx_function_requires(_SameTypeConcept<_Tp, _ValueType>)
2555       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
2556       __glibcxx_requires_partitioned(__first, __last, __val);
2557
2558       _DistanceType __len = std::distance(__first, __last);
2559       _DistanceType __half;
2560       _ForwardIterator __middle;
2561
2562       while (__len > 0) {
2563         __half = __len >> 1;
2564         __middle = __first;
2565         std::advance(__middle, __half);
2566         if (__val < *__middle)
2567           __len = __half;
2568         else {
2569           __first = __middle;
2570           ++__first;
2571           __len = __len - __half - 1;
2572         }
2573       }
2574       return __first;
2575     }
2576
2577   /**
2578    *  @brief Finds the last position in which @a val could be inserted
2579    *         without changing the ordering.
2580    *  @param  first   An iterator.
2581    *  @param  last    Another iterator.
2582    *  @param  val     The search term.
2583    *  @param  comp    A functor to use for comparisons.
2584    *  @return  An iterator pointing to the first element greater than @a val,
2585    *           or end() if no elements are greater than @a val.
2586    *  @ingroup binarysearch
2587    *
2588    *  The comparison function should have the same effects on ordering as
2589    *  the function used for the initial sort.
2590   */
2591   template<typename _ForwardIterator, typename _Tp, typename _Compare>
2592     _ForwardIterator
2593     upper_bound(_ForwardIterator __first, _ForwardIterator __last,
2594                 const _Tp& __val, _Compare __comp)
2595     {
2596       typedef typename iterator_traits<_ForwardIterator>::value_type _ValueType;
2597       typedef typename iterator_traits<_ForwardIterator>::difference_type _DistanceType;
2598
2599       // concept requirements
2600       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
2601       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare, _Tp, _ValueType>)
2602       __glibcxx_requires_partitioned_pred(__first, __last, __val, __comp);
2603
2604       _DistanceType __len = std::distance(__first, __last);
2605       _DistanceType __half;
2606       _ForwardIterator __middle;
2607
2608       while (__len > 0) {
2609         __half = __len >> 1;
2610         __middle = __first;
2611         std::advance(__middle, __half);
2612         if (__comp(__val, *__middle))
2613           __len = __half;
2614         else {
2615           __first = __middle;
2616           ++__first;
2617           __len = __len - __half - 1;
2618         }
2619       }
2620       return __first;
2621     }
2622
2623   /**
2624    *  @if maint
2625    *  This is a helper function for the merge routines.
2626    *  @endif
2627   */
2628   template<typename _BidirectionalIterator, typename _Distance>
2629     void
2630     __merge_without_buffer(_BidirectionalIterator __first,
2631                            _BidirectionalIterator __middle,
2632                            _BidirectionalIterator __last,
2633                            _Distance __len1, _Distance __len2)
2634     {
2635       if (__len1 == 0 || __len2 == 0)
2636         return;
2637       if (__len1 + __len2 == 2) {
2638         if (*__middle < *__first)
2639           std::iter_swap(__first, __middle);
2640         return;
2641       }
2642       _BidirectionalIterator __first_cut = __first;
2643       _BidirectionalIterator __second_cut = __middle;
2644       _Distance __len11 = 0;
2645       _Distance __len22 = 0;
2646       if (__len1 > __len2) {
2647         __len11 = __len1 / 2;
2648         std::advance(__first_cut, __len11);
2649         __second_cut = std::lower_bound(__middle, __last, *__first_cut);
2650         __len22 = std::distance(__middle, __second_cut);
2651       }
2652       else {
2653         __len22 = __len2 / 2;
2654         std::advance(__second_cut, __len22);
2655         __first_cut = std::upper_bound(__first, __middle, *__second_cut);
2656         __len11 = std::distance(__first, __first_cut);
2657       }
2658       std::rotate(__first_cut, __middle, __second_cut);
2659       _BidirectionalIterator __new_middle = __first_cut;
2660       std::advance(__new_middle, std::distance(__middle, __second_cut));
2661       std::__merge_without_buffer(__first, __first_cut, __new_middle,
2662                                   __len11, __len22);
2663       std::__merge_without_buffer(__new_middle, __second_cut, __last,
2664                                   __len1 - __len11, __len2 - __len22);
2665     }
2666
2667   /**
2668    *  @if maint
2669    *  This is a helper function for the merge routines.
2670    *  @endif
2671   */
2672   template<typename _BidirectionalIterator, typename _Distance, typename _Compare>
2673     void
2674     __merge_without_buffer(_BidirectionalIterator __first,
2675                            _BidirectionalIterator __middle,
2676                            _BidirectionalIterator __last,
2677                            _Distance __len1, _Distance __len2,
2678                            _Compare __comp)
2679     {
2680       if (__len1 == 0 || __len2 == 0)
2681         return;
2682       if (__len1 + __len2 == 2) {
2683         if (__comp(*__middle, *__first))
2684           std::iter_swap(__first, __middle);
2685         return;
2686       }
2687       _BidirectionalIterator __first_cut = __first;
2688       _BidirectionalIterator __second_cut = __middle;
2689       _Distance __len11 = 0;
2690       _Distance __len22 = 0;
2691       if (__len1 > __len2) {
2692         __len11 = __len1 / 2;
2693         std::advance(__first_cut, __len11);
2694         __second_cut = std::lower_bound(__middle, __last, *__first_cut, __comp);
2695         __len22 = std::distance(__middle, __second_cut);
2696       }
2697       else {
2698         __len22 = __len2 / 2;
2699         std::advance(__second_cut, __len22);
2700         __first_cut = std::upper_bound(__first, __middle, *__second_cut, __comp);
2701         __len11 = std::distance(__first, __first_cut);
2702       }
2703       std::rotate(__first_cut, __middle, __second_cut);
2704       _BidirectionalIterator __new_middle = __first_cut;
2705       std::advance(__new_middle, std::distance(__middle, __second_cut));
2706       std::__merge_without_buffer(__first, __first_cut, __new_middle,
2707                                   __len11, __len22, __comp);
2708       std::__merge_without_buffer(__new_middle, __second_cut, __last,
2709                                   __len1 - __len11, __len2 - __len22, __comp);
2710     }
2711
2712   /**
2713    *  @if maint
2714    *  This is a helper function for the stable sorting routines.
2715    *  @endif
2716   */
2717   template<typename _RandomAccessIterator>
2718     void
2719     __inplace_stable_sort(_RandomAccessIterator __first, _RandomAccessIterator __last)
2720     {
2721       if (__last - __first < 15) {
2722         std::__insertion_sort(__first, __last);
2723         return;
2724       }
2725       _RandomAccessIterator __middle = __first + (__last - __first) / 2;
2726       std::__inplace_stable_sort(__first, __middle);
2727       std::__inplace_stable_sort(__middle, __last);
2728       std::__merge_without_buffer(__first, __middle, __last,
2729                                   __middle - __first,
2730                                   __last - __middle);
2731     }
2732
2733   /**
2734    *  @if maint
2735    *  This is a helper function for the stable sorting routines.
2736    *  @endif
2737   */
2738   template<typename _RandomAccessIterator, typename _Compare>
2739     void
2740     __inplace_stable_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2741                           _Compare __comp)
2742     {
2743       if (__last - __first < 15) {
2744         std::__insertion_sort(__first, __last, __comp);
2745         return;
2746       }
2747       _RandomAccessIterator __middle = __first + (__last - __first) / 2;
2748       std::__inplace_stable_sort(__first, __middle, __comp);
2749       std::__inplace_stable_sort(__middle, __last, __comp);
2750       std::__merge_without_buffer(__first, __middle, __last,
2751                                   __middle - __first,
2752                                   __last - __middle,
2753                                   __comp);
2754     }
2755
2756   /**
2757    *  @brief Merges two sorted ranges.
2758    *  @param  first1  An iterator.
2759    *  @param  first2  Another iterator.
2760    *  @param  last1   Another iterator.
2761    *  @param  last2   Another iterator.
2762    *  @param  result  An iterator pointing to the end of the merged range.
2763    *  @return  An iterator pointing to the first element "not less than" @a val.
2764    *
2765    *  Merges the ranges [first1,last1) and [first2,last2) into the sorted range
2766    *  [result, result + (last1-first1) + (last2-first2)).  Both input ranges
2767    *  must be sorted, and the output range must not overlap with either of
2768    *  the input ranges.  The sort is @e stable, that is, for equivalent
2769    *  elements in the two ranges, elements from the first range will always
2770    *  come before elements from the second.
2771   */
2772   template<typename _InputIterator1, typename _InputIterator2, typename _OutputIterator>
2773     _OutputIterator
2774     merge(_InputIterator1 __first1, _InputIterator1 __last1,
2775           _InputIterator2 __first2, _InputIterator2 __last2,
2776           _OutputIterator __result)
2777     {
2778       // concept requirements
2779       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
2780       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
2781       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
2782             typename iterator_traits<_InputIterator1>::value_type>)
2783       __glibcxx_function_requires(_SameTypeConcept<
2784             typename iterator_traits<_InputIterator1>::value_type,
2785             typename iterator_traits<_InputIterator2>::value_type>)
2786       __glibcxx_function_requires(_LessThanComparableConcept<
2787             typename iterator_traits<_InputIterator1>::value_type>)
2788       __glibcxx_requires_sorted(__first1, __last1);
2789       __glibcxx_requires_sorted(__first2, __last2);
2790
2791       while (__first1 != __last1 && __first2 != __last2) {
2792         if (*__first2 < *__first1) {
2793           *__result = *__first2;
2794           ++__first2;
2795         }
2796         else {
2797           *__result = *__first1;
2798           ++__first1;
2799         }
2800         ++__result;
2801       }
2802       return std::copy(__first2, __last2, std::copy(__first1, __last1, __result));
2803     }
2804
2805   /**
2806    *  @brief Merges two sorted ranges.
2807    *  @param  first1  An iterator.
2808    *  @param  first2  Another iterator.
2809    *  @param  last1   Another iterator.
2810    *  @param  last2   Another iterator.
2811    *  @param  result  An iterator pointing to the end of the merged range.
2812    *  @param  comp    A functor to use for comparisons.
2813    *  @return  An iterator pointing to the first element "not less than" @a val.
2814    *
2815    *  Merges the ranges [first1,last1) and [first2,last2) into the sorted range
2816    *  [result, result + (last1-first1) + (last2-first2)).  Both input ranges
2817    *  must be sorted, and the output range must not overlap with either of
2818    *  the input ranges.  The sort is @e stable, that is, for equivalent
2819    *  elements in the two ranges, elements from the first range will always
2820    *  come before elements from the second.
2821    *
2822    *  The comparison function should have the same effects on ordering as
2823    *  the function used for the initial sort.
2824   */
2825   template<typename _InputIterator1, typename _InputIterator2, typename _OutputIterator,
2826            typename _Compare>
2827     _OutputIterator
2828     merge(_InputIterator1 __first1, _InputIterator1 __last1,
2829           _InputIterator2 __first2, _InputIterator2 __last2,
2830           _OutputIterator __result, _Compare __comp)
2831     {
2832       // concept requirements
2833       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
2834       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
2835       __glibcxx_function_requires(_SameTypeConcept<
2836             typename iterator_traits<_InputIterator1>::value_type,
2837             typename iterator_traits<_InputIterator2>::value_type>)
2838       __glibcxx_function_requires(_OutputIteratorConcept<_OutputIterator,
2839             typename iterator_traits<_InputIterator1>::value_type>)
2840       __glibcxx_function_requires(_BinaryPredicateConcept<_Compare,
2841             typename iterator_traits<_InputIterator1>::value_type,
2842             typename iterator_traits<_InputIterator2>::value_type>)
2843       __glibcxx_requires_sorted_pred(__first1, __last1, __comp);
2844       __glibcxx_requires_sorted_pred(__first2, __last2, __comp);
2845
2846       while (__first1 != __last1 && __first2 != __last2) {
2847         if (__comp(*__first2, *__first1)) {
2848           *__result = *__first2;
2849           ++__first2;
2850         }
2851         else {
2852           *__result = *__first1;
2853           ++__first1;
2854         }
2855         ++__result;
2856       }
2857       return std::copy(__first2, __last2, std::copy(__first1, __last1, __result));
2858     }
2859
2860   template<typename _RandomAccessIterator1, typename _RandomAccessIterator2,
2861            typename _Distance>
2862     void
2863     __merge_sort_loop(_RandomAccessIterator1 __first, _RandomAccessIterator1 __last,
2864                       _RandomAccessIterator2 __result, _Distance __step_size)
2865     {
2866       _Distance __two_step = 2 * __step_size;
2867
2868       while (__last - __first >= __two_step) {
2869         __result = std::merge(__first, __first + __step_size,
2870                               __first + __step_size, __first + __two_step,
2871                               __result);
2872         __first += __two_step;
2873       }
2874
2875       __step_size = std::min(_Distance(__last - __first), __step_size);
2876       std::merge(__first, __first + __step_size, __first + __step_size, __last,
2877                  __result);
2878     }
2879
2880   template<typename _RandomAccessIterator1, typename _RandomAccessIterator2,
2881            typename _Distance, typename _Compare>
2882     void
2883     __merge_sort_loop(_RandomAccessIterator1 __first, _RandomAccessIterator1 __last,
2884                       _RandomAccessIterator2 __result, _Distance __step_size,
2885                       _Compare __comp)
2886     {
2887       _Distance __two_step = 2 * __step_size;
2888
2889       while (__last - __first >= __two_step) {
2890         __result = std::merge(__first, __first + __step_size,
2891                               __first + __step_size, __first + __two_step,
2892                               __result,
2893                               __comp);
2894         __first += __two_step;
2895       }
2896       __step_size = std::min(_Distance(__last - __first), __step_size);
2897
2898       std::merge(__first, __first + __step_size,
2899                  __first + __step_size, __last,
2900                  __result,
2901                  __comp);
2902     }
2903
2904   enum { _S_chunk_size = 7 };
2905
2906   template<typename _RandomAccessIterator, typename _Distance>
2907     void
2908     __chunk_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2909                            _Distance __chunk_size)
2910     {
2911       while (__last - __first >= __chunk_size) {
2912         std::__insertion_sort(__first, __first + __chunk_size);
2913         __first += __chunk_size;
2914       }
2915       std::__insertion_sort(__first, __last);
2916     }
2917
2918   template<typename _RandomAccessIterator, typename _Distance, typename _Compare>
2919     void
2920     __chunk_insertion_sort(_RandomAccessIterator __first, _RandomAccessIterator __last,
2921                            _Distance __chunk_size, _Compare __comp)
2922     {
2923       while (__last - __first >= __chunk_size) {
2924         std::__insertion_sort(__first, __first + __chunk_size, __comp);
2925         __first += __chunk_size;
2926       }
2927       std::__insertion_sort(__first, __last, __comp);
2928     }
2929
2930   template<typename _RandomAccessIterator, typename _Pointer>
2931     void
2932     __merge_sort_with_buffer(_RandomAccessIterator __first, _RandomAccessIterator __last,
2933                              _Pointer __buffer)
2934     {
2935       typedef typename iterator_traits<_RandomAccessIterator>::difference_type _Distance;
2936
2937       _Distance __len = __last - __first;
2938       _Pointer __buffer_last = __buffer + __len;
2939
2940       _Distance __step_size = _S_chunk_size;
2941       std::__chunk_insertion_sort(__first, __last, __step_size);
2942
2943       while (__step_size < __len) {
2944         std::__merge_sort_loop(__first, __last, __buffer, __step_size);
2945         __step_size *= 2;
2946         std::__merge_sort_loop(__buffer, __buffer_last, __first, __step_size);
2947         __step_size *= 2;
2948       }
2949     }
2950
2951   template<typename _RandomAccessIterator, typename _Pointer, typename _Compare>
2952     void
2953     __merge_sort_with_buffer(_RandomAccessIterator __first, _RandomAccessIterator __last,
2954                              _Pointer __buffer, _Compare __comp)
2955     {
2956       typedef typename iterator_traits<_RandomAccessIterator>::difference_type _Distance;
2957
2958       _Distance __len = __last - __first;
2959       _Pointer __buffer_last = __buffer + __len;
2960
2961       _Distance __step_size = _S_chunk_size;
2962       std::__chunk_insertion_sort(__first, __last, __step_size, __comp);
2963
2964       while (__step_size < __len) {
2965         std::__merge_sort_loop(__first, __last, __buffer, __step_size, __comp);
2966         __step_size *= 2;
2967         std::__merge_sort_loop(__buffer, __buffer_last, __first, __step_size, __comp);
2968         __step_size *= 2;
2969       }
2970     }
2971
2972   /**
2973    *  @if maint
2974    *  This is a helper function for the merge routines.
2975    *  @endif
2976   */
2977   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
2978            typename _BidirectionalIterator3>
2979     _BidirectionalIterator3
2980     __merge_backward(_BidirectionalIterator1 __first1, _BidirectionalIterator1 __last1,
2981                      _BidirectionalIterator2 __first2, _BidirectionalIterator2 __last2,
2982                      _BidirectionalIterator3 __result)
2983     {
2984       if (__first1 == __last1)
2985         return std::copy_backward(__first2, __last2, __result);
2986       if (__first2 == __last2)
2987         return std::copy_backward(__first1, __last1, __result);
2988       --__last1;
2989       --__last2;
2990       while (true) {
2991         if (*__last2 < *__last1) {
2992           *--__result = *__last1;
2993           if (__first1 == __last1)
2994             return std::copy_backward(__first2, ++__last2, __result);
2995           --__last1;
2996         }
2997         else {
2998           *--__result = *__last2;
2999           if (__first2 == __last2)
3000             return std::copy_backward(__first1, ++__last1, __result);
3001           --__last2;
3002         }
3003       }
3004     }
3005
3006   /**
3007    *  @if maint
3008    *  This is a helper function for the merge routines.
3009    *  @endif
3010   */
3011   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
3012            typename _BidirectionalIterator3, typename _Compare>
3013     _BidirectionalIterator3
3014     __merge_backward(_BidirectionalIterator1 __first1, _BidirectionalIterator1 __last1,
3015                      _BidirectionalIterator2 __first2, _BidirectionalIterator2 __last2,
3016                      _BidirectionalIterator3 __result,
3017                      _Compare __comp)
3018     {
3019       if (__first1 == __last1)
3020         return std::copy_backward(__first2, __last2, __result);
3021       if (__first2 == __last2)
3022         return std::copy_backward(__first1, __last1, __result);
3023       --__last1;
3024       --__last2;
3025       while (true) {
3026         if (__comp(*__last2, *__last1)) {
3027           *--__result = *__last1;
3028           if (__first1 == __last1)
3029             return std::copy_backward(__first2, ++__last2, __result);
3030           --__last1;
3031         }
3032         else {
3033           *--__result = *__last2;
3034           if (__first2 == __last2)
3035             return std::copy_backward(__first1, ++__last1, __result);
3036           --__last2;
3037         }
3038       }
3039     }
3040
3041   /**
3042    *  @if maint
3043    *  This is a helper function for the merge routines.
3044    *  @endif
3045   */
3046   template<typename _BidirectionalIterator1, typename _BidirectionalIterator2,
3047            typename _Distance>
3048     _BidirectionalIterator1
3049     __rotate_adaptive(_BidirectionalIterator1 __first,
3050                       _BidirectionalIterator1 __middle,
3051                       _BidirectionalIterator1 __last,
3052                       _Distance __len1, _Distance __len2,
3053                       _BidirectionalIterator2 __buffer,
3054                       _Distance __buffer_size)
3055     {
3056       _BidirectionalIterator2 __buffer_end;
3057       if (__len1 > __len2 && __len2 <= __buffer_size) {
3058         __buffer_end = std::copy(__middle, __last, __buffer);
3059         std::copy_backward(__first, __middle, __last);
3060         return std::copy(__buffer, __buffer_end, __first);
3061       }
3062       else if (__len1 <= __buffer_size) {
3063         __buffer_end = std::copy(__first, __middle, __buffer);
3064         std::copy(__middle, __last, __first);
3065         return std::copy_backward(__buffer, __buffer_end, __last);
3066       }
3067       else {
3068         std::rotate(__first, __middle, __last);
3069         std::advance(__first, std::distance(__middle, __last));
3070         return __first;
3071       }
3072     }
3073
3074   /**
3075    *  @if maint
3076    *  This is a helper function for the merge routines.
3077    *  @endif
3078   */
3079   template<typename _BidirectionalIterator, typename _Distance, typename _Pointer>
3080     void
3081     __merge_adaptive(_BidirectionalIterator __first,
3082                      _BidirectionalIterator __middle,
3083                      _BidirectionalIterator __last,
3084                      _Distance __len1, _Distance __len2,
3085                      _Pointer __buffer, _Distance __buffer_size)
3086     {
3087           if (__len1 <= __len2 && __len1 <= __buffer_size) {
3088             _Pointer __buffer_end = std::copy(__first, __middle, __buffer);
3089             std::merge(__buffer, __buffer_end, __middle, __last, __first);
3090           }
3091           else if (__len2 <= __buffer_size) {
3092             _Pointer __buffer_end = std::copy(__middle, __last, __buffer);
3093             std::__merge_backward(__first, __middle, __buffer, __buffer_end, __last);
3094           }
3095           else {
3096             _BidirectionalIterator __first_cut = __first;
3097             _BidirectionalIterator __second_cut = __middle;
3098             _Distance __len11 = 0;
3099             _Distance __len22 = 0;
3100             if (__len1 > __len2) {
3101                   __len11 = __len1 / 2;
3102                   std::advance(__first_cut, __len11);
3103                   __second_cut = std::lower_bound(__middle, __last, *__first_cut);
3104                   __len22 = std::distance(__middle, __second_cut);
3105             }
3106             else {
3107                   __len22 = __len2 / 2;
3108                   std::advance(__second_cut, __len22);
3109                   __first_cut = std::upper_bound(__first, __middle, *__second_cut);
3110                   __len11 = std::distance(__first, __first_cut);
3111             }
3112             _BidirectionalIterator __new_middle =
3113                   std::__rotate_adaptive(__first_cut, __middle, __second_cut,
3114                                          __len1 - __len11, __len22, __buffer,
3115                                          __buffer_size);
3116             std::__merge_adaptive(__first, __first_cut, __new_middle, __len11,
3117                                   __len22, __buffer, __buffer_size);
3118             std::__merge_adaptive(__new_middle, __second_cut, __last, __len1 - __len11,
3119                                   __len2 - __len22, __buffer, __buffer_size);
3120           }
3121     }
3122
3123   /**
3124    *  @if maint
3125    *  This is a helper function for the merge routines.
3126    *  @endif
3127   */
3128   template<typename _BidirectionalIterator, typename _Distance, typename _Pointer,
3129            typename _Compare>
3130     void
3131     __merge_adaptive(_BidirectionalIterator __first,
3132                      _BidirectionalIterator __middle,
3133                      _BidirectionalIterator __last,
3134                      _Distance __len1, _Distance __len2,
3135                      _Pointer __buffer, _Distance __buffer_size,
3136                      _Compare __comp)
3137     {
3138           if (__len1 <= __len2 && __len1 <= __buffer_size) {
3139             _Pointer __buffer_end = std::copy(__first, __middle, __buffer);
3140             std::merge(__buffer, __buffer_end, __middle, __last, __first, __comp);
3141           }
3142           else if (__len2 <= __buffer_size) {
3143             _Pointer __buffer_end = std::copy(__middle, __last, __buffer);
3144             std::__merge_backward(__first, __middle, __buffer, __buffer_end, __last,
3145                                   __comp);
3146           }
3147           else {
3148             _BidirectionalIterator __first_cut = __first;
3149             _BidirectionalIterator __second_cut = __middle;
3150             _Distance __len11 = 0;
3151             _Distance __len22 = 0;
3152             if (__len1 > __len2) {
3153                   __len11 = __len1 / 2;
3154                   std::advance(__first_cut, __len11);
3155                   __second_cut = std::lower_bound(__middle, __last, *__first_cut, __comp);
3156                   __len22 = std::distance(__middle, __second_cut);
3157             }
3158             else {
3159                   __len22 = __len2 / 2;
3160                   std::advance(__second_cut, __len22);
3161                   __first_cut = std::upper_bound(__first, __middle, *__second_cut, __comp);
3162                   __len11 = std::distance(__first, __first_cut);
3163             }
3164             _BidirectionalIterator __new_middle =
3165                   std::__rotate_adaptive(__first_cut, __middle, __second_cut,
3166                                          __len1 - __len11, __len22, __buffer,
3167                                          __buffer_size);
3168             std::__merge_adaptive(__first, __first_cut, __new_middle, __len11,
3169                                   __len22, __buffer, __buffer_size, __comp);
3170             std::__merge_adaptive(__new_middle, __second_cut, __last, __len1 - __len11,
3171                                   __len2 - __len22, __buffer, __buffer_size, __comp);
3172           }
3173     }
3174