如何使用 SWIG 为 Numpy 的 Matrix 类创建一个包装器？答案

【问题标题】：How to create a wrapper for a Matrix class to Numpy with SWIG?如何使用 SWIG 为 Numpy 的 Matrix 类创建一个包装器？
【发布时间】：2013-04-22 15:57:21
【问题描述】：

我有一个古老的 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++ 矩阵类的功能，但是我们想使用我们库的一些其他部分，它需要这个 C++ 矩阵。所以完美的情况是，如果我们可以将一个类型映射从一个 NumPy 数组写入我们的 Matrix 类，它会在每次调用时透明地转换一个 NumPy 数组并保持内存同步。假设我们的库中有一些函数，它是 swigged：

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

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

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

我知道有 numpy.i，但这似乎更多地是关于函数映射和普通的旧 C 数组。我也明白 typemap 应该完成我想要的，但我真的不明白我如何才能真正访问 numpy 数据。有没有（相对）简单的方法可以做到这一点？

我也希望能提供一些教程。

【问题讨论】：

标签： c++ numpy swig

【解决方案1】：

根据您提供的信息，类型图可以工作。但是我作为一个间歇性的 SWIG 用户（通常是几周内我经常使用它，然后中断到下一个项目/阶段）的经验是，很少有人有时间去了解这个功能。

在你的情况下，我认为 SWIG 类型图比要求更方便，所以我会使用以下两种方法之一：

创建一个 Python 函数，将 numpy.array 转换为 Matrix（Matrix 是 SWIG 从 C++ 导出到 Python 的函数）
使用内置的 numpy.i 类型映射来调用在该类型映射中接受 C++ 类型的 C++ 函数，并定义该函数以调用 int some_function(Matrix& in)

选项 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 的扩展指令）。

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

但请记住：您在 C++ some_function 中的计算可能会使这两个选项之间的任何性能差异变得微不足道。你必须测试。然后选择最简单和最易于维护的那个（可能是选项 1）。

【讨论】：