1// <functional> -*- C++ -*-
3// Copyright (C) 2001-2023 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
46#pragma GCC system_header
48#include <bits/c++config.h>
49#include <bits/stl_function.h> // std::equal_to, std::unary_function etc.
51#if __cplusplus >= 201103L
55#include <bits/functional_hash.h>
56#include <bits/invoke.h>
57#include <bits/refwrap.h> // std::reference_wrapper and _Mem_fn_traits
59# include <bits/std_function.h> // std::function
61#if __cplusplus >= 201703L
63# include <unordered_map>
67# include <bits/stl_algo.h> // std::search
69#if __cplusplus >= 202002L
70# include <bits/ranges_cmp.h> // std::identity, ranges::equal_to etc.
73#if __cplusplus > 202002L && _GLIBCXX_HOSTED
74# include <bits/move_only_function.h>
79namespace std _GLIBCXX_VISIBILITY(default)
81_GLIBCXX_BEGIN_NAMESPACE_VERSION
83 /** @brief The type of placeholder objects defined by libstdc++.
87 template<int _Num> struct _Placeholder { };
89#if __cplusplus >= 201103L
91#if __cplusplus >= 201703L
92# define __cpp_lib_invoke 201411L
93# if __cplusplus > 201703L
94# define __cpp_lib_constexpr_functional 201907L
97 /** Invoke a callable object.
99 * `std::invoke` takes a callable object as its first argument and calls it
100 * with the remaining arguments. The callable object can be a pointer or
101 * reference to a function, a lambda closure, a class with `operator()`,
102 * or even a pointer-to-member. For a pointer-to-member the first argument
103 * must be a reference or pointer to the object that the pointer-to-member
104 * will be applied to.
108 template<typename _Callable, typename... _Args>
109 inline _GLIBCXX20_CONSTEXPR invoke_result_t<_Callable, _Args...>
110 invoke(_Callable&& __fn, _Args&&... __args)
111 noexcept(is_nothrow_invocable_v<_Callable, _Args...>)
113 return std::__invoke(std::forward<_Callable>(__fn),
114 std::forward<_Args>(__args)...);
117#if __cplusplus > 202002L
118# define __cpp_lib_invoke_r 202106L
120 /** Invoke a callable object and convert the result to `_Res`.
122 * `std::invoke_r<R>(f, args...)` is equivalent to `std::invoke(f, args...)`
123 * with the result implicitly converted to `R`.
127 template<typename _Res, typename _Callable, typename... _Args>
128 requires is_invocable_r_v<_Res, _Callable, _Args...>
130 invoke_r(_Callable&& __fn, _Args&&... __args)
131 noexcept(is_nothrow_invocable_r_v<_Res, _Callable, _Args...>)
133 return std::__invoke_r<_Res>(std::forward<_Callable>(__fn),
134 std::forward<_Args>(__args)...);
139 /// @cond undocumented
141 template<typename _MemFunPtr,
142 bool __is_mem_fn = is_member_function_pointer<_MemFunPtr>::value>
144 : public _Mem_fn_traits<_MemFunPtr>::__maybe_type
146 using _Traits = _Mem_fn_traits<_MemFunPtr>;
148 using _Arity = typename _Traits::__arity;
149 using _Varargs = typename _Traits::__vararg;
151 template<typename _Func, typename... _BoundArgs>
152 friend struct _Bind_check_arity;
158 using result_type = typename _Traits::__result_type;
161 _Mem_fn_base(_MemFunPtr __pmf) noexcept : _M_pmf(__pmf) { }
163 template<typename... _Args>
166 operator()(_Args&&... __args) const
168 std::__invoke(_M_pmf, std::forward<_Args>(__args)...)))
169 -> decltype(std::__invoke(_M_pmf, std::forward<_Args>(__args)...))
170 { return std::__invoke(_M_pmf, std::forward<_Args>(__args)...); }
173 // Partial specialization for member object pointers.
174 template<typename _MemObjPtr>
175 class _Mem_fn_base<_MemObjPtr, false>
177 using _Arity = integral_constant<size_t, 0>;
178 using _Varargs = false_type;
180 template<typename _Func, typename... _BoundArgs>
181 friend struct _Bind_check_arity;
187 _Mem_fn_base(_MemObjPtr __pm) noexcept : _M_pm(__pm) { }
189 template<typename _Tp>
192 operator()(_Tp&& __obj) const
193 noexcept(noexcept(std::__invoke(_M_pm, std::forward<_Tp>(__obj))))
194 -> decltype(std::__invoke(_M_pm, std::forward<_Tp>(__obj)))
195 { return std::__invoke(_M_pm, std::forward<_Tp>(__obj)); }
198 template<typename _MemberPointer>
199 struct _Mem_fn; // undefined
201 template<typename _Res, typename _Class>
202 struct _Mem_fn<_Res _Class::*>
203 : _Mem_fn_base<_Res _Class::*>
205 using _Mem_fn_base<_Res _Class::*>::_Mem_fn_base;
209 // _GLIBCXX_RESOLVE_LIB_DEFECTS
210 // 2048. Unnecessary mem_fn overloads
212 * @brief Returns a function object that forwards to the member pointer
215 * This allows a pointer-to-member to be transformed into a function object
216 * that can be called with an object expression as its first argument.
218 * For a pointer-to-data-member the result must be called with exactly one
219 * argument, the object expression that would be used as the first operand
220 * in a `obj.*memptr` or `objp->*memptr` expression.
222 * For a pointer-to-member-function the result must be called with an object
223 * expression and any additional arguments to pass to the member function,
224 * as in an expression like `(obj.*memfun)(args...)` or
225 * `(objp->*memfun)(args...)`.
227 * The object expression can be a pointer, reference, `reference_wrapper`,
228 * or smart pointer, and the call wrapper will dereference it as needed
229 * to apply the pointer-to-member.
234 template<typename _Tp, typename _Class>
236 inline _Mem_fn<_Tp _Class::*>
237 mem_fn(_Tp _Class::* __pm) noexcept
239 return _Mem_fn<_Tp _Class::*>(__pm);
243 * @brief Trait that identifies a bind expression.
245 * Determines if the given type `_Tp` is a function object that
246 * should be treated as a subexpression when evaluating calls to
247 * function objects returned by `std::bind`.
249 * C++11 [func.bind.isbind].
253 template<typename _Tp>
254 struct is_bind_expression
255 : public false_type { };
258 * @brief Determines if the given type _Tp is a placeholder in a
259 * bind() expression and, if so, which placeholder it is.
261 * C++11 [func.bind.isplace].
265 template<typename _Tp>
266 struct is_placeholder
267 : public integral_constant<int, 0>
270#if __cplusplus > 201402L
271 template <typename _Tp> inline constexpr bool is_bind_expression_v
272 = is_bind_expression<_Tp>::value;
273 template <typename _Tp> inline constexpr int is_placeholder_v
274 = is_placeholder<_Tp>::value;
277 /** @namespace std::placeholders
278 * @brief ISO C++ 2011 namespace for std::bind placeholders.
282 namespace placeholders
284 /* Define a large number of placeholders. There is no way to
285 * simplify this with variadic templates, because we're introducing
286 * unique names for each.
288#if __cpp_inline_variables
289# define _GLIBCXX_PLACEHOLDER inline
291# define _GLIBCXX_PLACEHOLDER extern
294 _GLIBCXX_PLACEHOLDER const _Placeholder<1> _1;
295 _GLIBCXX_PLACEHOLDER const _Placeholder<2> _2;
296 _GLIBCXX_PLACEHOLDER const _Placeholder<3> _3;
297 _GLIBCXX_PLACEHOLDER const _Placeholder<4> _4;
298 _GLIBCXX_PLACEHOLDER const _Placeholder<5> _5;
299 _GLIBCXX_PLACEHOLDER const _Placeholder<6> _6;
300 _GLIBCXX_PLACEHOLDER const _Placeholder<7> _7;
301 _GLIBCXX_PLACEHOLDER const _Placeholder<8> _8;
302 _GLIBCXX_PLACEHOLDER const _Placeholder<9> _9;
303 _GLIBCXX_PLACEHOLDER const _Placeholder<10> _10;
304 _GLIBCXX_PLACEHOLDER const _Placeholder<11> _11;
305 _GLIBCXX_PLACEHOLDER const _Placeholder<12> _12;
306 _GLIBCXX_PLACEHOLDER const _Placeholder<13> _13;
307 _GLIBCXX_PLACEHOLDER const _Placeholder<14> _14;
308 _GLIBCXX_PLACEHOLDER const _Placeholder<15> _15;
309 _GLIBCXX_PLACEHOLDER const _Placeholder<16> _16;
310 _GLIBCXX_PLACEHOLDER const _Placeholder<17> _17;
311 _GLIBCXX_PLACEHOLDER const _Placeholder<18> _18;
312 _GLIBCXX_PLACEHOLDER const _Placeholder<19> _19;
313 _GLIBCXX_PLACEHOLDER const _Placeholder<20> _20;
314 _GLIBCXX_PLACEHOLDER const _Placeholder<21> _21;
315 _GLIBCXX_PLACEHOLDER const _Placeholder<22> _22;
316 _GLIBCXX_PLACEHOLDER const _Placeholder<23> _23;
317 _GLIBCXX_PLACEHOLDER const _Placeholder<24> _24;
318 _GLIBCXX_PLACEHOLDER const _Placeholder<25> _25;
319 _GLIBCXX_PLACEHOLDER const _Placeholder<26> _26;
320 _GLIBCXX_PLACEHOLDER const _Placeholder<27> _27;
321 _GLIBCXX_PLACEHOLDER const _Placeholder<28> _28;
322 _GLIBCXX_PLACEHOLDER const _Placeholder<29> _29;
324#undef _GLIBCXX_PLACEHOLDER
328 * Partial specialization of is_placeholder that provides the placeholder
329 * number for the placeholder objects defined by libstdc++.
334 struct is_placeholder<_Placeholder<_Num> >
335 : public integral_constant<int, _Num>
339 struct is_placeholder<const _Placeholder<_Num> >
340 : public integral_constant<int, _Num>
343 /// @cond undocumented
345 // Like tuple_element_t but SFINAE-friendly.
346 template<std::size_t __i, typename _Tuple>
347 using _Safe_tuple_element_t
348 = typename enable_if<(__i < tuple_size<_Tuple>::value),
349 tuple_element<__i, _Tuple>>::type::type;
352 * Maps an argument to bind() into an actual argument to the bound
353 * function object [func.bind.bind]/10. Only the first parameter should
354 * be specified: the rest are used to determine among the various
355 * implementations. Note that, although this class is a function
356 * object, it isn't entirely normal because it takes only two
357 * parameters regardless of the number of parameters passed to the
358 * bind expression. The first parameter is the bound argument and
359 * the second parameter is a tuple containing references to the
360 * rest of the arguments.
362 template<typename _Arg,
363 bool _IsBindExp = is_bind_expression<_Arg>::value,
364 bool _IsPlaceholder = (is_placeholder<_Arg>::value > 0)>
368 * If the argument is reference_wrapper<_Tp>, returns the
369 * underlying reference.
370 * C++11 [func.bind.bind] p10 bullet 1.
372 template<typename _Tp>
373 class _Mu<reference_wrapper<_Tp>, false, false>
376 /* Note: This won't actually work for const volatile
377 * reference_wrappers, because reference_wrapper::get() is const
378 * but not volatile-qualified. This might be a defect in the TR.
380 template<typename _CVRef, typename _Tuple>
383 operator()(_CVRef& __arg, _Tuple&) const volatile
384 { return __arg.get(); }
388 * If the argument is a bind expression, we invoke the underlying
389 * function object with the same cv-qualifiers as we are given and
390 * pass along all of our arguments (unwrapped).
391 * C++11 [func.bind.bind] p10 bullet 2.
393 template<typename _Arg>
394 class _Mu<_Arg, true, false>
397 template<typename _CVArg, typename... _Args>
400 operator()(_CVArg& __arg,
401 tuple<_Args...>& __tuple) const volatile
402 -> decltype(__arg(declval<_Args>()...))
404 // Construct an index tuple and forward to __call
405 typedef typename _Build_index_tuple<sizeof...(_Args)>::__type
407 return this->__call(__arg, __tuple, _Indexes());
411 // Invokes the underlying function object __arg by unpacking all
412 // of the arguments in the tuple.
413 template<typename _CVArg, typename... _Args, std::size_t... _Indexes>
416 __call(_CVArg& __arg, tuple<_Args...>& __tuple,
417 const _Index_tuple<_Indexes...>&) const volatile
418 -> decltype(__arg(declval<_Args>()...))
420 return __arg(std::get<_Indexes>(std::move(__tuple))...);
425 * If the argument is a placeholder for the Nth argument, returns
426 * a reference to the Nth argument to the bind function object.
427 * C++11 [func.bind.bind] p10 bullet 3.
429 template<typename _Arg>
430 class _Mu<_Arg, false, true>
433 template<typename _Tuple>
435 _Safe_tuple_element_t<(is_placeholder<_Arg>::value - 1), _Tuple>&&
436 operator()(const volatile _Arg&, _Tuple& __tuple) const volatile
439 ::std::get<(is_placeholder<_Arg>::value - 1)>(std::move(__tuple));
444 * If the argument is just a value, returns a reference to that
445 * value. The cv-qualifiers on the reference are determined by the caller.
446 * C++11 [func.bind.bind] p10 bullet 4.
448 template<typename _Arg>
449 class _Mu<_Arg, false, false>
452 template<typename _CVArg, typename _Tuple>
455 operator()(_CVArg&& __arg, _Tuple&) const volatile
456 { return std::forward<_CVArg>(__arg); }
459 // std::get<I> for volatile-qualified tuples
460 template<std::size_t _Ind, typename... _Tp>
462 __volget(volatile tuple<_Tp...>& __tuple)
463 -> __tuple_element_t<_Ind, tuple<_Tp...>> volatile&
464 { return std::get<_Ind>(const_cast<tuple<_Tp...>&>(__tuple)); }
466 // std::get<I> for const-volatile-qualified tuples
467 template<std::size_t _Ind, typename... _Tp>
469 __volget(const volatile tuple<_Tp...>& __tuple)
470 -> __tuple_element_t<_Ind, tuple<_Tp...>> const volatile&
471 { return std::get<_Ind>(const_cast<const tuple<_Tp...>&>(__tuple)); }
475#if __cplusplus == 201703L && _GLIBCXX_USE_DEPRECATED
476# define _GLIBCXX_VOLATILE_BIND
477// _GLIBCXX_RESOLVE_LIB_DEFECTS
478// 2487. bind() should be const-overloaded, not cv-overloaded
479# define _GLIBCXX_DEPR_BIND \
480 [[deprecated("std::bind does not support volatile in C++17")]]
481#elif __cplusplus < 201703L
482# define _GLIBCXX_VOLATILE_BIND
483# define _GLIBCXX_DEPR_BIND
486 /// Type of the function object returned from bind().
487 template<typename _Signature>
490 template<typename _Functor, typename... _Bound_args>
491 class _Bind<_Functor(_Bound_args...)>
492 : public _Weak_result_type<_Functor>
494 typedef typename _Build_index_tuple<sizeof...(_Bound_args)>::__type
498 tuple<_Bound_args...> _M_bound_args;
501 template<typename _Result, typename... _Args, std::size_t... _Indexes>
504 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>)
506 return std::__invoke(_M_f,
507 _Mu<_Bound_args>()(std::get<_Indexes>(_M_bound_args), __args)...
512 template<typename _Result, typename... _Args, std::size_t... _Indexes>
515 __call_c(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) const
517 return std::__invoke(_M_f,
518 _Mu<_Bound_args>()(std::get<_Indexes>(_M_bound_args), __args)...
522#ifdef _GLIBCXX_VOLATILE_BIND
524 template<typename _Result, typename... _Args, std::size_t... _Indexes>
526 __call_v(tuple<_Args...>&& __args,
527 _Index_tuple<_Indexes...>) volatile
529 return std::__invoke(_M_f,
530 _Mu<_Bound_args>()(__volget<_Indexes>(_M_bound_args), __args)...
534 // Call as const volatile
535 template<typename _Result, typename... _Args, std::size_t... _Indexes>
537 __call_c_v(tuple<_Args...>&& __args,
538 _Index_tuple<_Indexes...>) const volatile
540 return std::__invoke(_M_f,
541 _Mu<_Bound_args>()(__volget<_Indexes>(_M_bound_args), __args)...
546 template<typename _BoundArg, typename _CallArgs>
547 using _Mu_type = decltype(
548 _Mu<typename remove_cv<_BoundArg>::type>()(
549 std::declval<_BoundArg&>(), std::declval<_CallArgs&>()) );
551 template<typename _Fn, typename _CallArgs, typename... _BArgs>
553 = typename result_of< _Fn&(_Mu_type<_BArgs, _CallArgs>&&...) >::type;
555 template<typename _CallArgs>
556 using _Res_type = _Res_type_impl<_Functor, _CallArgs, _Bound_args...>;
558 template<typename _CallArgs>
559 using __dependent = typename
560 enable_if<bool(tuple_size<_CallArgs>::value+1), _Functor>::type;
562 template<typename _CallArgs, template<class> class __cv_quals>
563 using _Res_type_cv = _Res_type_impl<
564 typename __cv_quals<__dependent<_CallArgs>>::type,
566 typename __cv_quals<_Bound_args>::type...>;
569 template<typename... _Args>
570 explicit _GLIBCXX20_CONSTEXPR
571 _Bind(const _Functor& __f, _Args&&... __args)
572 : _M_f(__f), _M_bound_args(std::forward<_Args>(__args)...)
575 template<typename... _Args>
576 explicit _GLIBCXX20_CONSTEXPR
577 _Bind(_Functor&& __f, _Args&&... __args)
578 : _M_f(std::move(__f)), _M_bound_args(std::forward<_Args>(__args)...)
581 _Bind(const _Bind&) = default;
582 _Bind(_Bind&&) = default;
585 template<typename... _Args,
586 typename _Result = _Res_type<tuple<_Args...>>>
589 operator()(_Args&&... __args)
591 return this->__call<_Result>(
592 std::forward_as_tuple(std::forward<_Args>(__args)...),
597 template<typename... _Args,
598 typename _Result = _Res_type_cv<tuple<_Args...>, add_const>>
601 operator()(_Args&&... __args) const
603 return this->__call_c<_Result>(
604 std::forward_as_tuple(std::forward<_Args>(__args)...),
608#ifdef _GLIBCXX_VOLATILE_BIND
610 template<typename... _Args,
611 typename _Result = _Res_type_cv<tuple<_Args...>, add_volatile>>
614 operator()(_Args&&... __args) volatile
616 return this->__call_v<_Result>(
617 std::forward_as_tuple(std::forward<_Args>(__args)...),
621 // Call as const volatile
622 template<typename... _Args,
623 typename _Result = _Res_type_cv<tuple<_Args...>, add_cv>>
626 operator()(_Args&&... __args) const volatile
628 return this->__call_c_v<_Result>(
629 std::forward_as_tuple(std::forward<_Args>(__args)...),
635 /// Type of the function object returned from bind<R>().
636 template<typename _Result, typename _Signature>
639 template<typename _Result, typename _Functor, typename... _Bound_args>
640 class _Bind_result<_Result, _Functor(_Bound_args...)>
642 typedef typename _Build_index_tuple<sizeof...(_Bound_args)>::__type
646 tuple<_Bound_args...> _M_bound_args;
649 template<typename _Res, typename... _Args, std::size_t... _Indexes>
652 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>)
654 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
655 (std::get<_Indexes>(_M_bound_args), __args)...);
659 template<typename _Res, typename... _Args, std::size_t... _Indexes>
662 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) const
664 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
665 (std::get<_Indexes>(_M_bound_args), __args)...);
668#ifdef _GLIBCXX_VOLATILE_BIND
670 template<typename _Res, typename... _Args, std::size_t... _Indexes>
672 __call(tuple<_Args...>&& __args, _Index_tuple<_Indexes...>) volatile
674 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
675 (__volget<_Indexes>(_M_bound_args), __args)...);
678 // Call as const volatile
679 template<typename _Res, typename... _Args, std::size_t... _Indexes>
681 __call(tuple<_Args...>&& __args,
682 _Index_tuple<_Indexes...>) const volatile
684 return std::__invoke_r<_Res>(_M_f, _Mu<_Bound_args>()
685 (__volget<_Indexes>(_M_bound_args), __args)...);
690 typedef _Result result_type;
692 template<typename... _Args>
693 explicit _GLIBCXX20_CONSTEXPR
694 _Bind_result(const _Functor& __f, _Args&&... __args)
695 : _M_f(__f), _M_bound_args(std::forward<_Args>(__args)...)
698 template<typename... _Args>
699 explicit _GLIBCXX20_CONSTEXPR
700 _Bind_result(_Functor&& __f, _Args&&... __args)
701 : _M_f(std::move(__f)), _M_bound_args(std::forward<_Args>(__args)...)
704 _Bind_result(const _Bind_result&) = default;
705 _Bind_result(_Bind_result&&) = default;
708 template<typename... _Args>
711 operator()(_Args&&... __args)
713 return this->__call<_Result>(
714 std::forward_as_tuple(std::forward<_Args>(__args)...),
719 template<typename... _Args>
722 operator()(_Args&&... __args) const
724 return this->__call<_Result>(
725 std::forward_as_tuple(std::forward<_Args>(__args)...),
729#ifdef _GLIBCXX_VOLATILE_BIND
731 template<typename... _Args>
734 operator()(_Args&&... __args) volatile
736 return this->__call<_Result>(
737 std::forward_as_tuple(std::forward<_Args>(__args)...),
741 // Call as const volatile
742 template<typename... _Args>
745 operator()(_Args&&... __args) const volatile
747 return this->__call<_Result>(
748 std::forward_as_tuple(std::forward<_Args>(__args)...),
752 template<typename... _Args>
753 void operator()(_Args&&...) const volatile = delete;
757#undef _GLIBCXX_VOLATILE_BIND
758#undef _GLIBCXX_DEPR_BIND
761 * @brief Class template _Bind is always a bind expression.
764 template<typename _Signature>
765 struct is_bind_expression<_Bind<_Signature> >
766 : public true_type { };
769 * @brief Class template _Bind is always a bind expression.
772 template<typename _Signature>
773 struct is_bind_expression<const _Bind<_Signature> >
774 : public true_type { };
777 * @brief Class template _Bind is always a bind expression.
780 template<typename _Signature>
781 struct is_bind_expression<volatile _Bind<_Signature> >
782 : public true_type { };
785 * @brief Class template _Bind is always a bind expression.
788 template<typename _Signature>
789 struct is_bind_expression<const volatile _Bind<_Signature>>
790 : public true_type { };
793 * @brief Class template _Bind_result is always a bind expression.
796 template<typename _Result, typename _Signature>
797 struct is_bind_expression<_Bind_result<_Result, _Signature>>
798 : public true_type { };
801 * @brief Class template _Bind_result is always a bind expression.
804 template<typename _Result, typename _Signature>
805 struct is_bind_expression<const _Bind_result<_Result, _Signature>>
806 : public true_type { };
809 * @brief Class template _Bind_result is always a bind expression.
812 template<typename _Result, typename _Signature>
813 struct is_bind_expression<volatile _Bind_result<_Result, _Signature>>
814 : public true_type { };
817 * @brief Class template _Bind_result is always a bind expression.
820 template<typename _Result, typename _Signature>
821 struct is_bind_expression<const volatile _Bind_result<_Result, _Signature>>
822 : public true_type { };
824 template<typename _Func, typename... _BoundArgs>
825 struct _Bind_check_arity { };
827 template<typename _Ret, typename... _Args, typename... _BoundArgs>
828 struct _Bind_check_arity<_Ret (*)(_Args...), _BoundArgs...>
830 static_assert(sizeof...(_BoundArgs) == sizeof...(_Args),
831 "Wrong number of arguments for function");
834 template<typename _Ret, typename... _Args, typename... _BoundArgs>
835 struct _Bind_check_arity<_Ret (*)(_Args......), _BoundArgs...>
837 static_assert(sizeof...(_BoundArgs) >= sizeof...(_Args),
838 "Wrong number of arguments for function");
841 template<typename _Tp, typename _Class, typename... _BoundArgs>
842 struct _Bind_check_arity<_Tp _Class::*, _BoundArgs...>
844 using _Arity = typename _Mem_fn<_Tp _Class::*>::_Arity;
845 using _Varargs = typename _Mem_fn<_Tp _Class::*>::_Varargs;
846 static_assert(_Varargs::value
847 ? sizeof...(_BoundArgs) >= _Arity::value + 1
848 : sizeof...(_BoundArgs) == _Arity::value + 1,
849 "Wrong number of arguments for pointer-to-member");
852 // Trait type used to remove std::bind() from overload set via SFINAE
853 // when first argument has integer type, so that std::bind() will
854 // not be a better match than ::bind() from the BSD Sockets API.
855 template<typename _Tp, typename _Tp2 = typename decay<_Tp>::type>
856 using __is_socketlike = __or_<is_integral<_Tp2>, is_enum<_Tp2>>;
858 template<bool _SocketLike, typename _Func, typename... _BoundArgs>
860 : _Bind_check_arity<typename decay<_Func>::type, _BoundArgs...>
862 typedef typename decay<_Func>::type __func_type;
863 typedef _Bind<__func_type(typename decay<_BoundArgs>::type...)> type;
866 // Partial specialization for is_socketlike == true, does not define
867 // nested type so std::bind() will not participate in overload resolution
868 // when the first argument might be a socket file descriptor.
869 template<typename _Func, typename... _BoundArgs>
870 struct _Bind_helper<true, _Func, _BoundArgs...>
874 * @brief Function template for std::bind.
878 template<typename _Func, typename... _BoundArgs>
879 inline _GLIBCXX20_CONSTEXPR typename
880 _Bind_helper<__is_socketlike<_Func>::value, _Func, _BoundArgs...>::type
881 bind(_Func&& __f, _BoundArgs&&... __args)
883 typedef _Bind_helper<false, _Func, _BoundArgs...> __helper_type;
884 return typename __helper_type::type(std::forward<_Func>(__f),
885 std::forward<_BoundArgs>(__args)...);
888 template<typename _Result, typename _Func, typename... _BoundArgs>
889 struct _Bindres_helper
890 : _Bind_check_arity<typename decay<_Func>::type, _BoundArgs...>
892 typedef typename decay<_Func>::type __functor_type;
893 typedef _Bind_result<_Result,
894 __functor_type(typename decay<_BoundArgs>::type...)>
899 * @brief Function template for std::bind<R>.
903 template<typename _Result, typename _Func, typename... _BoundArgs>
904 inline _GLIBCXX20_CONSTEXPR
905 typename _Bindres_helper<_Result, _Func, _BoundArgs...>::type
906 bind(_Func&& __f, _BoundArgs&&... __args)
908 typedef _Bindres_helper<_Result, _Func, _BoundArgs...> __helper_type;
909 return typename __helper_type::type(std::forward<_Func>(__f),
910 std::forward<_BoundArgs>(__args)...);
913#if __cplusplus > 201703L
914#define __cpp_lib_bind_front 201907L
916 template<typename _Fd, typename... _BoundArgs>
919 static_assert(is_move_constructible_v<_Fd>);
920 static_assert((is_move_constructible_v<_BoundArgs> && ...));
922 // First parameter is to ensure this constructor is never used
923 // instead of the copy/move constructor.
924 template<typename _Fn, typename... _Args>
926 _Bind_front(int, _Fn&& __fn, _Args&&... __args)
927 noexcept(__and_<is_nothrow_constructible<_Fd, _Fn>,
928 is_nothrow_constructible<_BoundArgs, _Args>...>::value)
929 : _M_fd(std::forward<_Fn>(__fn)),
930 _M_bound_args(std::forward<_Args>(__args)...)
931 { static_assert(sizeof...(_Args) == sizeof...(_BoundArgs)); }
933 _Bind_front(const _Bind_front&) = default;
934 _Bind_front(_Bind_front&&) = default;
935 _Bind_front& operator=(const _Bind_front&) = default;
936 _Bind_front& operator=(_Bind_front&&) = default;
937 ~_Bind_front() = default;
939 template<typename... _CallArgs>
941 invoke_result_t<_Fd&, _BoundArgs&..., _CallArgs...>
942 operator()(_CallArgs&&... __call_args) &
943 noexcept(is_nothrow_invocable_v<_Fd&, _BoundArgs&..., _CallArgs...>)
945 return _S_call(*this, _BoundIndices(),
946 std::forward<_CallArgs>(__call_args)...);
949 template<typename... _CallArgs>
951 invoke_result_t<const _Fd&, const _BoundArgs&..., _CallArgs...>
952 operator()(_CallArgs&&... __call_args) const &
953 noexcept(is_nothrow_invocable_v<const _Fd&, const _BoundArgs&...,
956 return _S_call(*this, _BoundIndices(),
957 std::forward<_CallArgs>(__call_args)...);
960 template<typename... _CallArgs>
962 invoke_result_t<_Fd, _BoundArgs..., _CallArgs...>
963 operator()(_CallArgs&&... __call_args) &&
964 noexcept(is_nothrow_invocable_v<_Fd, _BoundArgs..., _CallArgs...>)
966 return _S_call(std::move(*this), _BoundIndices(),
967 std::forward<_CallArgs>(__call_args)...);
970 template<typename... _CallArgs>
972 invoke_result_t<const _Fd, const _BoundArgs..., _CallArgs...>
973 operator()(_CallArgs&&... __call_args) const &&
974 noexcept(is_nothrow_invocable_v<const _Fd, const _BoundArgs...,
977 return _S_call(std::move(*this), _BoundIndices(),
978 std::forward<_CallArgs>(__call_args)...);
982 using _BoundIndices = index_sequence_for<_BoundArgs...>;
984 template<typename _Tp, size_t... _Ind, typename... _CallArgs>
987 _S_call(_Tp&& __g, index_sequence<_Ind...>, _CallArgs&&... __call_args)
989 return std::invoke(std::forward<_Tp>(__g)._M_fd,
990 std::get<_Ind>(std::forward<_Tp>(__g)._M_bound_args)...,
991 std::forward<_CallArgs>(__call_args)...);
994 [[no_unique_address]] _Fd _M_fd;
995 [[no_unique_address]] std::tuple<_BoundArgs...> _M_bound_args;
998 // Avoid the overhead of an empty tuple<> if there are no bound args.
999 template<typename _Fd>
1002 static_assert(is_move_constructible_v<_Fd>);
1004 // First parameter is to ensure this constructor is never used
1005 // instead of the copy/move constructor.
1006 template<typename _Fn>
1008 _Bind_front0(int, _Fn&& __fn)
1009 noexcept(is_nothrow_constructible_v<_Fd, _Fn>)
1010 : _M_fd(std::forward<_Fn>(__fn))
1013 _Bind_front0(const _Bind_front0&) = default;
1014 _Bind_front0(_Bind_front0&&) = default;
1015 _Bind_front0& operator=(const _Bind_front0&) = default;
1016 _Bind_front0& operator=(_Bind_front0&&) = default;
1017 ~_Bind_front0() = default;
1019 template<typename... _CallArgs>
1021 invoke_result_t<_Fd&, _CallArgs...>
1022 operator()(_CallArgs&&... __call_args) &
1023 noexcept(is_nothrow_invocable_v<_Fd&, _CallArgs...>)
1024 { return std::invoke(_M_fd, std::forward<_CallArgs>(__call_args)...); }
1026 template<typename... _CallArgs>
1028 invoke_result_t<const _Fd&, _CallArgs...>
1029 operator()(_CallArgs&&... __call_args) const &
1030 noexcept(is_nothrow_invocable_v<const _Fd&, _CallArgs...>)
1031 { return std::invoke(_M_fd, std::forward<_CallArgs>(__call_args)...); }
1033 template<typename... _CallArgs>
1035 invoke_result_t<_Fd, _CallArgs...>
1036 operator()(_CallArgs&&... __call_args) &&
1037 noexcept(is_nothrow_invocable_v<_Fd, _CallArgs...>)
1039 return std::invoke(std::move(_M_fd),
1040 std::forward<_CallArgs>(__call_args)...);
1043 template<typename... _CallArgs>
1045 invoke_result_t<const _Fd, _CallArgs...>
1046 operator()(_CallArgs&&... __call_args) const &&
1047 noexcept(is_nothrow_invocable_v<const _Fd, _CallArgs...>)
1049 return std::invoke(std::move(_M_fd),
1050 std::forward<_CallArgs>(__call_args)...);
1054 [[no_unique_address]] _Fd _M_fd;
1057 template<typename _Fn, typename... _Args>
1059 = __conditional_t<sizeof...(_Args) == 0, _Bind_front0<decay_t<_Fn>>,
1060 _Bind_front<decay_t<_Fn>, decay_t<_Args>...>>;
1062 /** Create call wrapper by partial application of arguments to function.
1064 * The result of `std::bind_front(f, args...)` is a function object that
1065 * stores `f` and the bound arguments, `args...`. When that function
1066 * object is invoked with `call_args...` it returns the result of calling
1067 * `f(args..., call_args...)`.
1071 template<typename _Fn, typename... _Args>
1072 constexpr _Bind_front_t<_Fn, _Args...>
1073 bind_front(_Fn&& __fn, _Args&&... __args)
1074 noexcept(is_nothrow_constructible_v<_Bind_front_t<_Fn, _Args...>,
1075 int, _Fn, _Args...>)
1077 return _Bind_front_t<_Fn, _Args...>(0, std::forward<_Fn>(__fn),
1078 std::forward<_Args>(__args)...);
1082#if __cplusplus >= 201402L
1083 /// Generalized negator.
1084 template<typename _Fn>
1087 template<typename _Fn2, typename... _Args>
1088 using __inv_res_t = typename __invoke_result<_Fn2, _Args...>::type;
1090 template<typename _Tp>
1091 static decltype(!std::declval<_Tp>())
1092 _S_not() noexcept(noexcept(!std::declval<_Tp>()));
1095 template<typename _Fn2>
1097 _Not_fn(_Fn2&& __fn, int)
1098 : _M_fn(std::forward<_Fn2>(__fn)) { }
1100 _Not_fn(const _Not_fn& __fn) = default;
1101 _Not_fn(_Not_fn&& __fn) = default;
1102 ~_Not_fn() = default;
1104 // Macro to define operator() with given cv-qualifiers ref-qualifiers,
1105 // forwarding _M_fn and the function arguments with the same qualifiers,
1106 // and deducing the return type and exception-specification.
1107#define _GLIBCXX_NOT_FN_CALL_OP( _QUALS ) \
1108 template<typename... _Args> \
1109 _GLIBCXX20_CONSTEXPR \
1110 decltype(_S_not<__inv_res_t<_Fn _QUALS, _Args...>>()) \
1111 operator()(_Args&&... __args) _QUALS \
1112 noexcept(__is_nothrow_invocable<_Fn _QUALS, _Args...>::value \
1113 && noexcept(_S_not<__inv_res_t<_Fn _QUALS, _Args...>>())) \
1115 return !std::__invoke(std::forward< _Fn _QUALS >(_M_fn), \
1116 std::forward<_Args>(__args)...); \
1118 _GLIBCXX_NOT_FN_CALL_OP( & )
1119 _GLIBCXX_NOT_FN_CALL_OP( const & )
1120 _GLIBCXX_NOT_FN_CALL_OP( && )
1121 _GLIBCXX_NOT_FN_CALL_OP( const && )
1122#undef _GLIBCXX_NOT_FN_CALL_OP
1128 template<typename _Tp, typename _Pred>
1129 struct __is_byte_like : false_type { };
1131 template<typename _Tp>
1132 struct __is_byte_like<_Tp, equal_to<_Tp>>
1133 : __bool_constant<sizeof(_Tp) == 1 && is_integral<_Tp>::value> { };
1135 template<typename _Tp>
1136 struct __is_byte_like<_Tp, equal_to<void>>
1137 : __bool_constant<sizeof(_Tp) == 1 && is_integral<_Tp>::value> { };
1139#if __cplusplus >= 201703L
1140 // Declare std::byte (full definition is in <cstddef>).
1141 enum class byte : unsigned char;
1144 struct __is_byte_like<byte, equal_to<byte>>
1148 struct __is_byte_like<byte, equal_to<void>>
1151 // [func.not_fn] Function template not_fn
1152#define __cpp_lib_not_fn 201603L
1153 /** Wrap a function object to create one that negates its result.
1155 * The function template `std::not_fn` creates a "forwarding call wrapper",
1156 * which is a function object that wraps another function object and
1157 * when called, forwards its arguments to the wrapped function object.
1159 * The result of invoking the wrapper is the negation (using `!`) of
1160 * the wrapped function object.
1165 template<typename _Fn>
1166 _GLIBCXX20_CONSTEXPR
1169 noexcept(std::is_nothrow_constructible<std::decay_t<_Fn>, _Fn&&>::value)
1171 return _Not_fn<std::decay_t<_Fn>>{std::forward<_Fn>(__fn), 0};
1176 template<typename _ForwardIterator1, typename _BinaryPredicate = equal_to<>>
1177 class default_searcher
1180 _GLIBCXX20_CONSTEXPR
1181 default_searcher(_ForwardIterator1 __pat_first,
1182 _ForwardIterator1 __pat_last,
1183 _BinaryPredicate __pred = _BinaryPredicate())
1184 : _M_m(__pat_first, __pat_last, std::move(__pred))
1187 template<typename _ForwardIterator2>
1188 _GLIBCXX20_CONSTEXPR
1189 pair<_ForwardIterator2, _ForwardIterator2>
1190 operator()(_ForwardIterator2 __first, _ForwardIterator2 __last) const
1192 _ForwardIterator2 __first_ret =
1193 std::search(__first, __last, std::get<0>(_M_m), std::get<1>(_M_m),
1195 auto __ret = std::make_pair(__first_ret, __first_ret);
1196 if (__ret.first != __last)
1197 std::advance(__ret.second, std::distance(std::get<0>(_M_m),
1198 std::get<1>(_M_m)));
1203 tuple<_ForwardIterator1, _ForwardIterator1, _BinaryPredicate> _M_m;
1207#define __cpp_lib_boyer_moore_searcher 201603L
1209 template<typename _Key, typename _Tp, typename _Hash, typename _Pred>
1210 struct __boyer_moore_map_base
1212 template<typename _RAIter>
1213 __boyer_moore_map_base(_RAIter __pat, size_t __patlen,
1214 _Hash&& __hf, _Pred&& __pred)
1215 : _M_bad_char{ __patlen, std::move(__hf), std::move(__pred) }
1218 for (__diff_type __i = 0; __i < __patlen - 1; ++__i)
1219 _M_bad_char[__pat[__i]] = __patlen - 1 - __i;
1222 using __diff_type = _Tp;
1225 _M_lookup(_Key __key, __diff_type __not_found) const
1227 auto __iter = _M_bad_char.find(__key);
1228 if (__iter == _M_bad_char.end())
1230 return __iter->second;
1234 _M_pred() const { return _M_bad_char.key_eq(); }
1236 _GLIBCXX_STD_C::unordered_map<_Key, _Tp, _Hash, _Pred> _M_bad_char;
1239 template<typename _Tp, size_t _Len, typename _Pred>
1240 struct __boyer_moore_array_base
1242 template<typename _RAIter, typename _Unused>
1243 __boyer_moore_array_base(_RAIter __pat, size_t __patlen,
1244 _Unused&&, _Pred&& __pred)
1245 : _M_bad_char{ array<_Tp, _Len>{}, std::move(__pred) }
1247 std::get<0>(_M_bad_char).fill(__patlen);
1249 for (__diff_type __i = 0; __i < __patlen - 1; ++__i)
1251 auto __ch = __pat[__i];
1252 using _UCh = make_unsigned_t<decltype(__ch)>;
1253 auto __uch = static_cast<_UCh>(__ch);
1254 std::get<0>(_M_bad_char)[__uch] = __patlen - 1 - __i;
1258 using __diff_type = _Tp;
1260 template<typename _Key>
1262 _M_lookup(_Key __key, __diff_type __not_found) const
1264 auto __ukey = static_cast<make_unsigned_t<_Key>>(__key);
1267 return std::get<0>(_M_bad_char)[__ukey];
1271 _M_pred() const { return std::get<1>(_M_bad_char); }
1273 tuple<array<_Tp, _Len>, _Pred> _M_bad_char;
1276 // Use __boyer_moore_array_base when pattern consists of narrow characters
1277 // (or std::byte) and uses std::equal_to as the predicate.
1278 template<typename _RAIter, typename _Hash, typename _Pred,
1279 typename _Val = typename iterator_traits<_RAIter>::value_type,
1280 typename _Diff = typename iterator_traits<_RAIter>::difference_type>
1281 using __boyer_moore_base_t
1282 = __conditional_t<__is_byte_like<_Val, _Pred>::value,
1283 __boyer_moore_array_base<_Diff, 256, _Pred>,
1284 __boyer_moore_map_base<_Val, _Diff, _Hash, _Pred>>;
1286 template<typename _RAIter, typename _Hash
1287 = hash<typename iterator_traits<_RAIter>::value_type>,
1288 typename _BinaryPredicate = equal_to<>>
1289 class boyer_moore_searcher
1290 : __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>
1292 using _Base = __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>;
1293 using typename _Base::__diff_type;
1296 boyer_moore_searcher(_RAIter __pat_first, _RAIter __pat_last,
1297 _Hash __hf = _Hash(),
1298 _BinaryPredicate __pred = _BinaryPredicate());
1300 template<typename _RandomAccessIterator2>
1301 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1302 operator()(_RandomAccessIterator2 __first,
1303 _RandomAccessIterator2 __last) const;
1307 _M_is_prefix(_RAIter __word, __diff_type __len,
1310 const auto& __pred = this->_M_pred();
1311 __diff_type __suffixlen = __len - __pos;
1312 for (__diff_type __i = 0; __i < __suffixlen; ++__i)
1313 if (!__pred(__word[__i], __word[__pos + __i]))
1319 _M_suffix_length(_RAIter __word, __diff_type __len,
1322 const auto& __pred = this->_M_pred();
1323 __diff_type __i = 0;
1324 while (__pred(__word[__pos - __i], __word[__len - 1 - __i])
1332 template<typename _Tp>
1334 _M_bad_char_shift(_Tp __c) const
1335 { return this->_M_lookup(__c, _M_pat_end - _M_pat); }
1339 _GLIBCXX_STD_C::vector<__diff_type> _M_good_suffix;
1342 template<typename _RAIter, typename _Hash
1343 = hash<typename iterator_traits<_RAIter>::value_type>,
1344 typename _BinaryPredicate = equal_to<>>
1345 class boyer_moore_horspool_searcher
1346 : __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>
1348 using _Base = __boyer_moore_base_t<_RAIter, _Hash, _BinaryPredicate>;
1349 using typename _Base::__diff_type;
1352 boyer_moore_horspool_searcher(_RAIter __pat,
1354 _Hash __hf = _Hash(),
1355 _BinaryPredicate __pred
1356 = _BinaryPredicate())
1357 : _Base(__pat, __pat_end - __pat, std::move(__hf), std::move(__pred)),
1358 _M_pat(__pat), _M_pat_end(__pat_end)
1361 template<typename _RandomAccessIterator2>
1362 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1363 operator()(_RandomAccessIterator2 __first,
1364 _RandomAccessIterator2 __last) const
1366 const auto& __pred = this->_M_pred();
1367 auto __patlen = _M_pat_end - _M_pat;
1369 return std::make_pair(__first, __first);
1370 auto __len = __last - __first;
1371 while (__len >= __patlen)
1373 for (auto __scan = __patlen - 1;
1374 __pred(__first[__scan], _M_pat[__scan]); --__scan)
1376 return std::make_pair(__first, __first + __patlen);
1377 auto __shift = _M_bad_char_shift(__first[__patlen - 1]);
1381 return std::make_pair(__last, __last);
1385 template<typename _Tp>
1387 _M_bad_char_shift(_Tp __c) const
1388 { return this->_M_lookup(__c, _M_pat_end - _M_pat); }
1394 template<typename _RAIter, typename _Hash, typename _BinaryPredicate>
1395 boyer_moore_searcher<_RAIter, _Hash, _BinaryPredicate>::
1396 boyer_moore_searcher(_RAIter __pat, _RAIter __pat_end,
1397 _Hash __hf, _BinaryPredicate __pred)
1398 : _Base(__pat, __pat_end - __pat, std::move(__hf), std::move(__pred)),
1399 _M_pat(__pat), _M_pat_end(__pat_end), _M_good_suffix(__pat_end - __pat)
1401 auto __patlen = __pat_end - __pat;
1404 __diff_type __last_prefix = __patlen - 1;
1405 for (__diff_type __p = __patlen - 1; __p >= 0; --__p)
1407 if (_M_is_prefix(__pat, __patlen, __p + 1))
1408 __last_prefix = __p + 1;
1409 _M_good_suffix[__p] = __last_prefix + (__patlen - 1 - __p);
1411 for (__diff_type __p = 0; __p < __patlen - 1; ++__p)
1413 auto __slen = _M_suffix_length(__pat, __patlen, __p);
1414 auto __pos = __patlen - 1 - __slen;
1415 if (!__pred(__pat[__p - __slen], __pat[__pos]))
1416 _M_good_suffix[__pos] = __patlen - 1 - __p + __slen;
1420 template<typename _RAIter, typename _Hash, typename _BinaryPredicate>
1421 template<typename _RandomAccessIterator2>
1422 pair<_RandomAccessIterator2, _RandomAccessIterator2>
1423 boyer_moore_searcher<_RAIter, _Hash, _BinaryPredicate>::
1424 operator()(_RandomAccessIterator2 __first,
1425 _RandomAccessIterator2 __last) const
1427 auto __patlen = _M_pat_end - _M_pat;
1429 return std::make_pair(__first, __first);
1430 const auto& __pred = this->_M_pred();
1431 __diff_type __i = __patlen - 1;
1432 auto __stringlen = __last - __first;
1433 while (__i < __stringlen)
1435 __diff_type __j = __patlen - 1;
1436 while (__j >= 0 && __pred(__first[__i], _M_pat[__j]))
1443 const auto __match = __first + __i + 1;
1444 return std::make_pair(__match, __match + __patlen);
1446 __i += std::max(_M_bad_char_shift(__first[__i]),
1447 _M_good_suffix[__j]);
1449 return std::make_pair(__last, __last);
1457_GLIBCXX_END_NAMESPACE_VERSION
1460#endif // _GLIBCXX_FUNCTIONAL