Classe function

Wrapper per un oggetto chiamabile.

Sintassi

template <class Fty>
class function  // Fty of type Ret(T1, T2, ..., TN)
    : public unary_function<T1, Ret>       // when Fty is Ret(T1)
    : public binary_function<T1, T2, Ret>  // when Fty is Ret(T1, T2)
{
public:
    typedef Ret result_type;

    function();
    function(nullptr_t);
    function(const function& right);
    template <class Fty2>
        function(Fty2 fn);
    template <class Fty2, class Alloc>
        function(reference_wrapper<Fty2>, const Alloc& Ax);

    template <class Fty2, class Alloc>
        void assign(Fty2, const Alloc& Ax);
    template <class Fty2, class Alloc>
        void assign(reference_wrapper<Fty2>, const Alloc& Ax);
    function& operator=(nullptr_t);
    function& operator=(const function&);
    template <class Fty2>
        function& operator=(Fty2);
    template <class Fty2>
        function& operator=(reference_wrapper<Fty2>);

    void swap(function&);
    explicit operator bool() const;

    result_type operator()(T1, T2, ....., TN) const;
    const std::type_info& target_type() const;
    template <class Fty2>
        Fty2 *target();

    template <class Fty2>
        const Fty2 *target() const;

    template <class Fty2>
        void operator==(const Fty2&) const = delete;
    template <class Fty2>
        void operator!=(const Fty2&) const = delete;
};

Parametri

Fty
Tipo di funzione di cui eseguire il wrapping.

Ascia
Funzione allocatore.

Osservazioni:

Il modello di classe è un wrapper di chiamata la cui firma di chiamata è Ret(T1, T2, ..., TN). È possibile usarlo per racchiudere vari oggetti chiamabili in un wrapper uniforme.

Alcune funzioni membro accettano un operando che specifica l'oggetto di destinazione desiderato. È possibile specificare tale operando in diversi modi:

fn: oggetto fnchiamabile ; dopo la chiamata dell'oggetto function contiene una copia di fn

fnref: oggetto chiamabile denominato da fnref.get(); dopo che la chiamata all'oggetto function contiene un riferimento a fnref.get()

right: oggetto chiamabile, se presente, mantenuto dall'oggetto functionright

npc: puntatore Null; dopo la chiamata l'oggetto function è vuoto

In tutti i casi, INVOKE(f, t1, t2, ..., tN), dove f è l'oggetto chiamabile e t1, t2, ..., tN sono rispettivamente lvalue di tipi T1, T2, ..., TN , deve essere ben formato e, se Ret non è void, convertibile in Ret.

Un oggetto vuoto function non contiene un oggetto chiamabile o un riferimento a un oggetto chiamabile.

Membri

Costruttori

Nome	Descrizione
function	Costruisce un wrapper vuoto o in cui è archiviato un oggetto chiamabile di tipo arbitrario con una firma fissa.

Typedef

Nome	Descrizione
result_type	Tipo restituito dell'oggetto chiamabile archiviato.

Funzioni

Nome	Descrizione
assign	Assegna un oggetto chiamabile a questo oggetto funzione.
swap	Scambia due oggetti chiamabili.
target	Verifica se l'oggetto chiamabile archiviato è chiamabile come specificato.
target_type	Ottiene le informazioni sui tipi per l'oggetto chiamabile.

Operatori

Nome	Descrizione
operatore non specificato	Verifica se è presente un oggetto chiamabile archiviato.
operator()	Chiama un oggetto chiamabile.
operator=	Sostituisce l'oggetto chiamabile archiviato.

assign

Assegna un oggetto chiamabile a questo oggetto funzione.

template <class Fx, class Alloc>
    void assign(
        Fx _Func,
        const Alloc& Ax);

template <class Fx, class Alloc>
    void assign(
        reference_wrapper<Fx> _Fnref,
        const Alloc& Ax);

Parametri

_Func
Oggetto chiamabile.

_Fnref
Wrapper di riferimento che contiene un oggetto chiamabile.

Ascia
Un oggetto allocatore.

Osservazioni:

Ogni funzione membro sostituisce l'oggetto callable object incluso in *this con l'oggetto chiamabile passato come operand. Entrambe allocano l'archiviazione con l'oggetto allocatore Ax.

function

Costruisce un wrapper vuoto o in cui è archiviato un oggetto chiamabile di tipo arbitrario con una firma fissa.

function();
function(nullptr_t npc);
function(const function& right);
template <class Fx>
    function(Fx _Func);
template <class Fx>
    function(reference_wrapper<Fx> _Fnref);
template <class Fx, class Alloc>
    function(
        Fx _Func,
        const Alloc& Ax);

template <class Fx, class Alloc>
    function(
        reference_wrapper<Fx> _Fnref,
        const Alloc& Ax);

Parametri

right
Oggetto funzione da copiare.

Fx
Tipo di oggetto chiamabile.

_Func
Oggetto chiamabile di cui eseguire il wrapping.

Alloc
Tipo di allocatore.

Ascia
Allocatore.

_Fnref
Riferimento all'oggetto chiamabile di cui eseguire il wrapping.

Osservazioni:

I primi due costruttori costruiscono un oggetto function vuoto. I tre costruttori successivi costruiscono un oggetto function che include l'oggetto chiamabile passato come operando. Gli ultimi due costruttori allocano memoria con l'oggetto allocatore Ax.

Esempio

// std__functional__function_function.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>
#include <vector>

int square(int val)
{
    return val * val;
}

class multiply_by
{
public:
    explicit multiply_by(const int n) : m_n(n) { }

    int operator()(const int x) const
    {
        return m_n * x;
    }

private:
    int m_n;
};

int main()
{
    typedef std::vector< std::function<int (int)> > vf_t;

    vf_t v;
    v.push_back(square);
    v.push_back(std::negate<int>());
    v.push_back(multiply_by(3));

    for (vf_t::const_iterator i = v.begin(); i != v.end(); ++i)
    {
        std::cout << (*i)(10) << std::endl;
    }

    std::function<int (int)> f = v[0];
    std::function<int (int)> g;

    if (f) {
        std::cout << "f is non-empty (correct)." << std::endl;
    } else {
        std::cout << "f is empty (can't happen)." << std::endl;
    }

    if (g) {
        std::cout << "g is non-empty (can't happen)." << std::endl;
    } else {
        std::cout << "g is empty (correct)." << std::endl;
    }

    return 0;
}

100
-10
30
f is non-empty (correct).
g is empty (correct).

operatore non specificato

Verifica se è presente un oggetto chiamabile archiviato.

operator unspecified();

Osservazioni:

L'operatore restituisce un valore convertibile in bool con un valore true solo se l'oggetto non è vuoto. Può essere usato per verificare se l'oggetto è vuoto.

Esempio

// std__functional__function_operator_bool.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn0;
    std::cout << std::boolalpha << "not empty == " << (bool)fn0 << std::endl;

    std::function<int (int)> fn1(neg);
    std::cout << std::boolalpha << "not empty == " << (bool)fn1 << std::endl;

    return (0);
    }

not empty == false
not empty == true

operator()

Chiama un oggetto chiamabile.

result_type operator()(
    T1 t1,
    T2 t2, ...,
    TN tN);

Parametri

TN
Tipo dell'ennesimo argomento di chiamata.

Tn
Ennesimo argomento di chiamata.

Osservazioni:

La funzione membro restituisce INVOKE(fn, t1, t2, ..., tN, Ret), dove fn è l'oggetto di destinazione archiviato in *this. Usarla per chiamare l'oggetto chiamabile di cui è stato eseguito il wrapping.

Esempio

// std__functional__function_operator_call.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn1(neg);
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "val == " << fn1(3) << std::endl;

    return (0);
    }

empty == false
val == -3

operator=

Sostituisce l'oggetto chiamabile archiviato.

function& operator=(null_ptr_type npc);
function& operator=(const function& right);
template <class Fty>
    function& operator=(Fty fn);
template <class Fty>
    function& operator=(reference_wrapper<Fty> fnref);

Parametri

Npc
Costante puntatore Null.

right
Oggetto funzione da copiare.

Fn
Oggetto chiamabile di cui eseguire il wrapping.

fnref
Riferimento all'oggetto chiamabile di cui eseguire il wrapping.

Osservazioni:

Ogni operatore sostituisce l'oggetto chiamabile incluso in *this con l'oggetto chiamabile passato come operando.

Esempio

// std__functional__function_operator_as.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn0(neg);
    std::cout << std::boolalpha << "empty == " << !fn0 << std::endl;
    std::cout << "val == " << fn0(3) << std::endl;

    std::function<int (int)> fn1;
    fn1 = 0;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;

    fn1 = neg;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "val == " << fn1(3) << std::endl;

    fn1 = fn0;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "val == " << fn1(3) << std::endl;

    fn1 = std::cref(fn1);
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "val == " << fn1(3) << std::endl;

    return (0);
    }

empty == false
val == -3
empty == true
empty == false
val == -3
empty == false
val == -3
empty == false
val == -3

result_type

Tipo restituito dell'oggetto chiamabile archiviato.

typedef Ret result_type;

Osservazioni:

Il typedef è un sinonimo del tipo Ret nella firma di chiamata del modello. Usarlo per determinare il tipo restituito dell'oggetto chiamabile di cui è stato eseguito il wrapping.

Esempio

// std__functional__function_result_type.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn1(neg);
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;

    std::function<int (int)>::result_type val = fn1(3);
    std::cout << "val == " << val << std::endl;

    return (0);
    }

empty == false
val == -3

scambio

Scambia due oggetti chiamabili.

void swap(function& right);

Parametri

right
Oggetto funzione con cui eseguire lo scambio.

Osservazioni:

La funzione membro scambia gli oggetti di destinazione tra *this e a destra. Esegue tale operazione in un tempo costante e non genera eccezioni.

Esempio

// std__functional__function_swap.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn0(neg);
    std::cout << std::boolalpha << "empty == " << !fn0 << std::endl;
    std::cout << "val == " << fn0(3) << std::endl;

    std::function<int (int)> fn1;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << std::endl;

    fn0.swap(fn1);
    std::cout << std::boolalpha << "empty == " << !fn0 << std::endl;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "val == " << fn1(3) << std::endl;

    return (0);
    }

empty == false
val == -3
empty == true

empty == true
empty == false
val == -3

bersaglio

Verifica se l'oggetto chiamabile archiviato è chiamabile come specificato.

template <class Fty2>
    Fty2 *target();
template <class Fty2>
    const Fty2 *target() const;

Parametri

Fty2
Tipo di oggetto chiamabile di destinazione da verificare.

Osservazioni:

Il tipo Fty2 deve essere chiamabile per i tipi di T1, T2, ..., TN argomento e il tipo Retrestituito . Se target_type() == typeid(Fty2), la funzione modello membro restituisce l'indirizzo dell'oggetto di destinazione; in caso contrario, restituisce 0.

Un tipo Fty2 è chiamabile per i tipi T1, T2, ..., TN di argomento e il tipo Ret restituito se, rispettivamente per lvalue fn, t1, t2, ..., tN di tipi Fty2, T1, T2, ..., TN, INVOKE(fn, t1, t2, ..., tN) è ben formato e, se Ret non voidè , convertibile in Ret.

Esempio

// std__functional__function_target.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    typedef int (*Myfun)(int);
    std::function<int (int)> fn0(neg);
    std::cout << std::boolalpha << "empty == " << !fn0 << std::endl;
    std::cout << "no target == " << (fn0.target<Myfun>() == 0) << std::endl;

    Myfun *fptr = fn0.target<Myfun>();
    std::cout << "val == " << (*fptr)(3) << std::endl;

    std::function<int (int)> fn1;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "no target == " << (fn1.target<Myfun>() == 0) << std::endl;

    return (0);
    }

empty == false
no target == false
val == -3
empty == true
no target == true

target_type

Ottiene le informazioni sui tipi per l'oggetto chiamabile.

const std::type_info& target_type() const;

Osservazioni:

La funzione membro restituisce typeid(void) se *this è vuoto, in caso contrario restituisce typeid(T), dove T è il tipo dell'oggetto di destinazione.

Esempio

// std__functional__function_target_type.cpp
// compile with: /EHsc
#include <functional>
#include <iostream>

int neg(int val)
    {
    return (-val);
    }

int main()
    {
    std::function<int (int)> fn0(neg);
    std::cout << std::boolalpha << "empty == " << !fn0 << std::endl;
    std::cout << "type == " << fn0.target_type().name() << std::endl;

    std::function<int (int)> fn1;
    std::cout << std::boolalpha << "empty == " << !fn1 << std::endl;
    std::cout << "type == " << fn1.target_type().name() << std::endl;

    return (0);
    }

empty == false
type == int (__cdecl*)(int)
empty == true
type == void