std::function< _Res(_ArgTypes...)> Class Template Reference
Primary class template for std::function.Polymorphic function wrapper. More...
Public Types
Public Member Functions
- function () noexcept
- function (nullptr_t) noexcept
- function (function &&__x)
- template<typename _Functor > function (_Functor __f, typename enable_if< !is_integral< _Functor >::value, _Useless >::type=_Useless())
- function (const function &__x)
- operator bool () const noexcept
- _Res operator() (_ArgTypes...__args) const
- function & operator= (nullptr_t)
- template<typename _Functor > enable_if<!is_integral
< _Functor >::value, function & >
::type operator= (_Functor &&__f) - template<typename _Functor > enable_if<!is_integral
< _Functor >::value, function & >
::type operator= (reference_wrapper< _Functor > __f) noexcept - function & operator= (function &&__x)
- function & operator= (const function &__x)
- void swap (function &__x)
- template<typename _Functor > _Functor * target () noexcept
- template<typename _Functor > const _Functor * target () const noexcept
- const type_info & target_type () const noexcept
Private Types
Private Member Functions
Private Attributes
Static Private Attributes
Detailed Description
template<typename _Res, typename... _ArgTypes>
class std::function< _Res(_ArgTypes...)>
Primary class template for std::function.
Polymorphic function wrapper.
Definition at line 2024 of file functional.
Constructor & Destructor Documentation
| std::function< _Res(_ArgTypes...)>::function | ( | ) | [inline] |
Default construct creates an empty function call wrapper.
- Postcondition:
!(bool)*this
Definition at line 2041 of file functional.
| std::function< _Res(_ArgTypes...)>::function | ( | nullptr_t | ) | [inline] |
Creates an empty function call wrapper.
- Postcondition:
!(bool)*this
Definition at line 2048 of file functional.
| std::function< _Res(_ArgTypes...)>::function | ( | const function< _Res(_ArgTypes...)> & | __x | ) |
Function copy constructor.
- Parameters:
-
__x A function object with identical call signature.
- Postcondition:
bool(*this)== bool(__x)
The newly-created function contains a copy of the target of __x (if it has one).
Definition at line 2274 of file functional.
| std::function< _Res(_ArgTypes...)>::function | ( | function< _Res(_ArgTypes...)> && | __x | ) | [inline] |
Function move constructor.
- Parameters:
-
__x A function object rvalue with identical call signature.
The newly-created function contains the target of __x (if it has one).
Definition at line 2068 of file functional.
| std::function< _Res(_ArgTypes...)>::function | ( | _Functor | __f, |
| typename enable_if< !is_integral< _Functor >::value, _Useless >::type | = _Useless() |
||
| ) |
Builds a function that targets a copy of the incoming function object.
- Parameters:
-
__f A function object that is callable with parameters of type T1,T2, ...,TNand returns a value convertible toRes.
The newly-created function object will target a copy of __f. If __f is reference_wrapper<F>, then this function object will contain a reference to the function object __f.get(). If __f is a NULL function pointer or NULL pointer-to-member, the newly-created object will be empty.
If __f is a non-NULL function pointer or an object of type reference_wrapper<F>, this function will not throw.
Definition at line 2288 of file functional.
Member Function Documentation
| std::function< _Res(_ArgTypes...)>::operator bool | ( | ) | const [inline, explicit] |
Determine if the function wrapper has a target.
- Returns:
truewhen this function object contains a target, orfalsewhen it is empty.
This function will not throw an exception.
Definition at line 2223 of file functional.
| _Res std::function< _Res(_ArgTypes...)>::operator() | ( | _ArgTypes... | __args | ) | const |
Invokes the function targeted by *this.
- Returns:
- the result of the target.
- Exceptions:
-
bad_function_call when !(bool)*this
The function call operator invokes the target function object stored by this.
Definition at line 2306 of file functional.
| function& std::function< _Res(_ArgTypes...)>::operator= | ( | function< _Res(_ArgTypes...)> && | __x | ) | [inline] |
Function move-assignment operator.
- Parameters:
-
__x A function rvalue with identical call signature.
- Returns:
*this
The target of __x is moved to *this. If __x has no target, then *this will be empty.
If __x targets a function pointer or a reference to a function object, then this operation will not throw an exception.
Definition at line 2128 of file functional.
| enable_if<!is_integral<_Functor>::value, function&>::type std::function< _Res(_ArgTypes...)>::operator= | ( | _Functor && | __f | ) | [inline] |
Function assignment to a new target.
- Parameters:
-
__f A function object that is callable with parameters of type T1,T2, ...,TNand returns a value convertible toRes.
- Returns:
*this
This function object wrapper will target a copy of __f. If __f is reference_wrapper<F>, then this function object will contain a reference to the function object __f.get(). If __f is a NULL function pointer or NULL pointer-to-member, this object will be empty.
If __f is a non-NULL function pointer or an object of type reference_wrapper<F>, this function will not throw.
Definition at line 2171 of file functional.
| enable_if<!is_integral<_Functor>::value, function&>::type std::function< _Res(_ArgTypes...)>::operator= | ( | reference_wrapper< _Functor > | __f | ) | [inline] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 2180 of file functional.
| function& std::function< _Res(_ArgTypes...)>::operator= | ( | nullptr_t | ) | [inline] |
Function assignment to zero.
- Postcondition:
!(bool)*this
- Returns:
*this
The target of *this is deallocated, leaving it empty.
Definition at line 2142 of file functional.
| function& std::function< _Res(_ArgTypes...)>::operator= | ( | const function< _Res(_ArgTypes...)> & | __x | ) | [inline] |
Function assignment operator.
- Parameters:
-
__x A function with identical call signature.
- Postcondition:
(bool)*this == (bool)x
- Returns:
*this
The target of __x is copied to *this. If __x has no target, then *this will be empty.
If __x targets a function pointer or a reference to a function object, then this operation will not throw an exception.
Definition at line 2110 of file functional.
| void std::function< _Res(_ArgTypes...)>::swap | ( | function< _Res(_ArgTypes...)> & | __x | ) | [inline] |
Swap the targets of two function objects.
- Parameters:
-
__x A function with identical call signature.
Swap the targets of this function object and __f. This function will not throw an exception.
Definition at line 2195 of file functional.
| _Functor * std::function< _Res(_ArgTypes...)>::target | ( | ) |
Access the stored target function object.
- Returns:
- Returns a pointer to the stored target function object, if
typeid(Functor).equals(target_type()); otherwise, a NULL pointer.
This function will not throw an exception.
Definition at line 2333 of file functional.
| const _Functor * std::function< _Res(_ArgTypes...)>::target | ( | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 2352 of file functional.
| const type_info & std::function< _Res(_ArgTypes...)>::target_type | ( | ) | const |
Determine the type of the target of this function object wrapper.
- Returns:
- the type identifier of the target function object, or
typeid(void)if!(bool)*this.
This function will not throw an exception.
Definition at line 2317 of file functional.
The documentation for this class was generated from the following file:
