有什么方法可以将 pythonappend 与 SWIG 的新内置功能一起使用？

Question

我有一个与 SWIG 完美配合的小项目。特别是，我的一些函数返回std::vectors，它被翻译成Python 中的元组。现在，我做了很多数字，所以我只是让 SWIG 在它们从 c++ 代码返回后将它们转换为 numpy 数组。为此，我在 SWIG 中使用了类似以下的内容。

%feature("pythonappend") My::Cool::Namespace::Data() const %{ if isinstance(val, tuple) : val = numpy.array(val) %}

（实际上，有几个名为 Data 的函数，其中一些返回浮点数，这就是为什么我检查 val 实际上是一个元组。）这很好用。

但是，我还想使用现在可用的 -builtin 标志。对这些 Data 函数的调用很少见，而且大多是交互式的，因此它们的速度慢不是问题，但是还有其他慢速循环可以通过内置选项显着加快速度。

问题在于，当我使用该标志时，pythonappend 功能会被忽略。现在，Data 再次返回一个元组。有什么办法我仍然可以返回 numpy 数组？我尝试使用类型映射，但结果变得一团糟。

编辑：

Borealid 很好地回答了这个问题。为了完整起见，我包含了一些我需要的相关但略有不同的类型映射，因为我通过 const 引用返回并且我使用向量的向量（不要开始！）。这些差异很大，我不希望其他人在试图找出细微差别时磕磕绊绊。

%typemap(out) std::vector<int>& {
  npy_intp result_size = $1->size();
  npy_intp dims[1] = { result_size };
  PyArrayObject* npy_arr = (PyArrayObject*)PyArray_SimpleNew(1, dims, NPY_INT);
  int* dat = (int*) PyArray_DATA(npy_arr);
  for (size_t i = 0; i < result_size; ++i) { dat[i] = (*$1)[i]; }
  $result = PyArray_Return(npy_arr);
}
%typemap(out) std::vector<std::vector<int> >& {
  npy_intp result_size = $1->size();
  npy_intp result_size2 = (result_size>0 ? (*$1)[0].size() : 0);
  npy_intp dims[2] = { result_size, result_size2 };
  PyArrayObject* npy_arr = (PyArrayObject*)PyArray_SimpleNew(2, dims, NPY_INT);
  int* dat = (int*) PyArray_DATA(npy_arr);
  for (size_t i = 0; i < result_size; ++i) { for (size_t j = 0; j < result_size2; ++j) { dat[i*result_size2+j] = (*$1)[i][j]; } }
  $result = PyArray_Return(npy_arr);
}

编辑 2：

虽然不是我想要的，但类似的问题也可以使用@MONK 的方法 (explained here) 来解决。

Answer 1

我同意你的观点，使用 typemap 会有点混乱，但这是完成这项任务的正确方法。你也对，SWIG 文档没有直接说%pythonappend 与-builtin 不兼容，但强烈暗示：%pythonappend 添加到 Python 代理类，并且 Python 代理与-builtin 标志一起使用的类根本不存在。

之前，您所做的是让 SWIG 将 C++ std::vector 对象转换为 Python 元组，然后将这些元组传递回 numpy - 它们再次被转换。

您真正想要做的是在 C 级别将它们转换一次。

这里有一些代码会将所有 std::vector<int> 对象转换为 NumPy 整数数组：

%{
#include "numpy/arrayobject.h"
%}

%init %{
    import_array();
%}

%typemap(out) std::vector<int> {
    npy_intp result_size = $1.size();

    npy_intp dims[1] = { result_size };

    PyArrayObject* npy_arr = (PyArrayObject*)PyArray_SimpleNew(1, dims, NPY_INT);
    int* dat = (int*) PyArray_DATA(npy_arr);

    for (size_t i = 0; i < result_size; ++i) {
        dat[i] = $1[i];
    }

    $result = PyArray_Return(npy_arr);
}

这使用 C 级别的 numpy 函数来构造和返回一个数组。按顺序，它：

• 确保 NumPy 的 arrayobject.h 文件包含在 C++ 输出文件中
• 导致在加载 Python 模块时调用 import_array（否则，所有 NumPy 方法都会出现段错误）
• 将std::vector<int> 的任何返回值映射到带有typemap 的NumPy 数组中

这段代码应该放在之前你%import包含返回std::vector<int>的函数的标题。除了这个限制之外，它是完全独立的，所以它不应该给你的代码库添加太多主观的“混乱”。

如果您需要其他向量类型，您只需更改NPY_INT 以及所有int* 和int 位，否则重复上述功能。