繁体   English   中英

什么是 C++ 函子及其用途?

[英]What are C++ functors and their uses?

我一直听到很多关于 C++ 中的函子的消息。 有人能给我一个关于它们是什么以及它们在什么情况下有用的概述吗?

函子几乎只是一个定义 operator() 的类。 这使您可以创建“看起来像”函数的对象:

// this is a functor
struct add_x {
  add_x(int val) : x(val) {}  // Constructor
  int operator()(int y) const { return x + y; }

private:
  int x;
};

// Now you can use it like this:
add_x add42(42); // create an instance of the functor class
int i = add42(8); // and "call" it
assert(i == 50); // and it added 42 to its argument

std::vector<int> in; // assume this contains a bunch of values)
std::vector<int> out(in.size());
// Pass a functor to std::transform, which calls the functor on every element 
// in the input sequence, and stores the result to the output sequence
std::transform(in.begin(), in.end(), out.begin(), add_x(1)); 
assert(out[i] == in[i] + 1); // for all i

函子有一些不错的地方。 一是与常规函数不同,它们可以包含状态。 上面的例子创建了一个函数,它把你给的任何东西都加上 42。 但是值 42 不是硬编码的,它在我们创建函子实例时被指定为构造函数参数。 我可以创建另一个加法器,它添加了 27,只需调用具有不同值的构造函数即可。 这使得它们可以很好地定制。

如最后几行所示,您经常将函子作为参数传递给其他函数,例如 std::transform 或其他标准库算法。 您可以对常规函数指针执行相同操作,但正如我上面所说,函子可以“定制”,因为它们包含状态,从而使它们更加灵活(如果我想使用函数指针,我必须编写一个函数它在它的参数中正好加了 1。函子是通用的,并添加了你初始化它的任何东西),而且它们也可能更有效。 在上面的例子中,编译器确切地知道std::transform应该调用哪个函数。 它应该调用add_x::operator() 这意味着它可以内联该函数调用。 这使得它就像我在向量的每个值上手动调用函数一样高效。

如果我传递了一个函数指针,编译器将无法立即看到它指向哪个函数,因此除非它执行一些相当复杂的全局优化,否则它必须在运行时取消引用该指针,然后进行调用。

小补充。 您可以使用boost::function从函数和方法创建函子,如下所示:

class Foo
{
public:
    void operator () (int i) { printf("Foo %d", i); }
};
void Bar(int i) { printf("Bar %d", i); }
Foo foo;
boost::function<void (int)> f(foo);//wrap functor
f(1);//prints "Foo 1"
boost::function<void (int)> b(&Bar);//wrap normal function
b(1);//prints "Bar 1"

你可以使用 boost::bind 向这个函子添加状态

boost::function<void ()> f1 = boost::bind(foo, 2);
f1();//no more argument, function argument stored in f1
//and this print "Foo 2" (:
//and normal function
boost::function<void ()> b1 = boost::bind(&Bar, 2);
b1();// print "Bar 2"

最有用的是,使用 boost::bind 和 boost::function 你可以从类方法创建函子,实际上这是一个委托:

class SomeClass
{
    std::string state_;
public:
    SomeClass(const char* s) : state_(s) {}

    void method( std::string param )
    {
        std::cout << state_ << param << std::endl;
    }
};
SomeClass *inst = new SomeClass("Hi, i am ");
boost::function< void (std::string) > callback;
callback = boost::bind(&SomeClass::method, inst, _1);//create delegate
//_1 is a placeholder it holds plase for parameter
callback("useless");//prints "Hi, i am useless"

您可以创建函子列表或向量

std::list< boost::function<void (EventArg e)> > events;
//add some events
....
//call them
std::for_each(
        events.begin(), events.end(), 
        boost::bind( boost::apply<void>(), _1, e));

所有这些东西都有一个问题,编译器错误消息不是人类可读的:)

Functor 是一个像函数一样的对象。 基本上,一个定义operator()

class MyFunctor
{
   public:
     int operator()(int x) { return x * 2;}
}

MyFunctor doubler;
int x = doubler(5);

真正的优点是函子可以保持状态。

class Matcher
{
   int target;
   public:
     Matcher(int m) : target(m) {}
     bool operator()(int x) { return x == target;}
}

Matcher Is5(5);

if (Is5(n))    // same as if (n == 5)
{ ....}

早在 C++ 出现之前,“函子”这个名称就已经被传统地用于范畴论中。 这与函子的 C++ 概念无关。 最好使用名称函数对象而不是我们在 C++ 中所说的“函子”。 这就是其他编程语言如何调用类似结构。

用于代替普通函数:

特征:

  • 函数对象可能有状态
  • 函数对象适合 OOP(它的行为与其他所有对象一样)。

缺点:

  • 给程序带来了更多的复杂性。

用于代替函数指针:

特征:

  • 函数对象通常可以被内联

缺点:

  • 函数对象在运行时不能与其他函数对象类型交换(至少除非它扩展了某个基类,因此会产生一些开销)

代替虚函数使用:

特征:

  • 函数对象(非虚拟)不需要 vtable 和运行时分派,因此在大多数情况下效率更高

缺点:

  • 函数对象在运行时不能与其他函数对象类型交换(至少除非它扩展了某个基类,因此会产生一些开销)

就像其他人提到的那样,函子是一个对象,其行为类似于函数,即它重载了函数调用运算符。

函子通常用于 STL 算法。 它们很有用,因为它们可以在函数调用之前和之间保持状态,就像函数式语言中的闭包一样。 例如,您可以定义一个MultiplyBy函子,将其参数乘以指定的数量:

class MultiplyBy {
private:
    int factor;

public:
    MultiplyBy(int x) : factor(x) {
    }

    int operator () (int other) const {
        return factor * other;
    }
};

然后你可以将MultiplyBy对象传递给像 std::transform 这样的算法:

int array[5] = {1, 2, 3, 4, 5};
std::transform(array, array + 5, array, MultiplyBy(3));
// Now, array is {3, 6, 9, 12, 15}

与指向函数的指针相比,函子的另一个优点是可以在更多情况下内联调用。 如果您将函数指针传递给transform ,除非调用被内联并且编译器知道您总是将相同的函数传递给它,否则它无法通过指针内联调用。

对于我们中间像我这样的新手:经过一些研究,我弄清楚了 jalf 发布的代码做了什么。

函子是一个类或结构对象,可以像函数一样被“调用”。 这是通过重载() operator () operator (不确定它叫什么)可以接受任意数量的参数。 其他运算符只取两个,即+ operator只能取两个值(运算符的每一侧一个)并返回您为其重载的任何值。 您可以在() operator放入任意数量的参数,这为其提供了灵活性。

要首先创建函子,您需要创建您的类。 然后使用您选择的类型和名称的参数为类创建一个构造函数。 在同一个语句中,后面跟着一个初始化列表(它使用单个冒号运算符,我也是新手),它使用先前声明的构造函数参数构造类成员对象。 然后() operator被重载。 最后声明您创建的类或结构的私有对象。

我的代码(我发现 jalf 的变量名令人困惑)

class myFunctor
{ 
    public:
        /* myFunctor is the constructor. parameterVar is the parameter passed to
           the constructor. : is the initializer list operator. myObject is the
           private member object of the myFunctor class. parameterVar is passed
           to the () operator which takes it and adds it to myObject in the
           overloaded () operator function. */
        myFunctor (int parameterVar) : myObject( parameterVar ) {}

        /* the "operator" word is a keyword which indicates this function is an 
           overloaded operator function. The () following this just tells the
           compiler that () is the operator being overloaded. Following that is
           the parameter for the overloaded operator. This parameter is actually
           the argument "parameterVar" passed by the constructor we just wrote.
           The last part of this statement is the overloaded operators body
           which adds the parameter passed to the member object. */
        int operator() (int myArgument) { return myObject + myArgument; }

    private: 
        int myObject; //Our private member object.
}; 

如果其中任何一个不准确或完全错误,请随时纠正我!

函子是将函数应用于参数化(即模板化)类型的高阶函数 它是map高阶函数的推广。 例如,我们可以像这样为std::vector定义一个函子:

template<class F, class T, class U=decltype(std::declval<F>()(std::declval<T>()))>
std::vector<U> fmap(F f, const std::vector<T>& vec)
{
    std::vector<U> result;
    std::transform(vec.begin(), vec.end(), std::back_inserter(result), f);
    return result;
}

当给定一个接受T并返回U的函数F ,该函数接受一个std::vector<T>并返回std::vector<U> 函子不必在容器类型上定义,它也可以为任何模板类型定义,包括std::shared_ptr

template<class F, class T, class U=decltype(std::declval<F>()(std::declval<T>()))>
std::shared_ptr<U> fmap(F f, const std::shared_ptr<T>& p)
{
    if (p == nullptr) return nullptr;
    else return std::shared_ptr<U>(new U(f(*p)));
}

这是一个将类型转换为double的简单示例:

double to_double(int x)
{
    return x;
}

std::shared_ptr<int> i(new int(3));
std::shared_ptr<double> d = fmap(to_double, i);

std::vector<int> is = { 1, 2, 3 };
std::vector<double> ds = fmap(to_double, is);

函子应该遵循两条定律。 第一个是恒等律,它规定如果给函子一个恒等函数,它应该与将恒等函数应用于类型相同,即fmap(identity, x)应该与identity(x)相同:

struct identity_f
{
    template<class T>
    T operator()(T x) const
    {
        return x;
    }
};
identity_f identity = {};

std::vector<int> is = { 1, 2, 3 };
// These two statements should be equivalent.
// is1 should equal is2
std::vector<int> is1 = fmap(identity, is);
std::vector<int> is2 = identity(is);

下一个定律是复合定律,它指出如果给函子给出两个函数的组合,它应该与将函子应用于第一个函数然后再次应用于第二个函数相同。 因此, fmap(std::bind(f, std::bind(g, _1)), x)应该与fmap(f, fmap(g, x))

double to_double(int x)
{
    return x;
}

struct foo
{
    double x;
};

foo to_foo(double x)
{
    foo r;
    r.x = x;
    return r;
}

std::vector<int> is = { 1, 2, 3 };
// These two statements should be equivalent.
// is1 should equal is2
std::vector<foo> is1 = fmap(std::bind(to_foo, std::bind(to_double, _1)), is);
std::vector<foo> is2 = fmap(to_foo, fmap(to_double, is));

这是我被迫使用 Functor 来解决我的问题的实际情况:

我有一组函数(比如其中的 20 个),它们都是相同的,除了每个函数在 3 个特定位置调用不同的特定函数。

这是令人难以置信的浪费和代码重复。 通常我只会传入一个函数指针,然后在 3 个位置调用它。 (所以代码只需要出现一次,而不是二十次。)

但后来我意识到,在每种情况下,特定功能都需要完全不同的参数配置文件! 有时是 2 个参数,有时是 5 个参数,等等。

另一种解决方案是拥有一个基类,其中特定函数是派生类中的重写方法。 但是我真的想构建所有这些继承,只是为了传递一个函数指针????

解决方案:所以我所做的是,我创建了一个包装类(一个“函数”),它能够调用我需要调用的任何函数。 我提前设置了它(使用它的参数等),然后我传递它而不是函数指针。 现在被调用的代码可以触发 Functor,而无需知道内部发生了什么。 它甚至可以多次调用它(我需要它调用 3 次。)


就是这样——一个实际的例子,一个 Functor 被证明是显而易见的和简单的解决方案,它使我能够将代码重复从 20 个函数减少到 1 个。

就像已经重复过的那样,函子是可以被视为函数的类(重载运算符 ())。

在需要将某些数据与对函数的重复或延迟调用相关联的情况下,它们最有用。

例如,函子的链表可用于实现基本的低开销同步协程系统、任务调度程序或可中断文件解析。 例子:

/* prints "this is a very simple and poorly used task queue" */
class Functor
{
public:
    std::string output;
    Functor(const std::string& out): output(out){}
    operator()() const
    {
        std::cout << output << " ";
    }
};

int main(int argc, char **argv)
{
    std::list<Functor> taskQueue;
    taskQueue.push_back(Functor("this"));
    taskQueue.push_back(Functor("is a"));
    taskQueue.push_back(Functor("very simple"));
    taskQueue.push_back(Functor("and poorly used"));
    taskQueue.push_back(Functor("task queue"));
    for(std::list<Functor>::iterator it = taskQueue.begin();
        it != taskQueue.end(); ++it)
    {
        *it();
    }
    return 0;
}

/* prints the value stored in "i", then asks you if you want to increment it */
int i;
bool should_increment;
int doSomeWork()
{
    std::cout << "i = " << i << std::endl;
    std::cout << "increment? (enter the number 1 to increment, 0 otherwise" << std::endl;
    std::cin >> should_increment;
    return 2;
}
void doSensitiveWork()
{
     ++i;
     should_increment = false;
}
class BaseCoroutine
{
public:
    BaseCoroutine(int stat): status(stat), waiting(false){}
    void operator()(){ status = perform(); }
    int getStatus() const { return status; }
protected:
    int status;
    bool waiting;
    virtual int perform() = 0;
    bool await_status(BaseCoroutine& other, int stat, int change)
    {
        if(!waiting)
        {
            waiting = true;
        }
        if(other.getStatus() == stat)
        {
            status = change;
            waiting = false;
        }
        return !waiting;
    }
}

class MyCoroutine1: public BaseCoroutine
{
public:
    MyCoroutine1(BaseCoroutine& other): BaseCoroutine(1), partner(other){}
protected:
    BaseCoroutine& partner;
    virtual int perform()
    {
        if(getStatus() == 1)
            return doSomeWork();
        if(getStatus() == 2)
        {
            if(await_status(partner, 1))
                return 1;
            else if(i == 100)
                return 0;
            else
                return 2;
        }
    }
};

class MyCoroutine2: public BaseCoroutine
{
public:
    MyCoroutine2(bool& work_signal): BaseCoroutine(1), ready(work_signal) {}
protected:
    bool& work_signal;
    virtual int perform()
    {
        if(i == 100)
            return 0;
        if(work_signal)
        {
            doSensitiveWork();
            return 2;
        }
        return 1;
    }
};

int main()
{
     std::list<BaseCoroutine* > coroutineList;
     MyCoroutine2 *incrementer = new MyCoroutine2(should_increment);
     MyCoroutine1 *printer = new MyCoroutine1(incrementer);

     while(coroutineList.size())
     {
         for(std::list<BaseCoroutine *>::iterator it = coroutineList.begin();
             it != coroutineList.end(); ++it)
         {
             *it();
             if(*it.getStatus() == 0)
             {
                 coroutineList.erase(it);
             }
         }
     }
     delete printer;
     delete incrementer;
     return 0;
}

当然,这些例子本身并没有那么有用。 它们只展示了函子如何有用,函子本身非常基本且不灵活,这使得它们不如 boost 提供的有用。

在 gtkmm 中使用函子将一些 GUI 按钮连接到实际的 C++ 函数或方法。


如果您使用 pthread 库使您的应用程序多线程,Functors 可以帮助您。
要启动一个线程, pthread_create(..)的参数之一是要在他自己的线程上执行的函数指针。
但是有一个不便。 这个指针不能是指向方法的指针,除非它是一个静态方法,或者除非你指定它是 class ,比如class::method 还有一件事,你的方法的接口只能是:

void* method(void* something)

所以你不能在一个线程中运行(以一种简单明显的方式)你的类中的方法而不做一些额外的事情。

在 C++ 中处理线程的一个很好的方法是创建自己的Thread类。 如果你想从MyClass类运行方法,我所做的是将这些方法转换为Functor派生类。

另外, Thread类有这个方法: static void* startThread(void* arg)
指向此方法的指针将用作调用pthread_create(..)的参数。 startThread(..)应该在 arg 中接收到一个void*对任何Functor派生类的堆中实例的引用,该实例在执行时将被强制转换回Functor* ,然后调用它的run()方法。

除了用于回调之外,C++ 函子还可以帮助为矩阵类提供Matlab喜欢的访问方式。 有一个例子

另外,我使用函数对象将现有的遗留方法适合命令模式; (唯一能感受到 OO 范式之美的真正 OCP 的地方); 还在这里添加了相关的函数适配器模式。

假设您的方法具有以下签名:

int CTask::ThreeParameterTask(int par1, int par2, int par3)

我们将看到如何将它适合命令模式 - 为此,首先,您必须编写一个成员函数适配器,以便可以将其作为函数对象调用。

注意 - 这很难看,可能你可以使用 Boost 绑定助手等,但如果你不能或不想,这是一种方法。

// a template class for converting a member function of the type int        function(int,int,int)
//to be called as a function object
template<typename _Ret,typename _Class,typename _arg1,typename _arg2,typename _arg3>
class mem_fun3_t
{
  public:
explicit mem_fun3_t(_Ret (_Class::*_Pm)(_arg1,_arg2,_arg3))
    :m_Ptr(_Pm) //okay here we store the member function pointer for later use
    {}

//this operator call comes from the bind method
_Ret operator()(_Class *_P, _arg1 arg1, _arg2 arg2, _arg3 arg3) const
{
    return ((_P->*m_Ptr)(arg1,arg2,arg3));
}
private:
_Ret (_Class::*m_Ptr)(_arg1,_arg2,_arg3);// method pointer signature
};

此外,我们需要上述类的辅助方法mem_fun3来帮助调用。

template<typename _Ret,typename _Class,typename _arg1,typename _arg2,typename _arg3>
mem_fun3_t<_Ret,_Class,_arg1,_arg2,_arg3> mem_fun3 ( _Ret (_Class::*_Pm)          (_arg1,_arg2,_arg3) )
{
  return (mem_fun3_t<_Ret,_Class,_arg1,_arg2,_arg3>(_Pm));
}

现在,为了绑定参数,我们必须编写一个绑定函数。 所以,这里是:

template<typename _Func,typename _Ptr,typename _arg1,typename _arg2,typename _arg3>
class binder3
{
public:
//This is the constructor that does the binding part
binder3(_Func fn,_Ptr ptr,_arg1 i,_arg2 j,_arg3 k)
    :m_ptr(ptr),m_fn(fn),m1(i),m2(j),m3(k){}

 //and this is the function object 
 void operator()() const
 {
        m_fn(m_ptr,m1,m2,m3);//that calls the operator
    }
private:
    _Ptr m_ptr;
    _Func m_fn;
    _arg1 m1; _arg2 m2; _arg3 m3;
};

并且,一个使用 binder3 类的辅助函数 - bind3

//a helper function to call binder3
template <typename _Func, typename _P1,typename _arg1,typename _arg2,typename _arg3>
binder3<_Func, _P1, _arg1, _arg2, _arg3> bind3(_Func func, _P1 p1,_arg1 i,_arg2 j,_arg3 k)
{
    return binder3<_Func, _P1, _arg1, _arg2, _arg3> (func, p1,i,j,k);
}

现在,我们必须在 Command 类中使用它; 使用以下类型定义:

typedef binder3<mem_fun3_t<int,T,int,int,int> ,T* ,int,int,int> F3;
//and change the signature of the ctor
//just to illustrate the usage with a method signature taking more than one parameter
explicit Command(T* pObj,F3* p_method,long timeout,const char* key,
long priority = PRIO_NORMAL ):
m_objptr(pObj),m_timeout(timeout),m_key(key),m_value(priority),method1(0),method0(0),
method(0)
{
    method3 = p_method;
}

这是你如何称呼它的:

F3 f3 = PluginThreadPool::bind3( PluginThreadPool::mem_fun3( 
      &CTask::ThreeParameterTask), task1,2122,23 );

注意: f3(); 将调用方法task1->ThreeParameterTask(21,22,23); .

此模式的完整上下文位于以下链接

将函数实现为函子的一大优势是它们可以在调用之间维护和重用状态。 例如,许多动态规划算法(如用于计算字符串之间的Levenshtein 距离Wagner-Fischer 算法)通过填充一个大的结果表来工作。 每次调用函数时都分配这张表是非常低效的,因此将函数实现为函子并将该表作为成员变量可以大大提高性能。

下面是将 Wagner-Fischer 算法实现为函子的示例。 注意表是如何在构造函数中分配的,然后在operator()重用,并根据需要调整大小。

#include <string>
#include <vector>
#include <algorithm>

template <typename T>
T min3(const T& a, const T& b, const T& c)
{
   return std::min(std::min(a, b), c);
}

class levenshtein_distance 
{
    mutable std::vector<std::vector<unsigned int> > matrix_;

public:
    explicit levenshtein_distance(size_t initial_size = 8)
        : matrix_(initial_size, std::vector<unsigned int>(initial_size))
    {
    }

    unsigned int operator()(const std::string& s, const std::string& t) const
    {
        const size_t m = s.size();
        const size_t n = t.size();
        // The distance between a string and the empty string is the string's length
        if (m == 0) {
            return n;
        }
        if (n == 0) {
            return m;
        }
        // Size the matrix as necessary
        if (matrix_.size() < m + 1) {
            matrix_.resize(m + 1, matrix_[0]);
        }
        if (matrix_[0].size() < n + 1) {
            for (auto& mat : matrix_) {
                mat.resize(n + 1);
            }
        }
        // The top row and left column are prefixes that can be reached by
        // insertions and deletions alone
        unsigned int i, j;
        for (i = 1;  i <= m; ++i) {
            matrix_[i][0] = i;
        }
        for (j = 1; j <= n; ++j) {
            matrix_[0][j] = j;
        }
        // Fill in the rest of the matrix
        for (j = 1; j <= n; ++j) {
            for (i = 1; i <= m; ++i) {
                unsigned int substitution_cost = s[i - 1] == t[j - 1] ? 0 : 1;
                matrix_[i][j] =
                    min3(matrix_[i - 1][j] + 1,                 // Deletion
                    matrix_[i][j - 1] + 1,                      // Insertion
                    matrix_[i - 1][j - 1] + substitution_cost); // Substitution
            }
        }
        return matrix_[m][n];
    }
};

Functor 也可用于模拟在函数内定义局部函数。 请参阅问题另一个.

但是本地函子不能访问外部自动变量。 lambda (C++11) 函数是更好的解决方案。

我已经“发现”了一个非常有趣的函子用法:当我对一个方法没有很好的名字时,我就使用它们,因为函子是没有名称的方法;-)

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM