23 General utilities library [utilities]

23.14 Function objects [function.objects]

23.14.11 Function object binders [func.bind]

This subclause describes a uniform mechanism for binding arguments of callable objects.

23.14.11.1 Class template is_bind_expression [func.bind.isbind]

namespace std {
  template<class T> struct is_bind_expression;  // see below
}

The class template is_bind_expression can be used to detect function objects generated by bind.

The function template bind uses is_bind_expression to detect subexpressions.

Instantiations of the is_bind_expression template shall meet the UnaryTypeTrait requirements ([meta.rqmts]).

The implementation shall provide a definition that has a base characteristic of true_type if T is a type returned from bind, otherwise it shall have a base characteristic of false_type.

A program may specialize this template for a user-defined type T to have a base characteristic of true_type to indicate that T should be treated as a subexpression in a bind call.

23.14.11.2 Class template is_placeholder [func.bind.isplace]

namespace std {
  template<class T> struct is_placeholder;      // see below
}

The class template is_placeholder can be used to detect the standard placeholders _1, _2, and so on.

The function template bind uses is_placeholder to detect placeholders.

Instantiations of the is_placeholder template shall meet the UnaryTypeTrait requirements ([meta.rqmts]).

The implementation shall provide a definition that has the base characteristic of integral_constant<int, J> if T is the type of std::placeholders::_J, otherwise it shall have a base characteristic of integral_constant<int, 0>.

A program may specialize this template for a user-defined type T to have a base characteristic of integral_constant<int, N> with N > 0 to indicate that T should be treated as a placeholder type.

23.14.11.3 Function template bind [func.bind.bind]

In the text that follows:

(1.1)
FD is the type decay_t<F>,
(1.2)
fd is an lvalue of type FD constructed from std::forward<F>(f),
(1.3)
is the type in the template parameter pack BoundArgs,
(1.4)
is the type decay_t<>,
(1.5)
is the argument in the function parameter pack bound_args,
(1.6)
is an lvalue of type constructed from std::forward<>(),
(1.7)
is the deduced type of the UnBoundArgs&&... parameter of the forwarding call wrapper, and
(1.8)
is the argument associated with .

template<class F, class... BoundArgs>
  unspecified bind(F&& f, BoundArgs&&... bound_args);

Requires: is_constructible_v<FD, F> shall be true.

For each in BoundArgs, is_constructible_v<, > shall be true.

INVOKE(fd, , , …, ) ([func.require]) shall be a valid expression for some values , , …, , where N has the value sizeof...(bound_args).

The cv-qualifiers cv of the call wrapper g, as specified below, shall be neither volatile nor const volatile.

Returns: A forwarding call wrapper g ([func.require]).

The effect of g(, , …, ) shall be

INVOKE(fd, std::forward<>(), std::forward<>(), …, std::forward<>())

where the values and types of the bound arguments , , …, are determined as specified below.

The copy constructor and move constructor of the forwarding call wrapper shall throw an exception if and only if the corresponding constructor of FD or of any of the types throws an exception.

Throws: Nothing unless the construction of fd or of one of the values throws an exception.

Remarks: The return type shall satisfy the requirements of MoveConstructible.

If all of FD and satisfy the requirements of CopyConstructible, then the return type shall satisfy the requirements of CopyConstructible.

[ Note

This implies that all of FD and are MoveConstructible.

— end note

]

template<class R, class F, class... BoundArgs>
  unspecified bind(F&& f, BoundArgs&&... bound_args);

Requires: is_constructible_v<FD, F> shall be true.

For each in BoundArgs, is_constructible_v<, > shall be true.

INVOKE(fd, , , …, ) shall be a valid expression for some values , , …, , where N has the value sizeof...(bound_args).

The cv-qualifiers cv of the call wrapper g, as specified below, shall be neither volatile nor const volatile.

Returns: A forwarding call wrapper g ([func.require]).

The effect of g(, , …, ) shall be

INVOKE<R>(fd, std::forward<>(), std::forward<>(), …, std::forward<>())

where the values and types of the bound arguments , , …, are determined as specified below.

The copy constructor and move constructor of the forwarding call wrapper shall throw an exception if and only if the corresponding constructor of FD or of any of the types throws an exception.

Throws: Nothing unless the construction of fd or of one of the values throws an exception.

Remarks: The return type shall satisfy the requirements of MoveConstructible.

If all of FD and satisfy the requirements of CopyConstructible, then the return type shall satisfy the requirements of CopyConstructible.

[ Note

This implies that all of FD and are MoveConstructible.

— end note

]

The values of the bound arguments , , …, and their corresponding types , , …, depend on the types derived from the call to bind and the cv-qualifiers cv of the call wrapper g as follows:

(10.1)
if is reference_wrapper<T>, the argument is .get() and its type is T&;
(10.2)
if the value of is_bind_expression_v<> is true, the argument is (std::forward<>()...) and its type is invoke_result_t< cv &, ...>&&;
(10.3)
if the value j of is_placeholder_v<> is not zero, the argument is std::forward<>() and its type is &&;
(10.4)
otherwise, the value is and its type is cv &.

23.14.11.4 Placeholders [func.bind.place]

namespace std::placeholders {
  // M is the implementation-defined number of placeholders
  see below _1;
  see below _2;
              .
              .
              .
  see below _M;
}

All placeholder types shall be DefaultConstructible and CopyConstructible, and their default constructors and copy/move constructors shall not throw exceptions.

It is implementation-defined whether placeholder types are CopyAssignable.

CopyAssignable placeholders' copy assignment operators shall not throw exceptions.

Placeholders should be defined as:

inline constexpr unspecified _1{};

If they are not, they shall be declared as:

extern unspecified _1;