OSDN Git Service

2010-05-21 Paolo Carlini <paolo.carlini@oracle.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / bits / stl_algobase.h
1 // Core algorithmic facilities -*- C++ -*-
2
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
5 //
6 // This file is part of the GNU ISO C++ Library.  This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
10 // any later version.
11
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
20
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
24 // <http://www.gnu.org/licenses/>.
25
26 /*
27  *
28  * Copyright (c) 1994
29  * Hewlett-Packard Company
30  *
31  * Permission to use, copy, modify, distribute and sell this software
32  * and its documentation for any purpose is hereby granted without fee,
33  * provided that the above copyright notice appear in all copies and
34  * that both that copyright notice and this permission notice appear
35  * in supporting documentation.  Hewlett-Packard Company makes no
36  * representations about the suitability of this software for any
37  * purpose.  It is provided "as is" without express or implied warranty.
38  *
39  *
40  * Copyright (c) 1996-1998
41  * Silicon Graphics Computer Systems, Inc.
42  *
43  * Permission to use, copy, modify, distribute and sell this software
44  * and its documentation for any purpose is hereby granted without fee,
45  * provided that the above copyright notice appear in all copies and
46  * that both that copyright notice and this permission notice appear
47  * in supporting documentation.  Silicon Graphics makes no
48  * representations about the suitability of this software for any
49  * purpose.  It is provided "as is" without express or implied warranty.
50  */
51
52 /** @file stl_algobase.h
53  *  This is an internal header file, included by other library headers.
54  *  You should not attempt to use it directly.
55  */
56
57 #ifndef _STL_ALGOBASE_H
58 #define _STL_ALGOBASE_H 1
59
60 #include <bits/c++config.h>
61 #include <cstddef>
62 #include <bits/functexcept.h>
63 #include <bits/cpp_type_traits.h>
64 #include <ext/type_traits.h>
65 #include <ext/numeric_traits.h>
66 #include <bits/stl_pair.h>
67 #include <bits/stl_iterator_base_types.h>
68 #include <bits/stl_iterator_base_funcs.h>
69 #include <bits/stl_iterator.h>
70 #include <bits/concept_check.h>
71 #include <debug/debug.h>
72 #include <bits/move.h> // For std::swap and _GLIBCXX_MOVE
73
74 _GLIBCXX_BEGIN_NAMESPACE(std)
75
76   // See http://gcc.gnu.org/ml/libstdc++/2004-08/msg00167.html: in a
77   // nutshell, we are partially implementing the resolution of DR 187,
78   // when it's safe, i.e., the value_types are equal.
79   template<bool _BoolType>
80     struct __iter_swap
81     {
82       template<typename _ForwardIterator1, typename _ForwardIterator2>
83         static void
84         iter_swap(_ForwardIterator1 __a, _ForwardIterator2 __b)
85         {
86           typedef typename iterator_traits<_ForwardIterator1>::value_type
87             _ValueType1;
88           _ValueType1 __tmp = _GLIBCXX_MOVE(*__a);
89           *__a = _GLIBCXX_MOVE(*__b);
90           *__b = _GLIBCXX_MOVE(__tmp);
91         }
92     };
93
94   template<>
95     struct __iter_swap<true>
96     {
97       template<typename _ForwardIterator1, typename _ForwardIterator2>
98         static void 
99         iter_swap(_ForwardIterator1 __a, _ForwardIterator2 __b)
100         {
101           swap(*__a, *__b);
102         }
103     };
104
105   /**
106    *  @brief Swaps the contents of two iterators.
107    *  @ingroup mutating_algorithms
108    *  @param  a  An iterator.
109    *  @param  b  Another iterator.
110    *  @return   Nothing.
111    *
112    *  This function swaps the values pointed to by two iterators, not the
113    *  iterators themselves.
114   */
115   template<typename _ForwardIterator1, typename _ForwardIterator2>
116     inline void
117     iter_swap(_ForwardIterator1 __a, _ForwardIterator2 __b)
118     {
119       typedef typename iterator_traits<_ForwardIterator1>::value_type
120         _ValueType1;
121       typedef typename iterator_traits<_ForwardIterator2>::value_type
122         _ValueType2;
123
124       // concept requirements
125       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
126                                   _ForwardIterator1>)
127       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
128                                   _ForwardIterator2>)
129       __glibcxx_function_requires(_ConvertibleConcept<_ValueType1,
130                                   _ValueType2>)
131       __glibcxx_function_requires(_ConvertibleConcept<_ValueType2,
132                                   _ValueType1>)
133
134       typedef typename iterator_traits<_ForwardIterator1>::reference
135         _ReferenceType1;
136       typedef typename iterator_traits<_ForwardIterator2>::reference
137         _ReferenceType2;
138       std::__iter_swap<__are_same<_ValueType1, _ValueType2>::__value
139         && __are_same<_ValueType1&, _ReferenceType1>::__value
140         && __are_same<_ValueType2&, _ReferenceType2>::__value>::
141         iter_swap(__a, __b);
142     }
143
144   /**
145    *  @brief Swap the elements of two sequences.
146    *  @ingroup mutating_algorithms
147    *  @param  first1  A forward iterator.
148    *  @param  last1   A forward iterator.
149    *  @param  first2  A forward iterator.
150    *  @return   An iterator equal to @p first2+(last1-first1).
151    *
152    *  Swaps each element in the range @p [first1,last1) with the
153    *  corresponding element in the range @p [first2,(last1-first1)).
154    *  The ranges must not overlap.
155   */
156   template<typename _ForwardIterator1, typename _ForwardIterator2>
157     _ForwardIterator2
158     swap_ranges(_ForwardIterator1 __first1, _ForwardIterator1 __last1,
159                 _ForwardIterator2 __first2)
160     {
161       // concept requirements
162       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
163                                   _ForwardIterator1>)
164       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
165                                   _ForwardIterator2>)
166       __glibcxx_requires_valid_range(__first1, __last1);
167
168       for (; __first1 != __last1; ++__first1, ++__first2)
169         std::iter_swap(__first1, __first2);
170       return __first2;
171     }
172
173   /**
174    *  @brief This does what you think it does.
175    *  @ingroup sorting_algorithms
176    *  @param  a  A thing of arbitrary type.
177    *  @param  b  Another thing of arbitrary type.
178    *  @return   The lesser of the parameters.
179    *
180    *  This is the simple classic generic implementation.  It will work on
181    *  temporary expressions, since they are only evaluated once, unlike a
182    *  preprocessor macro.
183   */
184   template<typename _Tp>
185     inline const _Tp&
186     min(const _Tp& __a, const _Tp& __b)
187     {
188       // concept requirements
189       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
190       //return __b < __a ? __b : __a;
191       if (__b < __a)
192         return __b;
193       return __a;
194     }
195
196   /**
197    *  @brief This does what you think it does.
198    *  @ingroup sorting_algorithms
199    *  @param  a  A thing of arbitrary type.
200    *  @param  b  Another thing of arbitrary type.
201    *  @return   The greater of the parameters.
202    *
203    *  This is the simple classic generic implementation.  It will work on
204    *  temporary expressions, since they are only evaluated once, unlike a
205    *  preprocessor macro.
206   */
207   template<typename _Tp>
208     inline const _Tp&
209     max(const _Tp& __a, const _Tp& __b)
210     {
211       // concept requirements
212       __glibcxx_function_requires(_LessThanComparableConcept<_Tp>)
213       //return  __a < __b ? __b : __a;
214       if (__a < __b)
215         return __b;
216       return __a;
217     }
218
219   /**
220    *  @brief This does what you think it does.
221    *  @ingroup sorting_algorithms
222    *  @param  a  A thing of arbitrary type.
223    *  @param  b  Another thing of arbitrary type.
224    *  @param  comp  A @link comparison_functors comparison functor@endlink.
225    *  @return   The lesser of the parameters.
226    *
227    *  This will work on temporary expressions, since they are only evaluated
228    *  once, unlike a preprocessor macro.
229   */
230   template<typename _Tp, typename _Compare>
231     inline const _Tp&
232     min(const _Tp& __a, const _Tp& __b, _Compare __comp)
233     {
234       //return __comp(__b, __a) ? __b : __a;
235       if (__comp(__b, __a))
236         return __b;
237       return __a;
238     }
239
240   /**
241    *  @brief This does what you think it does.
242    *  @ingroup sorting_algorithms
243    *  @param  a  A thing of arbitrary type.
244    *  @param  b  Another thing of arbitrary type.
245    *  @param  comp  A @link comparison_functors comparison functor@endlink.
246    *  @return   The greater of the parameters.
247    *
248    *  This will work on temporary expressions, since they are only evaluated
249    *  once, unlike a preprocessor macro.
250   */
251   template<typename _Tp, typename _Compare>
252     inline const _Tp&
253     max(const _Tp& __a, const _Tp& __b, _Compare __comp)
254     {
255       //return __comp(__a, __b) ? __b : __a;
256       if (__comp(__a, __b))
257         return __b;
258       return __a;
259     }
260
261
262   // If _Iterator has a base returns it otherwise _Iterator is returned
263   // untouched
264   template<typename _Iterator, bool _HasBase>
265     struct _Iter_base
266     {
267       typedef _Iterator iterator_type;
268       static iterator_type
269       _S_base(_Iterator __it)
270       { return __it; }
271     };
272
273   template<typename _Iterator>
274     struct _Iter_base<_Iterator, true>
275     {
276       typedef typename _Iterator::iterator_type iterator_type;
277       static iterator_type
278       _S_base(_Iterator __it)
279       { return __it.base(); }
280     };
281
282   // If _Iterator is a __normal_iterator return its base (a plain pointer,
283   // normally) otherwise return it untouched.  See copy, fill, ... 
284   template<typename _Iterator>
285     struct _Niter_base
286     : _Iter_base<_Iterator, __is_normal_iterator<_Iterator>::__value>
287     { };
288
289   template<typename _Iterator>
290     inline typename _Niter_base<_Iterator>::iterator_type
291     __niter_base(_Iterator __it)
292     { return std::_Niter_base<_Iterator>::_S_base(__it); }
293
294   // Likewise, for move_iterator.
295   template<typename _Iterator>
296     struct _Miter_base
297     : _Iter_base<_Iterator, __is_move_iterator<_Iterator>::__value>
298     { };
299
300   template<typename _Iterator>
301     inline typename _Miter_base<_Iterator>::iterator_type
302     __miter_base(_Iterator __it)
303     { return std::_Miter_base<_Iterator>::_S_base(__it); }
304
305   // All of these auxiliary structs serve two purposes.  (1) Replace
306   // calls to copy with memmove whenever possible.  (Memmove, not memcpy,
307   // because the input and output ranges are permitted to overlap.)
308   // (2) If we're using random access iterators, then write the loop as
309   // a for loop with an explicit count.
310
311   template<bool, bool, typename>
312     struct __copy_move
313     {
314       template<typename _II, typename _OI>
315         static _OI
316         __copy_m(_II __first, _II __last, _OI __result)
317         {
318           for (; __first != __last; ++__result, ++__first)
319             *__result = *__first;
320           return __result;
321         }
322     };
323
324 #ifdef __GXX_EXPERIMENTAL_CXX0X__
325   template<typename _Category>
326     struct __copy_move<true, false, _Category>
327     {
328       template<typename _II, typename _OI>
329         static _OI
330         __copy_m(_II __first, _II __last, _OI __result)
331         {
332           for (; __first != __last; ++__result, ++__first)
333             *__result = std::move(*__first);
334           return __result;
335         }
336     };
337 #endif
338
339   template<>
340     struct __copy_move<false, false, random_access_iterator_tag>
341     {
342       template<typename _II, typename _OI>
343         static _OI
344         __copy_m(_II __first, _II __last, _OI __result)
345         { 
346           typedef typename iterator_traits<_II>::difference_type _Distance;
347           for(_Distance __n = __last - __first; __n > 0; --__n)
348             {
349               *__result = *__first;
350               ++__first;
351               ++__result;
352             }
353           return __result;
354         }
355     };
356
357 #ifdef __GXX_EXPERIMENTAL_CXX0X__
358   template<>
359     struct __copy_move<true, false, random_access_iterator_tag>
360     {
361       template<typename _II, typename _OI>
362         static _OI
363         __copy_m(_II __first, _II __last, _OI __result)
364         { 
365           typedef typename iterator_traits<_II>::difference_type _Distance;
366           for(_Distance __n = __last - __first; __n > 0; --__n)
367             {
368               *__result = std::move(*__first);
369               ++__first;
370               ++__result;
371             }
372           return __result;
373         }
374     };
375 #endif
376
377   template<bool _IsMove>
378     struct __copy_move<_IsMove, true, random_access_iterator_tag>
379     {
380       template<typename _Tp>
381         static _Tp*
382         __copy_m(const _Tp* __first, const _Tp* __last, _Tp* __result)
383         {
384           const ptrdiff_t _Num = __last - __first;
385           if (_Num)
386             __builtin_memmove(__result, __first, sizeof(_Tp) * _Num);
387           return __result + _Num;
388         }
389     };
390
391   template<bool _IsMove, typename _II, typename _OI>
392     inline _OI
393     __copy_move_a(_II __first, _II __last, _OI __result)
394     {
395       typedef typename iterator_traits<_II>::value_type _ValueTypeI;
396       typedef typename iterator_traits<_OI>::value_type _ValueTypeO;
397       typedef typename iterator_traits<_II>::iterator_category _Category;
398       const bool __simple = (__is_pod(_ValueTypeI)
399                              && __is_pointer<_II>::__value
400                              && __is_pointer<_OI>::__value
401                              && __are_same<_ValueTypeI, _ValueTypeO>::__value);
402
403       return std::__copy_move<_IsMove, __simple,
404                               _Category>::__copy_m(__first, __last, __result);
405     }
406
407   // Helpers for streambuf iterators (either istream or ostream).
408   // NB: avoid including <iosfwd>, relatively large.
409   template<typename _CharT>
410     struct char_traits;
411
412   template<typename _CharT, typename _Traits>
413     class istreambuf_iterator;
414
415   template<typename _CharT, typename _Traits>
416     class ostreambuf_iterator;
417
418   template<bool _IsMove, typename _CharT>
419     typename __gnu_cxx::__enable_if<__is_char<_CharT>::__value, 
420              ostreambuf_iterator<_CharT, char_traits<_CharT> > >::__type
421     __copy_move_a2(_CharT*, _CharT*,
422                    ostreambuf_iterator<_CharT, char_traits<_CharT> >);
423
424   template<bool _IsMove, typename _CharT>
425     typename __gnu_cxx::__enable_if<__is_char<_CharT>::__value, 
426              ostreambuf_iterator<_CharT, char_traits<_CharT> > >::__type
427     __copy_move_a2(const _CharT*, const _CharT*,
428                    ostreambuf_iterator<_CharT, char_traits<_CharT> >);
429
430   template<bool _IsMove, typename _CharT>
431     typename __gnu_cxx::__enable_if<__is_char<_CharT>::__value,
432                                     _CharT*>::__type
433     __copy_move_a2(istreambuf_iterator<_CharT, char_traits<_CharT> >,
434                    istreambuf_iterator<_CharT, char_traits<_CharT> >, _CharT*);
435
436   template<bool _IsMove, typename _II, typename _OI>
437     inline _OI
438     __copy_move_a2(_II __first, _II __last, _OI __result)
439     {
440       return _OI(std::__copy_move_a<_IsMove>(std::__niter_base(__first),
441                                              std::__niter_base(__last),
442                                              std::__niter_base(__result)));
443     }
444
445   /**
446    *  @brief Copies the range [first,last) into result.
447    *  @ingroup mutating_algorithms
448    *  @param  first  An input iterator.
449    *  @param  last   An input iterator.
450    *  @param  result An output iterator.
451    *  @return   result + (first - last)
452    *
453    *  This inline function will boil down to a call to @c memmove whenever
454    *  possible.  Failing that, if random access iterators are passed, then the
455    *  loop count will be known (and therefore a candidate for compiler
456    *  optimizations such as unrolling).  Result may not be contained within
457    *  [first,last); the copy_backward function should be used instead.
458    *
459    *  Note that the end of the output range is permitted to be contained
460    *  within [first,last).
461   */
462   template<typename _II, typename _OI>
463     inline _OI
464     copy(_II __first, _II __last, _OI __result)
465     {
466       // concept requirements
467       __glibcxx_function_requires(_InputIteratorConcept<_II>)
468       __glibcxx_function_requires(_OutputIteratorConcept<_OI,
469             typename iterator_traits<_II>::value_type>)
470       __glibcxx_requires_valid_range(__first, __last);
471
472       return (std::__copy_move_a2<__is_move_iterator<_II>::__value>
473               (std::__miter_base(__first), std::__miter_base(__last),
474                __result));
475     }
476
477 #ifdef __GXX_EXPERIMENTAL_CXX0X__
478   /**
479    *  @brief Moves the range [first,last) into result.
480    *  @ingroup mutating_algorithms
481    *  @param  first  An input iterator.
482    *  @param  last   An input iterator.
483    *  @param  result An output iterator.
484    *  @return   result + (first - last)
485    *
486    *  This inline function will boil down to a call to @c memmove whenever
487    *  possible.  Failing that, if random access iterators are passed, then the
488    *  loop count will be known (and therefore a candidate for compiler
489    *  optimizations such as unrolling).  Result may not be contained within
490    *  [first,last); the move_backward function should be used instead.
491    *
492    *  Note that the end of the output range is permitted to be contained
493    *  within [first,last).
494   */
495   template<typename _II, typename _OI>
496     inline _OI
497     move(_II __first, _II __last, _OI __result)
498     {
499       // concept requirements
500       __glibcxx_function_requires(_InputIteratorConcept<_II>)
501       __glibcxx_function_requires(_OutputIteratorConcept<_OI,
502             typename iterator_traits<_II>::value_type>)
503       __glibcxx_requires_valid_range(__first, __last);
504
505       return std::__copy_move_a2<true>(std::__miter_base(__first),
506                                        std::__miter_base(__last), __result);
507     }
508
509 #define _GLIBCXX_MOVE3(_Tp, _Up, _Vp) std::move(_Tp, _Up, _Vp)
510 #else
511 #define _GLIBCXX_MOVE3(_Tp, _Up, _Vp) std::copy(_Tp, _Up, _Vp)
512 #endif
513
514   template<bool, bool, typename>
515     struct __copy_move_backward
516     {
517       template<typename _BI1, typename _BI2>
518         static _BI2
519         __copy_move_b(_BI1 __first, _BI1 __last, _BI2 __result)
520         {
521           while (__first != __last)
522             *--__result = *--__last;
523           return __result;
524         }
525     };
526
527 #ifdef __GXX_EXPERIMENTAL_CXX0X__
528   template<typename _Category>
529     struct __copy_move_backward<true, false, _Category>
530     {
531       template<typename _BI1, typename _BI2>
532         static _BI2
533         __copy_move_b(_BI1 __first, _BI1 __last, _BI2 __result)
534         {
535           while (__first != __last)
536             *--__result = std::move(*--__last);
537           return __result;
538         }
539     };
540 #endif
541
542   template<>
543     struct __copy_move_backward<false, false, random_access_iterator_tag>
544     {
545       template<typename _BI1, typename _BI2>
546         static _BI2
547         __copy_move_b(_BI1 __first, _BI1 __last, _BI2 __result)
548         {
549           typename iterator_traits<_BI1>::difference_type __n;
550           for (__n = __last - __first; __n > 0; --__n)
551             *--__result = *--__last;
552           return __result;
553         }
554     };
555
556 #ifdef __GXX_EXPERIMENTAL_CXX0X__
557   template<>
558     struct __copy_move_backward<true, false, random_access_iterator_tag>
559     {
560       template<typename _BI1, typename _BI2>
561         static _BI2
562         __copy_move_b(_BI1 __first, _BI1 __last, _BI2 __result)
563         {
564           typename iterator_traits<_BI1>::difference_type __n;
565           for (__n = __last - __first; __n > 0; --__n)
566             *--__result = std::move(*--__last);
567           return __result;
568         }
569     };
570 #endif
571
572   template<bool _IsMove>
573     struct __copy_move_backward<_IsMove, true, random_access_iterator_tag>
574     {
575       template<typename _Tp>
576         static _Tp*
577         __copy_move_b(const _Tp* __first, const _Tp* __last, _Tp* __result)
578         {
579           const ptrdiff_t _Num = __last - __first;
580           if (_Num)
581             __builtin_memmove(__result - _Num, __first, sizeof(_Tp) * _Num);
582           return __result - _Num;
583         }
584     };
585
586   template<bool _IsMove, typename _BI1, typename _BI2>
587     inline _BI2
588     __copy_move_backward_a(_BI1 __first, _BI1 __last, _BI2 __result)
589     {
590       typedef typename iterator_traits<_BI1>::value_type _ValueType1;
591       typedef typename iterator_traits<_BI2>::value_type _ValueType2;
592       typedef typename iterator_traits<_BI1>::iterator_category _Category;
593       const bool __simple = (__is_pod(_ValueType1)
594                              && __is_pointer<_BI1>::__value
595                              && __is_pointer<_BI2>::__value
596                              && __are_same<_ValueType1, _ValueType2>::__value);
597
598       return std::__copy_move_backward<_IsMove, __simple,
599                                        _Category>::__copy_move_b(__first,
600                                                                  __last,
601                                                                  __result);
602     }
603
604   template<bool _IsMove, typename _BI1, typename _BI2>
605     inline _BI2
606     __copy_move_backward_a2(_BI1 __first, _BI1 __last, _BI2 __result)
607     {
608       return _BI2(std::__copy_move_backward_a<_IsMove>
609                   (std::__niter_base(__first), std::__niter_base(__last),
610                    std::__niter_base(__result)));
611     }
612
613   /**
614    *  @brief Copies the range [first,last) into result.
615    *  @ingroup mutating_algorithms
616    *  @param  first  A bidirectional iterator.
617    *  @param  last   A bidirectional iterator.
618    *  @param  result A bidirectional iterator.
619    *  @return   result - (first - last)
620    *
621    *  The function has the same effect as copy, but starts at the end of the
622    *  range and works its way to the start, returning the start of the result.
623    *  This inline function will boil down to a call to @c memmove whenever
624    *  possible.  Failing that, if random access iterators are passed, then the
625    *  loop count will be known (and therefore a candidate for compiler
626    *  optimizations such as unrolling).
627    *
628    *  Result may not be in the range [first,last).  Use copy instead.  Note
629    *  that the start of the output range may overlap [first,last).
630   */
631   template<typename _BI1, typename _BI2>
632     inline _BI2
633     copy_backward(_BI1 __first, _BI1 __last, _BI2 __result)
634     {
635       // concept requirements
636       __glibcxx_function_requires(_BidirectionalIteratorConcept<_BI1>)
637       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<_BI2>)
638       __glibcxx_function_requires(_ConvertibleConcept<
639             typename iterator_traits<_BI1>::value_type,
640             typename iterator_traits<_BI2>::value_type>)
641       __glibcxx_requires_valid_range(__first, __last);
642
643       return (std::__copy_move_backward_a2<__is_move_iterator<_BI1>::__value>
644               (std::__miter_base(__first), std::__miter_base(__last),
645                __result));
646     }
647
648 #ifdef __GXX_EXPERIMENTAL_CXX0X__
649   /**
650    *  @brief Moves the range [first,last) into result.
651    *  @ingroup mutating_algorithms
652    *  @param  first  A bidirectional iterator.
653    *  @param  last   A bidirectional iterator.
654    *  @param  result A bidirectional iterator.
655    *  @return   result - (first - last)
656    *
657    *  The function has the same effect as move, but starts at the end of the
658    *  range and works its way to the start, returning the start of the result.
659    *  This inline function will boil down to a call to @c memmove whenever
660    *  possible.  Failing that, if random access iterators are passed, then the
661    *  loop count will be known (and therefore a candidate for compiler
662    *  optimizations such as unrolling).
663    *
664    *  Result may not be in the range [first,last).  Use move instead.  Note
665    *  that the start of the output range may overlap [first,last).
666   */
667   template<typename _BI1, typename _BI2>
668     inline _BI2
669     move_backward(_BI1 __first, _BI1 __last, _BI2 __result)
670     {
671       // concept requirements
672       __glibcxx_function_requires(_BidirectionalIteratorConcept<_BI1>)
673       __glibcxx_function_requires(_Mutable_BidirectionalIteratorConcept<_BI2>)
674       __glibcxx_function_requires(_ConvertibleConcept<
675             typename iterator_traits<_BI1>::value_type,
676             typename iterator_traits<_BI2>::value_type>)
677       __glibcxx_requires_valid_range(__first, __last);
678
679       return std::__copy_move_backward_a2<true>(std::__miter_base(__first),
680                                                 std::__miter_base(__last),
681                                                 __result);
682     }
683
684 #define _GLIBCXX_MOVE_BACKWARD3(_Tp, _Up, _Vp) std::move_backward(_Tp, _Up, _Vp)
685 #else
686 #define _GLIBCXX_MOVE_BACKWARD3(_Tp, _Up, _Vp) std::copy_backward(_Tp, _Up, _Vp)
687 #endif
688
689   template<typename _ForwardIterator, typename _Tp>
690     inline typename
691     __gnu_cxx::__enable_if<!__is_scalar<_Tp>::__value, void>::__type
692     __fill_a(_ForwardIterator __first, _ForwardIterator __last,
693              const _Tp& __value)
694     {
695       for (; __first != __last; ++__first)
696         *__first = __value;
697     }
698     
699   template<typename _ForwardIterator, typename _Tp>
700     inline typename
701     __gnu_cxx::__enable_if<__is_scalar<_Tp>::__value, void>::__type
702     __fill_a(_ForwardIterator __first, _ForwardIterator __last,
703              const _Tp& __value)
704     {
705       const _Tp __tmp = __value;
706       for (; __first != __last; ++__first)
707         *__first = __tmp;
708     }
709
710   // Specialization: for char types we can use memset.
711   template<typename _Tp>
712     inline typename
713     __gnu_cxx::__enable_if<__is_byte<_Tp>::__value, void>::__type
714     __fill_a(_Tp* __first, _Tp* __last, const _Tp& __c)
715     {
716       const _Tp __tmp = __c;
717       __builtin_memset(__first, static_cast<unsigned char>(__tmp),
718                        __last - __first);
719     }
720
721   /**
722    *  @brief Fills the range [first,last) with copies of value.
723    *  @ingroup mutating_algorithms
724    *  @param  first  A forward iterator.
725    *  @param  last   A forward iterator.
726    *  @param  value  A reference-to-const of arbitrary type.
727    *  @return   Nothing.
728    *
729    *  This function fills a range with copies of the same value.  For char
730    *  types filling contiguous areas of memory, this becomes an inline call
731    *  to @c memset or @c wmemset.
732   */
733   template<typename _ForwardIterator, typename _Tp>
734     inline void
735     fill(_ForwardIterator __first, _ForwardIterator __last, const _Tp& __value)
736     {
737       // concept requirements
738       __glibcxx_function_requires(_Mutable_ForwardIteratorConcept<
739                                   _ForwardIterator>)
740       __glibcxx_requires_valid_range(__first, __last);
741
742       std::__fill_a(std::__niter_base(__first), std::__niter_base(__last),
743                     __value);
744     }
745
746   template<typename _OutputIterator, typename _Size, typename _Tp>
747     inline typename
748     __gnu_cxx::__enable_if<!__is_scalar<_Tp>::__value, _OutputIterator>::__type
749     __fill_n_a(_OutputIterator __first, _Size __n, const _Tp& __value)
750     {
751       for (__decltype(__n + 0) __niter = __n;
752            __niter > 0; --__niter, ++__first)
753         *__first = __value;
754       return __first;
755     }
756
757   template<typename _OutputIterator, typename _Size, typename _Tp>
758     inline typename
759     __gnu_cxx::__enable_if<__is_scalar<_Tp>::__value, _OutputIterator>::__type
760     __fill_n_a(_OutputIterator __first, _Size __n, const _Tp& __value)
761     {
762       const _Tp __tmp = __value;
763       for (__decltype(__n + 0) __niter = __n;
764            __niter > 0; --__niter, ++__first)
765         *__first = __tmp;
766       return __first;
767     }
768
769   template<typename _Size, typename _Tp>
770     inline typename
771     __gnu_cxx::__enable_if<__is_byte<_Tp>::__value, _Tp*>::__type
772     __fill_n_a(_Tp* __first, _Size __n, const _Tp& __c)
773     {
774       std::__fill_a(__first, __first + __n, __c);
775       return __first + __n;
776     }
777
778   /**
779    *  @brief Fills the range [first,first+n) with copies of value.
780    *  @ingroup mutating_algorithms
781    *  @param  first  An output iterator.
782    *  @param  n      The count of copies to perform.
783    *  @param  value  A reference-to-const of arbitrary type.
784    *  @return   The iterator at first+n.
785    *
786    *  This function fills a range with copies of the same value.  For char
787    *  types filling contiguous areas of memory, this becomes an inline call
788    *  to @c memset or @ wmemset.
789    *
790    *  _GLIBCXX_RESOLVE_LIB_DEFECTS
791    *  DR 865. More algorithms that throw away information
792   */
793   template<typename _OI, typename _Size, typename _Tp>
794     inline _OI
795     fill_n(_OI __first, _Size __n, const _Tp& __value)
796     {
797       // concept requirements
798       __glibcxx_function_requires(_OutputIteratorConcept<_OI, _Tp>)
799
800       return _OI(std::__fill_n_a(std::__niter_base(__first), __n, __value));
801     }
802
803   template<bool _BoolType>
804     struct __equal
805     {
806       template<typename _II1, typename _II2>
807         static bool
808         equal(_II1 __first1, _II1 __last1, _II2 __first2)
809         {
810           for (; __first1 != __last1; ++__first1, ++__first2)
811             if (!(*__first1 == *__first2))
812               return false;
813           return true;
814         }
815     };
816
817   template<>
818     struct __equal<true>
819     {
820       template<typename _Tp>
821         static bool
822         equal(const _Tp* __first1, const _Tp* __last1, const _Tp* __first2)
823         {
824           return !__builtin_memcmp(__first1, __first2, sizeof(_Tp)
825                                    * (__last1 - __first1));
826         }
827     };
828
829   template<typename _II1, typename _II2>
830     inline bool
831     __equal_aux(_II1 __first1, _II1 __last1, _II2 __first2)
832     {
833       typedef typename iterator_traits<_II1>::value_type _ValueType1;
834       typedef typename iterator_traits<_II2>::value_type _ValueType2;
835       const bool __simple = (__is_integer<_ValueType1>::__value
836                              && __is_pointer<_II1>::__value
837                              && __is_pointer<_II2>::__value
838                              && __are_same<_ValueType1, _ValueType2>::__value);
839
840       return std::__equal<__simple>::equal(__first1, __last1, __first2);
841     }
842
843
844   template<typename, typename>
845     struct __lc_rai
846     {
847       template<typename _II1, typename _II2>
848         static _II1
849         __newlast1(_II1, _II1 __last1, _II2, _II2)
850         { return __last1; }
851
852       template<typename _II>
853         static bool
854         __cnd2(_II __first, _II __last)
855         { return __first != __last; }
856     };
857
858   template<>
859     struct __lc_rai<random_access_iterator_tag, random_access_iterator_tag>
860     {
861       template<typename _RAI1, typename _RAI2>
862         static _RAI1
863         __newlast1(_RAI1 __first1, _RAI1 __last1,
864                    _RAI2 __first2, _RAI2 __last2)
865         {
866           const typename iterator_traits<_RAI1>::difference_type
867             __diff1 = __last1 - __first1;
868           const typename iterator_traits<_RAI2>::difference_type
869             __diff2 = __last2 - __first2;
870           return __diff2 < __diff1 ? __first1 + __diff2 : __last1;
871         }
872
873       template<typename _RAI>
874         static bool
875         __cnd2(_RAI, _RAI)
876         { return true; }
877     };
878
879   template<bool _BoolType>
880     struct __lexicographical_compare
881     {
882       template<typename _II1, typename _II2>
883         static bool __lc(_II1, _II1, _II2, _II2);
884     };
885
886   template<bool _BoolType>
887     template<typename _II1, typename _II2>
888       bool
889       __lexicographical_compare<_BoolType>::
890       __lc(_II1 __first1, _II1 __last1, _II2 __first2, _II2 __last2)
891       {
892         typedef typename iterator_traits<_II1>::iterator_category _Category1;
893         typedef typename iterator_traits<_II2>::iterator_category _Category2;
894         typedef std::__lc_rai<_Category1, _Category2>   __rai_type;
895         
896         __last1 = __rai_type::__newlast1(__first1, __last1,
897                                          __first2, __last2);
898         for (; __first1 != __last1 && __rai_type::__cnd2(__first2, __last2);
899              ++__first1, ++__first2)
900           {
901             if (*__first1 < *__first2)
902               return true;
903             if (*__first2 < *__first1)
904               return false;
905           }
906         return __first1 == __last1 && __first2 != __last2;
907       }
908
909   template<>
910     struct __lexicographical_compare<true>
911     {
912       template<typename _Tp, typename _Up>
913         static bool
914         __lc(const _Tp* __first1, const _Tp* __last1,
915              const _Up* __first2, const _Up* __last2)
916         {
917           const size_t __len1 = __last1 - __first1;
918           const size_t __len2 = __last2 - __first2;
919           const int __result = __builtin_memcmp(__first1, __first2,
920                                                 std::min(__len1, __len2));
921           return __result != 0 ? __result < 0 : __len1 < __len2;
922         }
923     };
924
925   template<typename _II1, typename _II2>
926     inline bool
927     __lexicographical_compare_aux(_II1 __first1, _II1 __last1,
928                                   _II2 __first2, _II2 __last2)
929     {
930       typedef typename iterator_traits<_II1>::value_type _ValueType1;
931       typedef typename iterator_traits<_II2>::value_type _ValueType2;
932       const bool __simple =
933         (__is_byte<_ValueType1>::__value && __is_byte<_ValueType2>::__value
934          && !__gnu_cxx::__numeric_traits<_ValueType1>::__is_signed
935          && !__gnu_cxx::__numeric_traits<_ValueType2>::__is_signed
936          && __is_pointer<_II1>::__value
937          && __is_pointer<_II2>::__value);
938
939       return std::__lexicographical_compare<__simple>::__lc(__first1, __last1,
940                                                             __first2, __last2);
941     }
942
943   /**
944    *  @brief Finds the first position in which @a val could be inserted
945    *         without changing the ordering.
946    *  @param  first   An iterator.
947    *  @param  last    Another iterator.
948    *  @param  val     The search term.
949    *  @return         An iterator pointing to the first element <em>not less
950    *                  than</em> @a val, or end() if every element is less than 
951    *                  @a val.
952    *  @ingroup binary_search_algorithms
953   */
954   template<typename _ForwardIterator, typename _Tp>
955     _ForwardIterator
956     lower_bound(_ForwardIterator __first, _ForwardIterator __last,
957                 const _Tp& __val)
958     {
959       typedef typename iterator_traits<_ForwardIterator>::value_type
960         _ValueType;
961       typedef typename iterator_traits<_ForwardIterator>::difference_type
962         _DistanceType;
963
964       // concept requirements
965       __glibcxx_function_requires(_ForwardIteratorConcept<_ForwardIterator>)
966       __glibcxx_function_requires(_LessThanOpConcept<_ValueType, _Tp>)
967       __glibcxx_requires_partitioned_lower(__first, __last, __val);
968
969       _DistanceType __len = std::distance(__first, __last);
970       _DistanceType __half;
971       _ForwardIterator __middle;
972
973       while (__len > 0)
974         {
975           __half = __len >> 1;
976           __middle = __first;
977           std::advance(__middle, __half);
978           if (*__middle < __val)
979             {
980               __first = __middle;
981               ++__first;
982               __len = __len - __half - 1;
983             }
984           else
985             __len = __half;
986         }
987       return __first;
988     }
989
990   /// This is a helper function for the sort routines and for random.tcc.
991   //  Precondition: __n > 0.
992   template<typename _Size>
993     inline _Size
994     __lg(_Size __n)
995     {
996       _Size __k;
997       for (__k = 0; __n != 0; __n >>= 1)
998         ++__k;
999       return __k - 1;
1000     }
1001
1002   inline int
1003   __lg(int __n)
1004   { return sizeof(int) * __CHAR_BIT__  - 1 - __builtin_clz(__n); }
1005
1006   inline long
1007   __lg(long __n)
1008   { return sizeof(long) * __CHAR_BIT__ - 1 - __builtin_clzl(__n); }
1009
1010   inline long long
1011   __lg(long long __n)
1012   { return sizeof(long long) * __CHAR_BIT__ - 1 - __builtin_clzll(__n); }
1013
1014 _GLIBCXX_END_NAMESPACE
1015
1016 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_P)
1017
1018   /**
1019    *  @brief Tests a range for element-wise equality.
1020    *  @ingroup non_mutating_algorithms
1021    *  @param  first1  An input iterator.
1022    *  @param  last1   An input iterator.
1023    *  @param  first2  An input iterator.
1024    *  @return   A boolean true or false.
1025    *
1026    *  This compares the elements of two ranges using @c == and returns true or
1027    *  false depending on whether all of the corresponding elements of the
1028    *  ranges are equal.
1029   */
1030   template<typename _II1, typename _II2>
1031     inline bool
1032     equal(_II1 __first1, _II1 __last1, _II2 __first2)
1033     {
1034       // concept requirements
1035       __glibcxx_function_requires(_InputIteratorConcept<_II1>)
1036       __glibcxx_function_requires(_InputIteratorConcept<_II2>)
1037       __glibcxx_function_requires(_EqualOpConcept<
1038             typename iterator_traits<_II1>::value_type,
1039             typename iterator_traits<_II2>::value_type>)
1040       __glibcxx_requires_valid_range(__first1, __last1);
1041
1042       return std::__equal_aux(std::__niter_base(__first1),
1043                               std::__niter_base(__last1),
1044                               std::__niter_base(__first2));
1045     }
1046
1047   /**
1048    *  @brief Tests a range for element-wise equality.
1049    *  @ingroup non_mutating_algorithms
1050    *  @param  first1  An input iterator.
1051    *  @param  last1   An input iterator.
1052    *  @param  first2  An input iterator.
1053    *  @param binary_pred A binary predicate @link functors
1054    *                  functor@endlink.
1055    *  @return         A boolean true or false.
1056    *
1057    *  This compares the elements of two ranges using the binary_pred
1058    *  parameter, and returns true or
1059    *  false depending on whether all of the corresponding elements of the
1060    *  ranges are equal.
1061   */
1062   template<typename _IIter1, typename _IIter2, typename _BinaryPredicate>
1063     inline bool
1064     equal(_IIter1 __first1, _IIter1 __last1,
1065           _IIter2 __first2, _BinaryPredicate __binary_pred)
1066     {
1067       // concept requirements
1068       __glibcxx_function_requires(_InputIteratorConcept<_IIter1>)
1069       __glibcxx_function_requires(_InputIteratorConcept<_IIter2>)
1070       __glibcxx_requires_valid_range(__first1, __last1);
1071
1072       for (; __first1 != __last1; ++__first1, ++__first2)
1073         if (!bool(__binary_pred(*__first1, *__first2)))
1074           return false;
1075       return true;
1076     }
1077
1078   /**
1079    *  @brief Performs @b dictionary comparison on ranges.
1080    *  @ingroup sorting_algorithms
1081    *  @param  first1  An input iterator.
1082    *  @param  last1   An input iterator.
1083    *  @param  first2  An input iterator.
1084    *  @param  last2   An input iterator.
1085    *  @return   A boolean true or false.
1086    *
1087    *  <em>Returns true if the sequence of elements defined by the range
1088    *  [first1,last1) is lexicographically less than the sequence of elements
1089    *  defined by the range [first2,last2).  Returns false otherwise.</em>
1090    *  (Quoted from [25.3.8]/1.)  If the iterators are all character pointers,
1091    *  then this is an inline call to @c memcmp.
1092   */
1093   template<typename _II1, typename _II2>
1094     inline bool
1095     lexicographical_compare(_II1 __first1, _II1 __last1,
1096                             _II2 __first2, _II2 __last2)
1097     {
1098       // concept requirements
1099       typedef typename iterator_traits<_II1>::value_type _ValueType1;
1100       typedef typename iterator_traits<_II2>::value_type _ValueType2;
1101       __glibcxx_function_requires(_InputIteratorConcept<_II1>)
1102       __glibcxx_function_requires(_InputIteratorConcept<_II2>)
1103       __glibcxx_function_requires(_LessThanOpConcept<_ValueType1, _ValueType2>)
1104       __glibcxx_function_requires(_LessThanOpConcept<_ValueType2, _ValueType1>)
1105       __glibcxx_requires_valid_range(__first1, __last1);
1106       __glibcxx_requires_valid_range(__first2, __last2);
1107
1108       return std::__lexicographical_compare_aux(std::__niter_base(__first1),
1109                                                 std::__niter_base(__last1),
1110                                                 std::__niter_base(__first2),
1111                                                 std::__niter_base(__last2));
1112     }
1113
1114   /**
1115    *  @brief Performs @b dictionary comparison on ranges.
1116    *  @ingroup sorting_algorithms
1117    *  @param  first1  An input iterator.
1118    *  @param  last1   An input iterator.
1119    *  @param  first2  An input iterator.
1120    *  @param  last2   An input iterator.
1121    *  @param  comp  A @link comparison_functors comparison functor@endlink.
1122    *  @return   A boolean true or false.
1123    *
1124    *  The same as the four-parameter @c lexicographical_compare, but uses the
1125    *  comp parameter instead of @c <.
1126   */
1127   template<typename _II1, typename _II2, typename _Compare>
1128     bool
1129     lexicographical_compare(_II1 __first1, _II1 __last1,
1130                             _II2 __first2, _II2 __last2, _Compare __comp)
1131     {
1132       typedef typename iterator_traits<_II1>::iterator_category _Category1;
1133       typedef typename iterator_traits<_II2>::iterator_category _Category2;
1134       typedef std::__lc_rai<_Category1, _Category2>     __rai_type;
1135
1136       // concept requirements
1137       __glibcxx_function_requires(_InputIteratorConcept<_II1>)
1138       __glibcxx_function_requires(_InputIteratorConcept<_II2>)
1139       __glibcxx_requires_valid_range(__first1, __last1);
1140       __glibcxx_requires_valid_range(__first2, __last2);
1141
1142       __last1 = __rai_type::__newlast1(__first1, __last1, __first2, __last2);
1143       for (; __first1 != __last1 && __rai_type::__cnd2(__first2, __last2);
1144            ++__first1, ++__first2)
1145         {
1146           if (__comp(*__first1, *__first2))
1147             return true;
1148           if (__comp(*__first2, *__first1))
1149             return false;
1150         }
1151       return __first1 == __last1 && __first2 != __last2;
1152     }
1153
1154   /**
1155    *  @brief Finds the places in ranges which don't match.
1156    *  @ingroup non_mutating_algorithms
1157    *  @param  first1  An input iterator.
1158    *  @param  last1   An input iterator.
1159    *  @param  first2  An input iterator.
1160    *  @return   A pair of iterators pointing to the first mismatch.
1161    *
1162    *  This compares the elements of two ranges using @c == and returns a pair
1163    *  of iterators.  The first iterator points into the first range, the
1164    *  second iterator points into the second range, and the elements pointed
1165    *  to by the iterators are not equal.
1166   */
1167   template<typename _InputIterator1, typename _InputIterator2>
1168     pair<_InputIterator1, _InputIterator2>
1169     mismatch(_InputIterator1 __first1, _InputIterator1 __last1,
1170              _InputIterator2 __first2)
1171     {
1172       // concept requirements
1173       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
1174       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
1175       __glibcxx_function_requires(_EqualOpConcept<
1176             typename iterator_traits<_InputIterator1>::value_type,
1177             typename iterator_traits<_InputIterator2>::value_type>)
1178       __glibcxx_requires_valid_range(__first1, __last1);
1179
1180       while (__first1 != __last1 && *__first1 == *__first2)
1181         {
1182           ++__first1;
1183           ++__first2;
1184         }
1185       return pair<_InputIterator1, _InputIterator2>(__first1, __first2);
1186     }
1187
1188   /**
1189    *  @brief Finds the places in ranges which don't match.
1190    *  @ingroup non_mutating_algorithms
1191    *  @param  first1  An input iterator.
1192    *  @param  last1   An input iterator.
1193    *  @param  first2  An input iterator.
1194    *  @param binary_pred A binary predicate @link functors
1195    *         functor@endlink.
1196    *  @return   A pair of iterators pointing to the first mismatch.
1197    *
1198    *  This compares the elements of two ranges using the binary_pred
1199    *  parameter, and returns a pair
1200    *  of iterators.  The first iterator points into the first range, the
1201    *  second iterator points into the second range, and the elements pointed
1202    *  to by the iterators are not equal.
1203   */
1204   template<typename _InputIterator1, typename _InputIterator2,
1205            typename _BinaryPredicate>
1206     pair<_InputIterator1, _InputIterator2>
1207     mismatch(_InputIterator1 __first1, _InputIterator1 __last1,
1208              _InputIterator2 __first2, _BinaryPredicate __binary_pred)
1209     {
1210       // concept requirements
1211       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator1>)
1212       __glibcxx_function_requires(_InputIteratorConcept<_InputIterator2>)
1213       __glibcxx_requires_valid_range(__first1, __last1);
1214
1215       while (__first1 != __last1 && bool(__binary_pred(*__first1, *__first2)))
1216         {
1217           ++__first1;
1218           ++__first2;
1219         }
1220       return pair<_InputIterator1, _InputIterator2>(__first1, __first2);
1221     }
1222
1223 _GLIBCXX_END_NESTED_NAMESPACE
1224
1225 // NB: This file is included within many other C++ includes, as a way
1226 // of getting the base algorithms. So, make sure that parallel bits
1227 // come in too if requested. 
1228 #ifdef _GLIBCXX_PARALLEL
1229 # include <parallel/algobase.h>
1230 #endif
1231
1232 #endif