1// <functional> -*- C++ -*-
3// Copyright (C) 2001-2025 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/>.
27 * Silicon Graphics Computer Systems, Inc.
29 * Permission to use, copy, modify, distribute and sell this software
30 * and its documentation for any purpose is hereby granted without fee,
31 * provided that the above copyright notice appear in all copies and
32 * that both that copyright notice and this permission notice appear
33 * in supporting documentation. Silicon Graphics makes no
34 * representations about the suitability of this software for any
35 * purpose. It is provided "as is" without express or implied warranty.
39/** @file include/functional
40 * This is a Standard C++ Library header.
43#ifndef _GLIBCXX_FUNCTIONAL
44#define _GLIBCXX_FUNCTIONAL 1
47#pragma GCC system_header
50#include <bits/c++config.h>
51#include <bits/stl_function.h> // std::equal_to, std::unary_function etc.
53#if __cplusplus >= 201103L
55#define __glibcxx_want_boyer_moore_searcher
56#define __glibcxx_want_bind_front
57#define __glibcxx_want_bind_back
58#define __glibcxx_want_constexpr_functional
59#define __glibcxx_want_copyable_function
60#define __glibcxx_want_function_ref
61#define __glibcxx_want_invoke
62#define __glibcxx_want_invoke_r
63#define __glibcxx_want_move_only_function
64#define __glibcxx_want_not_fn
65#define __glibcxx_want_ranges
66#define __glibcxx_want_reference_wrapper
67#define __glibcxx_want_transparent_operators
68#include <bits/version.h>
72#include <bits/functional_hash.h>
73#include <bits/invoke.h>
74#include <bits/refwrap.h> // std::reference_wrapper and _Mem_fn_traits
76# include <bits/std_function.h> // std::function
78#if __cplusplus >= 201703L
80# include <unordered_map>
84# include <bits/stl_algobase.h> // std::search
86#if __cplusplus >= 202002L
87# include <bits/binders.h>
88# include <bits/ranges_cmp.h> // std::identity, ranges::equal_to etc.
91#if __glibcxx_move_only_function || __glibcxx_copyable_function || __glibcxx_function_ref
92# include <bits/funcwrap.h>
97namespace std _GLIBCXX_VISIBILITY(default)
99_GLIBCXX_BEGIN_NAMESPACE_VERSION
101 /** @brief The type of placeholder objects defined by libstdc++.
105 template<int _Num> struct _Placeholder { };
107#ifdef __cpp_lib_invoke // C++ >= 17
109 /** Invoke a callable object.
111 * `std::invoke` takes a callable object as its first argument and calls it
112 * with the remaining arguments. The callable object can be a pointer or
113 * reference to a function, a lambda closure, a class with `operator()`,
114 * or even a pointer-to-member. For a pointer-to-member the first argument
115 * must be a reference or pointer to the object that the pointer-to-member
116 * will be applied to.
120 template<typename _Callable, typename... _Args>
121 inline _GLIBCXX20_CONSTEXPR invoke_result_t<_Callable, _Args...>
122 invoke(_Callable&& __fn, _Args&&... __args)
123 noexcept(is_nothrow_invocable_v<_Callable, _Args...>)
125 return std::__invoke(std::forward<_Callable>(__fn),
126 std::forward<_Args>(__args)...);
130#ifdef __cpp_lib_invoke_r // C++ >= 23
132 /** Invoke a callable object and convert the result to `_Res`.
134 * `std::invoke_r<R>(f, args...)` is equivalent to `std::invoke(f, args...)`
135 * with the result implicitly converted to `R`.
139 template<typename _Res, typename _Callable, typename... _Args>
140 requires is_invocable_r_v<_Res, _Callable, _Args...>
142 invoke_r(_Callable&& __fn, _Args&&... __args)
143 noexcept(is_nothrow_invocable_r_v<_Res, _Callable, _Args...>)
145 return std::__invoke_r<_Res>(std::forward<_Callable>(__fn),
146 std::forward<_Args>(__args)...);
148#endif // __cpp_lib_invoke_r
150 /// @cond undocumented
152#if __cplusplus >= 201103L
153 template<typename _MemFunPtr,
154 bool __is_mem_fn = is_member_function_pointer<_MemFunPtr>::value>
156 : public _Mem_fn_traits<_MemFunPtr>::__maybe_type
158 using _Traits = _Mem_fn_traits<_MemFunPtr>;
160 using _Arity = typename _Traits::__arity;
161 using _Varargs = typename _Traits::__vararg;
163 template<typename _Func, typename... _BoundArgs>
164 friend struct _Bind_check_arity;
170 using result_type = typename _Traits::__result_type;
173 _Mem_fn_base(_MemFunPtr __pmf) noexcept : _M_pmf(__pmf) { }
175 template<typename... _Args>
178 operator()(_Args&&... __args) const
180 std::__invoke(_M_pmf, std::forward<_Args>(__args)...)))
181 -> decltype(std::__invoke(_M_pmf, std::forward<_Args>(__args)...))
182 { return std::__invoke(_M_pmf, std::forward<_Args>(__args)...); }
185 // Partial specialization for member object pointers.
186 template<typename _MemObjPtr>
187 class _Mem_fn_base<_MemObjPtr, false>
189 using _Arity = integral_constant<size_t, 0>;
190 using _Varargs = false_type;
192 template<typename _Func, typename... _BoundArgs>
193 friend struct _Bind_check_arity;
199 _Mem_fn_base(_MemObjPtr __pm) noexcept : _M_pm(__pm) { }
201 template<typename _Tp>
204 operator()(_Tp&& __obj) const
205 noexcept(noexcept(std::__invoke(_M_pm, std::forward<_Tp>(__obj))))
206 -> decltype(std::__invoke(_M_pm, std::forward<_Tp>(__obj)))
207 { return std::__invoke(_M_pm, std::forward<_Tp>(__obj)); }
210 template<typename _MemberPointer>
211 struct _Mem_fn; // undefined
213 template<typename _Res, typename _Class>
214 struct _Mem_fn<_Res _Class::*>
215 : _Mem_fn_base<_Res _Class::*>
217 using _Mem_fn_base<_Res _Class::*>::_Mem_fn_base;
221 // _GLIBCXX_RESOLVE_LIB_DEFECTS
222 // 2048. Unnecessary mem_fn overloads
224 * @brief Returns a function object that forwards to the member pointer
227 * This allows a pointer-to-member to be transformed into a function object
228 * that can be called with an object expression as its first argument.
230 * For a pointer-to-data-member the result must be called with exactly one
231 * argument, the object expression that would be used as the first operand
232 * in a `obj.*memptr` or `objp->*memptr` expression.
234 * For a pointer-to-member-function the result must be called with an object
235 * expression and any additional arguments to pass to the member function,
236 * as in an expression like `(obj.*memfun)(args...)` or
237 * `(objp->*memfun)(args...)`.
239 * The object expression can be a pointer, reference, `reference_wrapper`,
240 * or smart pointer, and the call wrapper will dereference it as needed
241 * to apply the pointer-to-member.
246 template<typename _Tp, typename _Class>
248 inline _Mem_fn<_Tp _Class::*>
249 mem_fn(_Tp _Class::* __pm) noexcept
251 return _Mem_fn<_Tp _Class::*>(__pm);
255 * @brief Trait that identifies a bind expression.
257 * Determines if the given type `_Tp` is a function object that
258 * should be treated as a subexpression when evaluating calls to
259 * function objects returned by `std::bind`.
261 * C++11 [func.bind.isbind].
265 template<typename _Tp>
266 struct is_bind_expression
267 : public false_type { };
270 * @brief Determines if the given type _Tp is a placeholder in a
271 * bind() expression and, if so, which placeholder it is.
273 * C++11 [func.bind.isplace].
277 template<typename _Tp>
278 struct is_placeholder
279 : public integral_constant<int, 0>
282#if __cplusplus > 201402L
283 template <typename _Tp> inline constexpr bool is_bind_expression_v
284 = is_bind_expression<_Tp>::value;
285 template <typename _Tp> inline constexpr int is_placeholder_v
286 = is_placeholder<_Tp>::value;
289 /** @namespace std::placeholders
290 * @brief ISO C++ 2011 namespace for std::bind placeholders.
294 namespace placeholders
296 /* Define a large number of placeholders. There is no way to
297 * simplify this with variadic templates, because we're introducing
298 * unique names for each.
300#if __cpp_inline_variables
301# define _GLIBCXX_PLACEHOLDER inline
303# define _GLIBCXX_PLACEHOLDER extern
306 _GLIBCXX_PLACEHOLDER const _Placeholder<1> _1;
307 _GLIBCXX_PLACEHOLDER const _Placeholder<2> _2;
308 _GLIBCXX_PLACEHOLDER const _Placeholder<3> _3;
309 _GLIBCXX_PLACEHOLDER const _Placeholder<4> _4;
310 _GLIBCXX_PLACEHOLDER const _Placeholder<5> _5;
311 _GLIBCXX_PLACEHOLDER const _Placeholder<6> _6;
312 _GLIBCXX_PLACEHOLDER const _Placeholder<7> _7;
313 _GLIBCXX_PLACEHOLDER const _Placeholder<8> _8;
314 _GLIBCXX_PLACEHOLDER const _Placeholder<9> _9;
315 _GLIBCXX_PLACEHOLDER const _Placeholder<10> _10;
316 _GLIBCXX_PLACEHOLDER const _Placeholder<11> _11;
317 _GLIBCXX_PLACEHOLDER const _Placeholder<12> _12;
318 _GLIBCXX_PLACEHOLDER const _Placeholder<13> _13;
319 _GLIBCXX_PLACEHOLDER const _Placeholder<14> _14;
320 _GLIBCXX_PLACEHOLDER const _Placeholder<15> _15;
321 _GLIBCXX_PLACEHOLDER const _Placeholder<16> _16;
322 _GLIBCXX_PLACEHOLDER const _Placeholder<17> _17;
323 _GLIBCXX_PLACEHOLDER const _Placeholder<18> _18;
324 _GLIBCXX_PLACEHOLDER const _Placeholder<19> _19;
325 _GLIBCXX_PLACEHOLDER const _Placeholder<20> _20;
326 _GLIBCXX_PLACEHOLDER const _Placeholder<21> _21;
327 _GLIBCXX_PLACEHOLDER const _Placeholder<22> _22;
328 _GLIBCXX_PLACEHOLDER const _Placeholder<23> _23;
329 _GLIBCXX_PLACEHOLDER const _Placeholder<24> _24;
330 _GLIBCXX_PLACEHOLDER const _Placeholder<25> _25;
331 _GLIBCXX_PLACEHOLDER const _Placeholder<26> _26;
332 _GLIBCXX_PLACEHOLDER const _Placeholder<27> _27;
333 _GLIBCXX_PLACEHOLDER const _Placeholder<28> _28;
334 _GLIBCXX_PLACEHOLDER const _Placeholder<29> _29;
336#undef _GLIBCXX_PLACEHOLDER
340 * Partial specialization of is_placeholder that provides the placeholder
341 * number for the placeholder objects defined by libstdc++.
346 struct is_placeholder<_Placeholder<_Num> >
347 : public integral_constant<int, _Num>
351 struct is_placeholder<const _Placeholder<_Num> >
352 : public integral_constant<int, _Num>
355 /// @cond undocumented
357 // Like tuple_element_t but SFINAE-friendly.
358 template<std::size_t __i, typename _Tuple>
359 using _Safe_tuple_element_t
360 = typename enable_if<(__i < tuple_size<_Tuple>::value),
361 tuple_element<__i, _Tuple>>::type::type;
364 * Maps an argument to bind() into an actual argument to the bound
365 * function object [func.bind.bind]/10. Only the first parameter should
366 * be specified: the rest are used to determine among the various
367 * implementations. Note that, although this class is a function
368 * object, it isn't entirely normal because it takes only two
369 * parameters regardless of the number of parameters passed to the
370 * bind expression. The first parameter is the bound argument and
371 * the second parameter is a tuple containing references to the
372 * rest of the arguments.
374 template<typename _Arg,
375 bool _IsBindExp = is_bind_expression<_Arg>::value,
376 bool _IsPlaceholder = (is_placeholder<_Arg>::value > 0)>
380 * If the argument is reference_wrapper<_Tp>, returns the
381 * underlying reference.
382 * C++11 [func.bind.bind] p10 bullet 1.
384 template<typename _Tp>
385 class _Mu<reference_wrapper<_Tp>, false, false>
388 /* Note: This won't actually work for const volatile
389 * reference_wrappers, because reference_wrapper::get() is const
390 * but not volatile-qualified. This might be a defect in the TR.
392 template<typename _CVRef, typename _Tuple>
395 operator()(_CVRef& __arg, _Tuple&) const volatile
396 { return __arg.get(); }
400 * If the argument is a bind expression, we invoke the underlying
401 * function object with the same cv-qualifiers as we are given and
402 * pass along all of our arguments (unwrapped).
403 * C++11 [func.bind.bind] p10 bullet 2.
405 template<typename _Arg>
406 class _Mu<_Arg, true, false>
409 template<typename _CVArg, typename... _Args>
412 operator()(_CVArg& __arg,
413 tuple<_Args...>& __tuple) const volatile
414 -> decltype(__arg(declval<_Args>()...))
416 // Construct an index tuple and forward to __call
417 typedef typename _Build_index_tuple<sizeof...(_Args)>::__type
419 return this->__call(__arg, __tuple, _Indexes());
423 // Invokes the underlying function object __arg by unpacking all
424 // of the arguments in the tuple.
425 template<typename _CVArg, typename... _Args, std::size_t... _Indexes>
428 __call(_CVArg& __arg, tuple<_Args...>& __tuple,
429 const _Index_tuple<_Indexes...>&) const volatile
430 -> decltype(__arg(declval<_Args>()...))
432 return __arg(std::get<_Indexes>(std::move(__tuple))...);
437 * If the argument is a placeholder for the Nth argument, returns
438 * a reference to the Nth argument to the bind function object.
439 * C++11 [func.bind.bind] p10 bullet 3.
441 template<typename _Arg>
442 class _Mu<_Arg, false, true>
445 template<typename _Tuple>
447 _Safe_tuple_element_t<(is_placeholder<_Arg>::value - 1), _Tuple>&&
448 operator()(const volatile _Arg&, _Tuple& __tuple) const volatile
451 ::std::get<(is_placeholder<_Arg>::value - 1)>(std::move(__tuple));
456 * If the argument is just a value, returns a reference to that
457 * value. The cv-qualifiers on the reference are determined by the caller.
458 * C++11 [func.bind.bind] p10 bullet 4.
460 template<typename _Arg>
461 class _Mu<_Arg, false, false>
464 template<typename _CVArg, typename _Tuple>
467 operator()(_CVArg&& __arg, _Tuple&) const volatile
468 { return std::forward<_CVArg>(__arg); }
471 // std::get<I> for volatile-qualified tuples
472 template<std::size_t _Ind, typename... _Tp>
474 __volget(volatile tuple<_Tp...>& __tuple)
475 -> __tuple_element_t<_Ind, tuple<_Tp...>> volatile&
476 { return std::get<_Ind>(const_cast<tuple<_Tp...>&>(__tuple)); }
478 // std::get<I> for const-volatile-qualified tuples
479 template<std::size_t _Ind, typename... _Tp>
481 __volget(const volatile tuple<_Tp...>& __tuple)
482 -> __tuple_element_t<_Ind, tuple<_Tp...>> const volatile&
483 { return std::get<_Ind>(const_cast<const tuple<_Tp...>&>(__tuple)); }
487#if __cplusplus == 201703L && _GLIBCXX_USE_DEPRECATED
488# define _GLIBCXX_VOLATILE_BIND
489// _GLIBCXX_RESOLVE_LIB_DEFECTS
490// 2487. bind() should be const-overloaded, not cv-overloaded
491# define _GLIBCXX_DEPR_BIND \
492 [[deprecated("std::bind does not support volatile in C++17")]]
493#elif __cplusplus < 201703L
494# define _GLIBCXX_VOLATILE_BIND
495# define _GLIBCXX_DEPR_BIND
498 /// Type of the function object returned from bind().
499 template<typename _Signature>
502 template<typename _Functor, typename... _Bound_args>
503 class _Bind<_Functor(_Bound_args...)>
504 : public _Weak_result_type<_Functor>
506 typedef typename _Build_index_tuple<sizeof...(_Bound_args)>::__type
510 tuple<_Bound_args...> _M_bound_args;
513 template<typename _Result, typename... _Args, std::size_t... _Indexes>
516 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>)
518 return std::__invoke(_M_f,
519 _Mu<_Bound_args>()(std::get<_Indexes>(_M_bound_args), __args)...
524 template<typename _Result, typename... _Args, std::size_t... _Indexes>
527 __call_c(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) const
529 return std::__invoke(_M_f,
530 _Mu<_Bound_args>()(std::get<_Indexes>(_M_bound_args), __args)...
534#ifdef _GLIBCXX_VOLATILE_BIND
536 template<typename _Result, typename... _Args, std::size_t... _Indexes>
538 __call_v(tuple<_Args...>&& __args,
539 _Index_tuple<_Indexes...>) volatile
541 return std::__invoke(_M_f,
542 _Mu<_Bound_args>()(__volget<_Indexes>(_M_bound_args), __args)...
546 // Call as const volatile
547 template<typename _Result, typename... _Args, std::size_t... _Indexes>
549 __call_c_v(tuple<_Args...>&& __args,
550 _Index_tuple<_Indexes...>) const volatile
552 return std::__invoke(_M_f,
553 _Mu<_Bound_args>()(__volget<_Indexes>(_M_bound_args), __args)...
558 template<typename _BoundArg, typename _CallArgs>
559 using _Mu_type = decltype(
560 _Mu<typename remove_cv<_BoundArg>::type>()(
561 std::declval<_BoundArg&>(), std::declval<_CallArgs&>()) );
563 template<typename _Fn, typename _CallArgs, typename... _BArgs>
565 = __invoke_result_t<_Fn&, _Mu_type<_BArgs, _CallArgs>&&...>;
567 template<typename _CallArgs>
568 using _Res_type = _Res_type_impl<_Functor, _CallArgs, _Bound_args...>;
570 template<typename _CallArgs>
571 using __dependent = typename
572 enable_if<bool(tuple_size<_CallArgs>::value+1), _Functor>::type;
574 template<typename _CallArgs, template<class> class __cv_quals>
575 using _Res_type_cv = _Res_type_impl<
576 typename __cv_quals<__dependent<_CallArgs>>::type,
578 typename __cv_quals<_Bound_args>::type...>;
581 template<typename... _Args>
582 explicit _GLIBCXX20_CONSTEXPR
583 _Bind(const _Functor& __f, _Args&&... __args)
584 : _M_f(__f), _M_bound_args(std::forward<_Args>(__args)...)
587 template<typename... _Args>
588 explicit _GLIBCXX20_CONSTEXPR
589 _Bind(_Functor&& __f, _Args&&... __args)
590 : _M_f(std::move(__f)), _M_bound_args(std::forward<_Args>(__args)...)
593 _Bind(const _Bind&) = default;
594 _Bind(_Bind&&) = default;
597 template<typename... _Args,
598 typename _Result = _Res_type<tuple<_Args...>>>
601 operator()(_Args&&... __args)
603 return this->__call<_Result>(
604 std::forward_as_tuple(std::forward<_Args>(__args)...),
609 template<typename... _Args,
610 typename _Result = _Res_type_cv<tuple<_Args...>, add_const>>
613 operator()(_Args&&... __args) const
615 return this->__call_c<_Result>(
616 std::forward_as_tuple(std::forward<_Args>(__args)...),
620#ifdef _GLIBCXX_VOLATILE_BIND
622 template<typename... _Args,
623 typename _Result = _Res_type_cv<tuple<_Args...>, add_volatile>>
626 operator()(_Args&&... __args) volatile
628 return this->__call_v<_Result>(
629 std::forward_as_tuple(std::forward<_Args>(__args)...),
633 // Call as const volatile
634 template<typename... _Args,
635 typename _Result = _Res_type_cv<tuple<_Args...>, add_cv>>
638 operator()(_Args&&... __args) const volatile
640 return this->__call_c_v<_Result>(
641 std::forward_as_tuple(std::forward<_Args>(__args)...),
647 /// Type of the function object returned from bind<R>().
648 template<typename _Result, typename _Signature>
651 template<typename _Result, typename _Functor, typename... _Bound_args>
652 class _Bind_result<_Result, _Functor(_Bound_args...)>
654 typedef typename _Build_index_tuple<sizeof...(_Bound_args)>::__type
658 tuple<_Bound_args...> _M_bound_args;
661 template<typename _Res, typename... _Args, std::size_t... _Indexes>
664 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>)
666 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
667 (std::get<_Indexes>(_M_bound_args), __args)...);
671 template<typename _Res, typename... _Args, std::size_t... _Indexes>
674 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) const
676 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
677 (std::get<_Indexes>(_M_bound_args), __args)...);
680#ifdef _GLIBCXX_VOLATILE_BIND
682 template<typename _Res, typename... _Args, std::size_t... _Indexes>
684 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) volatile
686 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
687 (__volget<_Indexes>(_M_bound_args), __args)...);
690 // Call as const volatile
691 template<typename _Res, typename... _Args, std::size_t... _Indexes>
693 __call(tuple<_Args...>&& __args,
694 _Index_tuple<_Indexes...>) const volatile
696 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
697 (__volget<_Indexes>(_M_bound_args), __args)...);
702 typedef _Result result_type;
704 template<typename... _Args>
705 explicit _GLIBCXX20_CONSTEXPR
706 _Bind_result(const _Functor& __f, _Args&&... __args)
707 : _M_f(__f), _M_bound_args(std::forward<_Args>(__args)...)
710 template<typename... _Args>
711 explicit _GLIBCXX20_CONSTEXPR
712 _Bind_result(_Functor&& __f, _Args&&... __args)
713 : _M_f(std::move(__f)), _M_bound_args(std::forward<_Args>(__args)...)
716 _Bind_result(const _Bind_result&) = default;
717 _Bind_result(_Bind_result&&) = default;
720 template<typename... _Args>
723 operator()(_Args&&... __args)
725 return this->__call<_Result>(
726 std::forward_as_tuple(std::forward<_Args>(__args)...),
731 template<typename... _Args>
734 operator()(_Args&&... __args) const
736 return this->__call<_Result>(
737 std::forward_as_tuple(std::forward<_Args>(__args)...),
741#ifdef _GLIBCXX_VOLATILE_BIND
743 template<typename... _Args>
746 operator()(_Args&&... __args) volatile
748 return this->__call<_Result>(
749 std::forward_as_tuple(std::forward<_Args>(__args)...),
753 // Call as const volatile
754 template<typename... _Args>
757 operator()(_Args&&... __args) const volatile
759 return this->__call<_Result>(
760 std::forward_as_tuple(std::forward<_Args>(__args)...),
764 template<typename... _Args>
765 void operator()(_Args&&...) const volatile = delete;
769#undef _GLIBCXX_VOLATILE_BIND
770#undef _GLIBCXX_DEPR_BIND
773 * @brief Class template _Bind is always a bind expression.
776 template<typename _Signature>
777 struct is_bind_expression<_Bind<_Signature> >
778 : public true_type { };
781 * @brief Class template _Bind is always a bind expression.
784 template<typename _Signature>
785 struct is_bind_expression<const _Bind<_Signature> >
786 : public true_type { };
789 * @brief Class template _Bind is always a bind expression.
792 template<typename _Signature>
793 struct is_bind_expression<volatile _Bind<_Signature> >
794 : public true_type { };
797 * @brief Class template _Bind is always a bind expression.
800 template<typename _Signature>
801 struct is_bind_expression<const volatile _Bind<_Signature>>
802 : public true_type { };
805 * @brief Class template _Bind_result is always a bind expression.
808 template<typename _Result, typename _Signature>
809 struct is_bind_expression<_Bind_result<_Result, _Signature>>
810 : public true_type { };
813 * @brief Class template _Bind_result is always a bind expression.
816 template<typename _Result, typename _Signature>
817 struct is_bind_expression<const _Bind_result<_Result, _Signature>>
818 : public true_type { };
821 * @brief Class template _Bind_result is always a bind expression.
824 template<typename _Result, typename _Signature>
825 struct is_bind_expression<volatile _Bind_result<_Result, _Signature>>
826 : public true_type { };
829 * @brief Class template _Bind_result is always a bind expression.
832 template<typename _Result, typename _Signature>
833 struct is_bind_expression<const volatile _Bind_result<_Result, _Signature>>
834 : public true_type { };
836 template<typename _Func, typename... _BoundArgs>
837 struct _Bind_check_arity { };
839 template<typename _Ret, typename... _Args, typename... _BoundArgs>
840 struct _Bind_check_arity<_Ret (*)(_Args...), _BoundArgs...>
842 static_assert(sizeof...(_BoundArgs) == sizeof...(_Args),
843 "Wrong number of arguments for function");
846 template<typename _Ret, typename... _Args, typename... _BoundArgs>
847 struct _Bind_check_arity<_Ret (*)(_Args..., ...), _BoundArgs...>
849 static_assert(sizeof...(_BoundArgs) >= sizeof...(_Args),
850 "Wrong number of arguments for function");
853 template<typename _Tp, typename _Class, typename... _BoundArgs>
854 struct _Bind_check_arity<_Tp _Class::*, _BoundArgs...>
856 using _Arity = typename _Mem_fn<_Tp _Class::*>::_Arity;
857 using _Varargs = typename _Mem_fn<_Tp _Class::*>::_Varargs;
858 static_assert(_Varargs::value
859 ? sizeof...(_BoundArgs) >= _Arity::value + 1
860 : sizeof...(_BoundArgs) == _Arity::value + 1,
861 "Wrong number of arguments for pointer-to-member");
864 // Trait type used to remove std::bind() from overload set via SFINAE
865 // when first argument has integer type, so that std::bind() will
866 // not be a better match than ::bind() from the BSD Sockets API.
867 template<typename _Tp, typename _Tp2 = typename decay<_Tp>::type>
868 using __is_socketlike = __or_<is_integral<_Tp2>, is_enum<_Tp2>>;
870 template<bool _SocketLike, typename _Func, typename... _BoundArgs>
872 : _Bind_check_arity<typename decay<_Func>::type, _BoundArgs...>
874 typedef typename decay<_Func>::type __func_type;
875 typedef _Bind<__func_type(typename decay<_BoundArgs>::type...)> type;
878 // Partial specialization for is_socketlike == true, does not define
879 // nested type so std::bind() will not participate in overload resolution
880 // when the first argument might be a socket file descriptor.
881 template<typename _Func, typename... _BoundArgs>
882 struct _Bind_helper<true, _Func, _BoundArgs...>
886 * @brief Function template for std::bind.
890 template<typename _Func, typename... _BoundArgs>
891 inline _GLIBCXX20_CONSTEXPR typename
892 _Bind_helper<__is_socketlike<_Func>::value, _Func, _BoundArgs...>::type
893 bind(_Func&& __f, _BoundArgs&&... __args)
895 typedef _Bind_helper<false, _Func, _BoundArgs...> __helper_type;
896 return typename __helper_type::type(std::forward<_Func>(__f),
897 std::forward<_BoundArgs>(__args)...);
900 template<typename _Result, typename _Func, typename... _BoundArgs>
901 struct _Bindres_helper
902 : _Bind_check_arity<typename decay<_Func>::type, _BoundArgs...>
904 typedef typename decay<_Func>::type __functor_type;
905 typedef _Bind_result<_Result,
906 __functor_type(typename decay<_BoundArgs>::type...)>
911 * @brief Function template for std::bind<R>.
915 template<typename _Result, typename _Func, typename... _BoundArgs>
916 inline _GLIBCXX20_CONSTEXPR
917 typename _Bindres_helper<_Result, _Func, _BoundArgs...>::type
918 bind(_Func&& __f, _BoundArgs&&... __args)
920 typedef _Bindres_helper<_Result, _Func, _BoundArgs...> __helper_type;
921 return typename __helper_type::type(std::forward<_Func>(__f),
922 std::forward<_BoundArgs>(__args)...);
925#ifdef __cpp_lib_bind_front // C++ >= 20
926 /** Create call wrapper by partial application of arguments to function.
928 * The result of `std::bind_front(f, args...)` is a function object that
929 * stores `f` and the bound arguments, `args...`. When that function
930 * object is invoked with `call_args...` it returns the result of calling
931 * `f(args..., call_args...)`.
935 template<typename _Fn, typename... _Args>
936 constexpr _Bind_front_t<_Fn, _Args...>
937 bind_front(_Fn&& __fn, _Args&&... __args)
938 noexcept(is_nothrow_constructible_v<_Bind_front_t<_Fn, _Args...>,
941 return _Bind_front_t<_Fn, _Args...>(0, std::forward<_Fn>(__fn),
942 std::forward<_Args>(__args)...);
944#endif // __cpp_lib_bind_front
946#ifdef __cpp_lib_bind_back // C++ >= 23
947 /** Create call wrapper by partial application of arguments to function.
949 * The result of `std::bind_back(f, args...)` is a function object that
950 * stores `f` and the bound arguments, `args...`. When that function
951 * object is invoked with `call_args...` it returns the result of calling
952 * `f(call_args..., args...)`.
956 template<typename _Fn, typename... _Args>
957 constexpr _Bind_back_t<_Fn, _Args...>
958 bind_back(_Fn&& __fn, _Args&&... __args)
959 noexcept(is_nothrow_constructible_v<_Bind_back_t<_Fn, _Args...>,
962 return _Bind_back_t<_Fn, _Args...>(0, std::forward<_Fn>(__fn),
963 std::forward<_Args>(__args)...);
965#endif // __cpp_lib_bind_back
967#if __cplusplus >= 201402L
968 /// Generalized negator.
969 template<typename _Fn>
972 template<typename _Fn2, typename... _Args>
973 using __inv_res_t = typename __invoke_result<_Fn2, _Args...>::type;
975 template<typename _Tp>
976 static decltype(!std::declval<_Tp>())
977 _S_not() noexcept(noexcept(!std::declval<_Tp>()));
980 template<typename _Fn2>
982 _Not_fn(_Fn2&& __fn, int)
983 : _M_fn(std::forward<_Fn2>(__fn)) { }
985 _Not_fn(const _Not_fn& __fn) = default;
986 _Not_fn(_Not_fn&& __fn) = default;
987 ~_Not_fn() = default;
989 // Macro to define operator() with given cv-qualifiers ref-qualifiers,
990 // forwarding _M_fn and the function arguments with the same qualifiers,
991 // and deducing the return type and exception-specification.
992#define _GLIBCXX_NOT_FN_CALL_OP( _QUALS ) \
993 template<typename... _Args, \
994 typename = enable_if_t<__is_invocable<_Fn _QUALS, _Args...>::value>> \
995 _GLIBCXX20_CONSTEXPR \
996 decltype(_S_not<__inv_res_t<_Fn _QUALS, _Args...>>()) \
997 operator()(_Args&&... __args) _QUALS \
998 noexcept(__is_nothrow_invocable<_Fn _QUALS, _Args...>::value \
999 && noexcept(_S_not<__inv_res_t<_Fn _QUALS, _Args...>>())) \
1001 return !std::__invoke(std::forward< _Fn _QUALS >(_M_fn), \
1002 std::forward<_Args>(__args)...); \
1005 template<typename... _Args, \
1006 typename = enable_if_t<!__is_invocable<_Fn _QUALS, _Args...>::value>> \
1007 void operator()(_Args&&... __args) _QUALS = delete;
1009 _GLIBCXX_NOT_FN_CALL_OP( & )
1010 _GLIBCXX_NOT_FN_CALL_OP( const & )
1011 _GLIBCXX_NOT_FN_CALL_OP( && )
1012 _GLIBCXX_NOT_FN_CALL_OP( const && )
1013#undef _GLIBCXX_NOT_FN_CALL_OP
1019 template<typename _Tp, typename _Pred>
1020 struct __is_byte_like : false_type { };
1022 template<typename _Tp>
1023 struct __is_byte_like<_Tp, equal_to<_Tp>>
1024 : __bool_constant<sizeof(_Tp) == 1 && is_integral<_Tp>::value> { };
1026 template<typename _Tp>
1027 struct __is_byte_like<_Tp, equal_to<void>>
1028 : __bool_constant<sizeof(_Tp) == 1 && is_integral<_Tp>::value> { };
1030#if __cplusplus >= 201703L
1031 // Declare std::byte (full definition is in <cstddef>).
1032 enum class byte : unsigned char;
1035 struct __is_byte_like<byte, equal_to<byte>>
1039 struct __is_byte_like<byte, equal_to<void>>
1043 // [func.not_fn] Function template not_fn
1044#ifdef __cpp_lib_not_fn // C++ >= 17
1045 /** Wrap a function object to create one that negates its result.
1047 * The function template `std::not_fn` creates a "forwarding call wrapper",
1048 * which is a function object that wraps another function object and
1049 * when called, forwards its arguments to the wrapped function object.
1051 * The result of invoking the wrapper is the negation (using `!`) of
1052 * the wrapped function object.
1057 template<typename _Fn>
1058 _GLIBCXX20_CONSTEXPR
1061 noexcept(std::is_nothrow_constructible<std::decay_t<_Fn>, _Fn&&>::value)
1063 return _Not_fn<std::decay_t<_Fn>>{std::forward<_Fn>(__fn), 0};
1067#if __cplusplus >= 201703L
1070 template<typename _ForwardIterator1, typename _BinaryPredicate = equal_to<>>
1071 class default_searcher
1074 _GLIBCXX20_CONSTEXPR
1075 default_searcher(_ForwardIterator1 __pat_first,
1076 _ForwardIterator1 __pat_last,
1077 _BinaryPredicate __pred = _BinaryPredicate())
1078 : _M_m(__pat_first, __pat_last, std::move(__pred))
1081 template<typename _ForwardIterator2>
1082 _GLIBCXX20_CONSTEXPR
1083 pair<_ForwardIterator2, _ForwardIterator2>
1084 operator()(_ForwardIterator2 __first, _ForwardIterator2 __last) const
1086 _ForwardIterator2 __first_ret =
1087 std::search(__first, __last, std::get<0>(_M_m), std::get<1>(_M_m),
1089 auto __ret = std::make_pair(__first_ret, __first_ret);
1090 if (__ret.first != __last)
1091 std::advance(__ret.second, std::distance(std::get<0>(_M_m),
1092 std::get<1>(_M_m)));
1097 tuple<_ForwardIterator1, _ForwardIterator1, _BinaryPredicate> _M_m;
1100#ifdef __cpp_lib_boyer_moore_searcher // C++ >= 17 && HOSTED
1102 template<typename _Key, typename _Tp, typename _Hash, typename _Pred>
1103 struct __boyer_moore_map_base
1105 template<typename _RAIter>
1106 __boyer_moore_map_base(_RAIter __pat, size_t __patlen,
1107 _Hash&& __hf, _Pred&& __pred)
1108 : _M_bad_char{ __patlen, std::move(__hf), std::move(__pred) }
1111 for (__diff_type __i = 0; __i < __patlen - 1; ++__i)
1112 _M_bad_char[__pat[__i]] = __patlen - 1 - __i;
1115 using __diff_type = _Tp;
1118 _M_lookup(_Key __key, __diff_type __not_found) const
1120 auto __iter = _M_bad_char.find(__key);
1121 if (__iter == _M_bad_char.end())
1123 return __iter->second;
1127 _M_pred() const { return _M_bad_char.key_eq(); }
1129 _GLIBCXX_STD_C::unordered_map<_Key, _Tp, _Hash, _Pred> _M_bad_char;
1132 template<typename _Tp, size_t _Len, typename _Pred>
1133 struct __boyer_moore_array_base
1135 template<typename _RAIter, typename _Unused>
1136 __boyer_moore_array_base(_RAIter __pat, size_t __patlen,
1137 _Unused&&, _Pred&& __pred)
1138 : _M_bad_char{ array<_Tp, _Len>{}, std::move(__pred) }
1140 std::get<0>(_M_bad_char).fill(__patlen);
1142 for (__diff_type __i = 0; __i < __patlen - 1; ++__i)
1144 auto __ch = __pat[__i];
1145 using _UCh = make_unsigned_t<decltype(__ch)>;
1146 auto __uch = static_cast<_UCh>(__ch);
1147 std::get<0>(_M_bad_char)[__uch] = __patlen - 1 - __i;
1151 using __diff_type = _Tp;
1153 template<typename _Key>
1155 _M_lookup(_Key __key, __diff_type __not_found) const
1157 auto __ukey = static_cast<make_unsigned_t<_Key>>(__key);
1160 return std::get<0>(_M_bad_char)[__ukey];
1164 _M_pred() const { return std::get<1>(_M_bad_char); }
1166 tuple<array<_Tp, _Len>, _Pred> _M_bad_char;
1169 // Use __boyer_moore_array_base when pattern consists of narrow characters
1170 // (or std::byte) and uses std::equal_to as the predicate.
1171 template<typename _RAIter, typename _Hash, typename _Pred,
1172 typename _Val = typename iterator_traits<_RAIter>::value_type,
1173 typename _Diff = typename iterator_traits<_RAIter>::difference_type>
1174 using __boyer_moore_base_t
1175 = __conditional_t<__is_byte_like<_Val, _Pred>::value,
1176 __boyer_moore_array_base<_Diff, 256, _Pred>,
1177 __boyer_moore_map_base<_Val, _Diff, _Hash, _Pred>>;
1179 template<typename _RAIter, typename _Hash
1180 = hash<typename iterator_traits<_RAIter>::value_type>,
1181 typename _BinaryPredicate = equal_to<>>
1182 class boyer_moore_searcher
1183 : __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>
1185 using _Base = __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>;
1186 using typename _Base::__diff_type;
1189 boyer_moore_searcher(_RAIter __pat_first, _RAIter __pat_last,
1190 _Hash __hf = _Hash(),
1191 _BinaryPredicate __pred = _BinaryPredicate());
1193 template<typename _RandomAccessIterator2>
1194 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1195 operator()(_RandomAccessIterator2 __first,
1196 _RandomAccessIterator2 __last) const;
1200 _M_is_prefix(_RAIter __word, __diff_type __len,
1203 const auto& __pred = this->_M_pred();
1204 __diff_type __suffixlen = __len - __pos;
1205 for (__diff_type __i = 0; __i < __suffixlen; ++__i)
1206 if (!__pred(__word[__i], __word[__pos + __i]))
1212 _M_suffix_length(_RAIter __word, __diff_type __len,
1215 const auto& __pred = this->_M_pred();
1216 __diff_type __i = 0;
1217 while (__pred(__word[__pos - __i], __word[__len - 1 - __i])
1225 template<typename _Tp>
1227 _M_bad_char_shift(_Tp __c) const
1228 { return this->_M_lookup(__c, _M_pat_end - _M_pat); }
1232 _GLIBCXX_STD_C::vector<__diff_type> _M_good_suffix;
1235 template<typename _RAIter, typename _Hash
1236 = hash<typename iterator_traits<_RAIter>::value_type>,
1237 typename _BinaryPredicate = equal_to<>>
1238 class boyer_moore_horspool_searcher
1239 : __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>
1241 using _Base = __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>;
1242 using typename _Base::__diff_type;
1245 boyer_moore_horspool_searcher(_RAIter __pat,
1247 _Hash __hf = _Hash(),
1248 _BinaryPredicate __pred
1249 = _BinaryPredicate())
1250 : _Base(__pat, __pat_end - __pat, std::move(__hf), std::move(__pred)),
1251 _M_pat(__pat), _M_pat_end(__pat_end)
1254 template<typename _RandomAccessIterator2>
1255 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1256 operator()(_RandomAccessIterator2 __first,
1257 _RandomAccessIterator2 __last) const
1259 const auto& __pred = this->_M_pred();
1260 auto __patlen = _M_pat_end - _M_pat;
1262 return std::make_pair(__first, __first);
1263 auto __len = __last - __first;
1264 while (__len >= __patlen)
1266 for (auto __scan = __patlen - 1;
1267 __pred(__first[__scan], _M_pat[__scan]); --__scan)
1269 return std::make_pair(__first, __first + __patlen);
1270 auto __shift = _M_bad_char_shift(__first[__patlen - 1]);
1274 return std::make_pair(__last, __last);
1278 template<typename _Tp>
1280 _M_bad_char_shift(_Tp __c) const
1281 { return this->_M_lookup(__c, _M_pat_end - _M_pat); }
1287 template<typename _RAIter, typename _Hash, typename _BinaryPredicate>
1288 boyer_moore_searcher<_RAIter, _Hash, _BinaryPredicate>::
1289 boyer_moore_searcher(_RAIter __pat, _RAIter __pat_end,
1290 _Hash __hf, _BinaryPredicate __pred)
1291 : _Base(__pat, __pat_end - __pat, std::move(__hf), std::move(__pred)),
1292 _M_pat(__pat), _M_pat_end(__pat_end), _M_good_suffix(__pat_end - __pat)
1294 auto __patlen = __pat_end - __pat;
1297 __diff_type __last_prefix = __patlen - 1;
1298 for (__diff_type __p = __patlen - 1; __p >= 0; --__p)
1300 if (_M_is_prefix(__pat, __patlen, __p + 1))
1301 __last_prefix = __p + 1;
1302 _M_good_suffix[__p] = __last_prefix + (__patlen - 1 - __p);
1304 for (__diff_type __p = 0; __p < __patlen - 1; ++__p)
1306 auto __slen = _M_suffix_length(__pat, __patlen, __p);
1307 auto __pos = __patlen - 1 - __slen;
1308 if (!__pred(__pat[__p - __slen], __pat[__pos]))
1309 _M_good_suffix[__pos] = __patlen - 1 - __p + __slen;
1313 template<typename _RAIter, typename _Hash, typename _BinaryPredicate>
1314 template<typename _RandomAccessIterator2>
1315 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1316 boyer_moore_searcher<_RAIter, _Hash, _BinaryPredicate>::
1317 operator()(_RandomAccessIterator2 __first,
1318 _RandomAccessIterator2 __last) const
1320 auto __patlen = _M_pat_end - _M_pat;
1322 return std::make_pair(__first, __first);
1323 const auto& __pred = this->_M_pred();
1324 __diff_type __i = __patlen - 1;
1325 auto __stringlen = __last - __first;
1326 while (__i < __stringlen)
1328 __diff_type __j = __patlen - 1;
1329 while (__j >= 0 && __pred(__first[__i], _M_pat[__j]))
1336 const auto __match = __first + __i + 1;
1337 return std::make_pair(__match, __match + __patlen);
1339 __i += std::max(_M_bad_char_shift(__first[__i]),
1340 _M_good_suffix[__j]);
1342 return std::make_pair(__last, __last);
1344#endif // __cpp_lib_boyer_moore_searcher
1350_GLIBCXX_END_NAMESPACE_VERSION
1353#endif // _GLIBCXX_FUNCTIONAL