1 // <algorithm> Forward declarations -*- C++ -*-
3 // Copyright (C) 2007-2015 Free Software Foundation, Inc.
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 3, or (at your option)
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.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file bits/algorithmfwd.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{algorithm}
30 #ifndef _GLIBCXX_ALGORITHMFWD_H
31 #define _GLIBCXX_ALGORITHMFWD_H 1
33 #pragma GCC system_header
35 #include <bits/c++config.h>
36 #include <bits/stl_pair.h>
37 #include <bits/stl_iterator_base_types.h>
38 #if __cplusplus >= 201103L
39 #include <initializer_list>
42 namespace std _GLIBCXX_VISIBILITY(default)
44 _GLIBCXX_BEGIN_NAMESPACE_VERSION
73 is_partitioned (C++0x)
75 is_sorted_until (C++0x)
77 lexicographical_compare
86 minmax_element (C++0x)
94 partition_copy (C++0x)
95 partition_point (C++0x)
116 set_symmetric_difference
132 * @defgroup algorithms Algorithms
134 * Components for performing algorithmic operations. Includes
135 * non-modifying sequence, modifying (mutating) sequence, sorting,
136 * searching, merge, partition, heap, set, minima, maxima, and
137 * permutation operations.
141 * @defgroup mutating_algorithms Mutating
142 * @ingroup algorithms
146 * @defgroup non_mutating_algorithms Non-Mutating
147 * @ingroup algorithms
151 * @defgroup sorting_algorithms Sorting
152 * @ingroup algorithms
156 * @defgroup set_algorithms Set Operation
157 * @ingroup sorting_algorithms
159 * These algorithms are common set operations performed on sequences
160 * that are already sorted. The number of comparisons will be
165 * @defgroup binary_search_algorithms Binary Search
166 * @ingroup sorting_algorithms
168 * These algorithms are variations of a classic binary search, and
169 * all assume that the sequence being searched is already sorted.
171 * The number of comparisons will be logarithmic (and as few as
172 * possible). The number of steps through the sequence will be
173 * logarithmic for random-access iterators (e.g., pointers), and
176 * The LWG has passed Defect Report 270, which notes: <em>The
177 * proposed resolution reinterprets binary search. Instead of
178 * thinking about searching for a value in a sorted range, we view
179 * that as an important special case of a more general algorithm:
180 * searching for the partition point in a partitioned range. We
181 * also add a guarantee that the old wording did not: we ensure that
182 * the upper bound is no earlier than the lower bound, that the pair
183 * returned by equal_range is a valid range, and that the first part
184 * of that pair is the lower bound.</em>
186 * The actual effect of the first sentence is that a comparison
187 * functor passed by the user doesn't necessarily need to induce a
188 * strict weak ordering relation. Rather, it partitions the range.
193 #if __cplusplus >= 201103L
194 template<typename _IIter, typename _Predicate>
196 all_of(_IIter, _IIter, _Predicate);
198 template<typename _IIter, typename _Predicate>
200 any_of(_IIter, _IIter, _Predicate);
203 template<typename _FIter, typename _Tp>
205 binary_search(_FIter, _FIter, const _Tp&);
207 template<typename _FIter, typename _Tp, typename _Compare>
209 binary_search(_FIter, _FIter, const _Tp&, _Compare);
211 template<typename _IIter, typename _OIter>
213 copy(_IIter, _IIter, _OIter);
215 template<typename _BIter1, typename _BIter2>
217 copy_backward(_BIter1, _BIter1, _BIter2);
219 #if __cplusplus >= 201103L
220 template<typename _IIter, typename _OIter, typename _Predicate>
222 copy_if(_IIter, _IIter, _OIter, _Predicate);
224 template<typename _IIter, typename _Size, typename _OIter>
226 copy_n(_IIter, _Size, _OIter);
232 template<typename _FIter, typename _Tp>
234 equal_range(_FIter, _FIter, const _Tp&);
236 template<typename _FIter, typename _Tp, typename _Compare>
238 equal_range(_FIter, _FIter, const _Tp&, _Compare);
240 template<typename _FIter, typename _Tp>
242 fill(_FIter, _FIter, const _Tp&);
244 template<typename _OIter, typename _Size, typename _Tp>
246 fill_n(_OIter, _Size, const _Tp&);
250 template<typename _FIter1, typename _FIter2>
252 find_end(_FIter1, _FIter1, _FIter2, _FIter2);
254 template<typename _FIter1, typename _FIter2, typename _BinaryPredicate>
256 find_end(_FIter1, _FIter1, _FIter2, _FIter2, _BinaryPredicate);
261 #if __cplusplus >= 201103L
262 template<typename _IIter, typename _Predicate>
264 find_if_not(_IIter, _IIter, _Predicate);
271 template<typename _IIter1, typename _IIter2>
273 includes(_IIter1, _IIter1, _IIter2, _IIter2);
275 template<typename _IIter1, typename _IIter2, typename _Compare>
277 includes(_IIter1, _IIter1, _IIter2, _IIter2, _Compare);
279 template<typename _BIter>
281 inplace_merge(_BIter, _BIter, _BIter);
283 template<typename _BIter, typename _Compare>
285 inplace_merge(_BIter, _BIter, _BIter, _Compare);
287 #if __cplusplus >= 201103L
288 template<typename _RAIter>
290 is_heap(_RAIter, _RAIter);
292 template<typename _RAIter, typename _Compare>
294 is_heap(_RAIter, _RAIter, _Compare);
296 template<typename _RAIter>
298 is_heap_until(_RAIter, _RAIter);
300 template<typename _RAIter, typename _Compare>
302 is_heap_until(_RAIter, _RAIter, _Compare);
304 template<typename _IIter, typename _Predicate>
306 is_partitioned(_IIter, _IIter, _Predicate);
308 template<typename _FIter1, typename _FIter2>
310 is_permutation(_FIter1, _FIter1, _FIter2);
312 template<typename _FIter1, typename _FIter2,
313 typename _BinaryPredicate>
315 is_permutation(_FIter1, _FIter1, _FIter2, _BinaryPredicate);
317 template<typename _FIter>
319 is_sorted(_FIter, _FIter);
321 template<typename _FIter, typename _Compare>
323 is_sorted(_FIter, _FIter, _Compare);
325 template<typename _FIter>
327 is_sorted_until(_FIter, _FIter);
329 template<typename _FIter, typename _Compare>
331 is_sorted_until(_FIter, _FIter, _Compare);
334 template<typename _FIter1, typename _FIter2>
336 iter_swap(_FIter1, _FIter2);
338 template<typename _FIter, typename _Tp>
340 lower_bound(_FIter, _FIter, const _Tp&);
342 template<typename _FIter, typename _Tp, typename _Compare>
344 lower_bound(_FIter, _FIter, const _Tp&, _Compare);
346 template<typename _RAIter>
348 make_heap(_RAIter, _RAIter);
350 template<typename _RAIter, typename _Compare>
352 make_heap(_RAIter, _RAIter, _Compare);
354 template<typename _Tp>
357 max(const _Tp&, const _Tp&);
359 template<typename _Tp, typename _Compare>
362 max(const _Tp&, const _Tp&, _Compare);
367 template<typename _Tp>
370 min(const _Tp&, const _Tp&);
372 template<typename _Tp, typename _Compare>
375 min(const _Tp&, const _Tp&, _Compare);
379 #if __cplusplus >= 201103L
380 template<typename _Tp>
382 pair<const _Tp&, const _Tp&>
383 minmax(const _Tp&, const _Tp&);
385 template<typename _Tp, typename _Compare>
387 pair<const _Tp&, const _Tp&>
388 minmax(const _Tp&, const _Tp&, _Compare);
390 template<typename _FIter>
393 minmax_element(_FIter, _FIter);
395 template<typename _FIter, typename _Compare>
398 minmax_element(_FIter, _FIter, _Compare);
400 template<typename _Tp>
403 min(initializer_list<_Tp>);
405 template<typename _Tp, typename _Compare>
408 min(initializer_list<_Tp>, _Compare);
410 template<typename _Tp>
413 max(initializer_list<_Tp>);
415 template<typename _Tp, typename _Compare>
418 max(initializer_list<_Tp>, _Compare);
420 template<typename _Tp>
423 minmax(initializer_list<_Tp>);
425 template<typename _Tp, typename _Compare>
428 minmax(initializer_list<_Tp>, _Compare);
433 template<typename _BIter>
435 next_permutation(_BIter, _BIter);
437 template<typename _BIter, typename _Compare>
439 next_permutation(_BIter, _BIter, _Compare);
441 #if __cplusplus >= 201103L
442 template<typename _IIter, typename _Predicate>
444 none_of(_IIter, _IIter, _Predicate);
450 template<typename _IIter, typename _RAIter>
452 partial_sort_copy(_IIter, _IIter, _RAIter, _RAIter);
454 template<typename _IIter, typename _RAIter, typename _Compare>
456 partial_sort_copy(_IIter, _IIter, _RAIter, _RAIter, _Compare);
460 #if __cplusplus >= 201103L
461 template<typename _IIter, typename _OIter1,
462 typename _OIter2, typename _Predicate>
463 pair<_OIter1, _OIter2>
464 partition_copy(_IIter, _IIter, _OIter1, _OIter2, _Predicate);
466 template<typename _FIter, typename _Predicate>
468 partition_point(_FIter, _FIter, _Predicate);
471 template<typename _RAIter>
473 pop_heap(_RAIter, _RAIter);
475 template<typename _RAIter, typename _Compare>
477 pop_heap(_RAIter, _RAIter, _Compare);
479 template<typename _BIter>
481 prev_permutation(_BIter, _BIter);
483 template<typename _BIter, typename _Compare>
485 prev_permutation(_BIter, _BIter, _Compare);
487 template<typename _RAIter>
489 push_heap(_RAIter, _RAIter);
491 template<typename _RAIter, typename _Compare>
493 push_heap(_RAIter, _RAIter, _Compare);
497 template<typename _FIter, typename _Tp>
499 remove(_FIter, _FIter, const _Tp&);
501 template<typename _FIter, typename _Predicate>
503 remove_if(_FIter, _FIter, _Predicate);
505 template<typename _IIter, typename _OIter, typename _Tp>
507 remove_copy(_IIter, _IIter, _OIter, const _Tp&);
509 template<typename _IIter, typename _OIter, typename _Predicate>
511 remove_copy_if(_IIter, _IIter, _OIter, _Predicate);
515 template<typename _IIter, typename _OIter, typename _Tp>
517 replace_copy(_IIter, _IIter, _OIter, const _Tp&, const _Tp&);
519 template<typename _Iter, typename _OIter, typename _Predicate, typename _Tp>
521 replace_copy_if(_Iter, _Iter, _OIter, _Predicate, const _Tp&);
525 template<typename _BIter>
527 reverse(_BIter, _BIter);
529 template<typename _BIter, typename _OIter>
531 reverse_copy(_BIter, _BIter, _OIter);
533 template<typename _FIter>
535 rotate(_FIter, _FIter, _FIter);
537 template<typename _FIter, typename _OIter>
539 rotate_copy(_FIter, _FIter, _FIter, _OIter);
545 // set_symmetric_difference
548 #if (__cplusplus >= 201103L) && defined(_GLIBCXX_USE_C99_STDINT_TR1)
549 template<typename _RAIter, typename _UGenerator>
551 shuffle(_RAIter, _RAIter, _UGenerator&&);
554 template<typename _RAIter>
556 sort_heap(_RAIter, _RAIter);
558 template<typename _RAIter, typename _Compare>
560 sort_heap(_RAIter, _RAIter, _Compare);
562 template<typename _BIter, typename _Predicate>
564 stable_partition(_BIter, _BIter, _Predicate);
566 template<typename _Tp>
569 #if __cplusplus >= 201103L
570 noexcept(__and_<is_nothrow_move_constructible<_Tp>,
571 is_nothrow_move_assignable<_Tp>>::value)
575 template<typename _Tp, size_t _Nm>
577 swap(_Tp (&__a)[_Nm], _Tp (&__b)[_Nm])
578 #if __cplusplus >= 201103L
579 noexcept(noexcept(swap(*__a, *__b)))
583 template<typename _FIter1, typename _FIter2>
585 swap_ranges(_FIter1, _FIter1, _FIter2);
589 template<typename _FIter>
591 unique(_FIter, _FIter);
593 template<typename _FIter, typename _BinaryPredicate>
595 unique(_FIter, _FIter, _BinaryPredicate);
599 template<typename _FIter, typename _Tp>
601 upper_bound(_FIter, _FIter, const _Tp&);
603 template<typename _FIter, typename _Tp, typename _Compare>
605 upper_bound(_FIter, _FIter, const _Tp&, _Compare);
607 _GLIBCXX_END_NAMESPACE_VERSION
609 _GLIBCXX_BEGIN_NAMESPACE_ALGO
611 template<typename _FIter>
613 adjacent_find(_FIter, _FIter);
615 template<typename _FIter, typename _BinaryPredicate>
617 adjacent_find(_FIter, _FIter, _BinaryPredicate);
619 template<typename _IIter, typename _Tp>
620 typename iterator_traits<_IIter>::difference_type
621 count(_IIter, _IIter, const _Tp&);
623 template<typename _IIter, typename _Predicate>
624 typename iterator_traits<_IIter>::difference_type
625 count_if(_IIter, _IIter, _Predicate);
627 template<typename _IIter1, typename _IIter2>
629 equal(_IIter1, _IIter1, _IIter2);
631 template<typename _IIter1, typename _IIter2, typename _BinaryPredicate>
633 equal(_IIter1, _IIter1, _IIter2, _BinaryPredicate);
635 template<typename _IIter, typename _Tp>
637 find(_IIter, _IIter, const _Tp&);
639 template<typename _FIter1, typename _FIter2>
641 find_first_of(_FIter1, _FIter1, _FIter2, _FIter2);
643 template<typename _FIter1, typename _FIter2, typename _BinaryPredicate>
645 find_first_of(_FIter1, _FIter1, _FIter2, _FIter2, _BinaryPredicate);
647 template<typename _IIter, typename _Predicate>
649 find_if(_IIter, _IIter, _Predicate);
651 template<typename _IIter, typename _Funct>
653 for_each(_IIter, _IIter, _Funct);
655 template<typename _FIter, typename _Generator>
657 generate(_FIter, _FIter, _Generator);
659 template<typename _OIter, typename _Size, typename _Generator>
661 generate_n(_OIter, _Size, _Generator);
663 template<typename _IIter1, typename _IIter2>
665 lexicographical_compare(_IIter1, _IIter1, _IIter2, _IIter2);
667 template<typename _IIter1, typename _IIter2, typename _Compare>
669 lexicographical_compare(_IIter1, _IIter1, _IIter2, _IIter2, _Compare);
671 template<typename _FIter>
674 max_element(_FIter, _FIter);
676 template<typename _FIter, typename _Compare>
679 max_element(_FIter, _FIter, _Compare);
681 template<typename _IIter1, typename _IIter2, typename _OIter>
683 merge(_IIter1, _IIter1, _IIter2, _IIter2, _OIter);
685 template<typename _IIter1, typename _IIter2, typename _OIter,
688 merge(_IIter1, _IIter1, _IIter2, _IIter2, _OIter, _Compare);
690 template<typename _FIter>
693 min_element(_FIter, _FIter);
695 template<typename _FIter, typename _Compare>
698 min_element(_FIter, _FIter, _Compare);
700 template<typename _IIter1, typename _IIter2>
701 pair<_IIter1, _IIter2>
702 mismatch(_IIter1, _IIter1, _IIter2);
704 template<typename _IIter1, typename _IIter2, typename _BinaryPredicate>
705 pair<_IIter1, _IIter2>
706 mismatch(_IIter1, _IIter1, _IIter2, _BinaryPredicate);
708 template<typename _RAIter>
710 nth_element(_RAIter, _RAIter, _RAIter);
712 template<typename _RAIter, typename _Compare>
714 nth_element(_RAIter, _RAIter, _RAIter, _Compare);
716 template<typename _RAIter>
718 partial_sort(_RAIter, _RAIter, _RAIter);
720 template<typename _RAIter, typename _Compare>
722 partial_sort(_RAIter, _RAIter, _RAIter, _Compare);
724 template<typename _BIter, typename _Predicate>
726 partition(_BIter, _BIter, _Predicate);
728 template<typename _RAIter>
730 random_shuffle(_RAIter, _RAIter);
732 template<typename _RAIter, typename _Generator>
734 random_shuffle(_RAIter, _RAIter,
735 #if __cplusplus >= 201103L
741 template<typename _FIter, typename _Tp>
743 replace(_FIter, _FIter, const _Tp&, const _Tp&);
745 template<typename _FIter, typename _Predicate, typename _Tp>
747 replace_if(_FIter, _FIter, _Predicate, const _Tp&);
749 template<typename _FIter1, typename _FIter2>
751 search(_FIter1, _FIter1, _FIter2, _FIter2);
753 template<typename _FIter1, typename _FIter2, typename _BinaryPredicate>
755 search(_FIter1, _FIter1, _FIter2, _FIter2, _BinaryPredicate);
757 template<typename _FIter, typename _Size, typename _Tp>
759 search_n(_FIter, _FIter, _Size, const _Tp&);
761 template<typename _FIter, typename _Size, typename _Tp,
762 typename _BinaryPredicate>
764 search_n(_FIter, _FIter, _Size, const _Tp&, _BinaryPredicate);
766 template<typename _IIter1, typename _IIter2, typename _OIter>
768 set_difference(_IIter1, _IIter1, _IIter2, _IIter2, _OIter);
770 template<typename _IIter1, typename _IIter2, typename _OIter,
773 set_difference(_IIter1, _IIter1, _IIter2, _IIter2, _OIter, _Compare);
775 template<typename _IIter1, typename _IIter2, typename _OIter>
777 set_intersection(_IIter1, _IIter1, _IIter2, _IIter2, _OIter);
779 template<typename _IIter1, typename _IIter2, typename _OIter,
782 set_intersection(_IIter1, _IIter1, _IIter2, _IIter2, _OIter, _Compare);
784 template<typename _IIter1, typename _IIter2, typename _OIter>
786 set_symmetric_difference(_IIter1, _IIter1, _IIter2, _IIter2, _OIter);
788 template<typename _IIter1, typename _IIter2, typename _OIter,
791 set_symmetric_difference(_IIter1, _IIter1, _IIter2, _IIter2,
794 template<typename _IIter1, typename _IIter2, typename _OIter>
796 set_union(_IIter1, _IIter1, _IIter2, _IIter2, _OIter);
798 template<typename _IIter1, typename _IIter2, typename _OIter,
801 set_union(_IIter1, _IIter1, _IIter2, _IIter2, _OIter, _Compare);
803 template<typename _RAIter>
805 sort(_RAIter, _RAIter);
807 template<typename _RAIter, typename _Compare>
809 sort(_RAIter, _RAIter, _Compare);
811 template<typename _RAIter>
813 stable_sort(_RAIter, _RAIter);
815 template<typename _RAIter, typename _Compare>
817 stable_sort(_RAIter, _RAIter, _Compare);
819 template<typename _IIter, typename _OIter, typename _UnaryOperation>
821 transform(_IIter, _IIter, _OIter, _UnaryOperation);
823 template<typename _IIter1, typename _IIter2, typename _OIter,
824 typename _BinaryOperation>
826 transform(_IIter1, _IIter1, _IIter2, _OIter, _BinaryOperation);
828 template<typename _IIter, typename _OIter>
830 unique_copy(_IIter, _IIter, _OIter);
832 template<typename _IIter, typename _OIter, typename _BinaryPredicate>
834 unique_copy(_IIter, _IIter, _OIter, _BinaryPredicate);
836 _GLIBCXX_END_NAMESPACE_ALGO
839 #ifdef _GLIBCXX_PARALLEL
840 # include <parallel/algorithmfwd.h>