如何使用SWIG为Matrix类创建包装器Numpy?

时间:2013-04-22 15:57:22

标签: c++ numpy swig

我有一个古老而成熟的C ++库,其中包含Matrix类和使用它的大量代码。基本上是

class Matrix {
  double* p;      // the actual data
  int nd;         // number of dimensions
  int d0, d1, d2; // the actual dimensionality

  // ... (a whole lot of functions computing various things, like SVDs, dotproduct etc.
}

现在我们使用SWIG编写一个python包装器。我们希望在python端使用NumPy数组以保持与世界其他地方的兼容性。所以我们实际上不需要我们的C ++ Matrix类的功能,但是我们想要使用我们库的一些其他部分,它们需要这个C ++ Matrix。所以完美的情况是,如果我们可以将NumPy数组中的类型映射写入我们的Matrix类,它会在每次调用时透明地转换NumPy数组并保持内存同步。假设我们的库中有一些功能,这很复杂:

int some_function(Matrix& in) { /* do some stuff */ }

现在,如果在python中我们可以做类似的事情,那就太好了。

a = numpy.array[1,2,3,4]
b = some_function(a)

我知道有numpy.i,但这似乎更多的是关于函数映射和普通的旧C数组。我也明白一个类型图应该可以实现我想要的东西,但我真的不明白我是如何实际访问numpy数据的。有没有(相对)简单的方法呢?

我也很欣赏指向一些教程的指针。

1 个答案:

答案 0 :(得分:1)

根据您提供的信息,字体图可以使用。但我作为间歇性SWIG用户的经验(通常是几个星期我使用它然后中断到下一个项目/阶段)是很少有人有时间去理解这个功能。

在您的情况下,我认为SWIG字体图更方便而不是要求,所以我会使用以下两种方法之一:

  1. 创建一个Python函数,用于执行从numpy.array到Matrix的转换(Matrix是通过SWIG从C ++导出到Python的那个)
  2. 使用builtin numpy.i typemap来调用在该typemap中接受C ++类型的C ++函数,并定义该函数以调用int some_function(Matrix& in)
  3. 选项1的优点是您可以通过重新绑定Python函数来自动化转换:

    old_some_func = some_function
    def some_function(numpy_array):
        tempMat = Matrix()
        # convert numpy_array to SWIG'd Matrix class
        old_some_func(tempMat)
    

    这样做的性能可能微不足道,但你应该测试一下。如果没有SWIG(即如果你使用的是C API),这种技术还有一个额外的好处,就是不要求你改变你的C ++库(参见SWIG的extend指令)。

    选项2的优点是转换处于C / C ++级别,因此根据所涉及的内容,您可以获得更高的性能。假设其中一个numpy.i类型映射将numpy.array映射到float [numValues]数组,并且您的C ++ Matrix包含单精度浮点值。在这种情况下,您在项目的.i文件中定义了C ++ some_function(float *,numValues),该函数调用some_function(Matrix)。检查您的C ++ Matrix类是否可以存储指向数组数据的指针,这样您就可以避免在一个甚至两个层上复制数据(Python - > SWIG some_function(array) - > some_function(Matrix))。

    但请记住:您在C ++ some_function中的计算可能会使这两个选项之间的任何性能差异无关紧要。你必须测试。然后选择最简单,最易维护的(可能是选项1)。