使用pybind11封装带引用传递STL向量的C++ void函数

我来帮你搞定这类void型STL向量引用函数的pybind11封装问题，结合你的场景，梳理下核心坑点和解决方案：

你现在的C函数通过引用接收多个std::vector<double>，并修改其中的result向量。虽然已经引入了pybind11/stl.h做自动类型转换，但这里有个容易踩的坑：**Python的原生list和C的std::vector在引用传递时的行为不一致**，直接绑定可能导致修改后的结果无法同步到Python端。

1. 让修改后的结果在Python端生效 #

问题根源 #

当Python传入普通list给非const引用的std::vector参数时，pybind11会创建一个临时的std::vector对象，函数修改的是这个临时对象，而非原Python list，所以修改后不会反映在原list里。

解决方案（二选一） #

• 推荐方案：用numpy数组替代list
  numpy数组的内存布局和std::vector兼容，pybind11可以直接映射其内存地址作为引用，修改后直接生效，还能避免拷贝开销：

  import numpy as np
  from your_module import YourClass
  
  obj = YourClass()
  # 预先分配好结果数组的大小（需符合函数预期）
  result = np.zeros(5, dtype=np.float64)
  array1 = np.array([1.0, 2.0, 3.0, 4.0, 5.0], dtype=np.float64)
  array2 = np.array([6.0, 7.0, 8.0, 9.0, 10.0], dtype=np.float64)
  
  obj.somefunction(result, array1, array2)
  print(result)  # 这里能直接看到修改后的结果
  

• 兼容list方案：包装函数为返回值形式
  如果用户习惯用list，可以修改绑定代码，把result作为返回值返回，避免引用传递的坑：

  .def("somefunction", [](YourClass& self, const std::vector<double>& array1, const std::vector<double>& array2) {
      std::vector<double> result;
      // 若原函数需要预先初始化result大小，这里要根据array1/array2的长度处理
      self.somefunction(result, array1, array2);
      return result;
  })
  

  Python端调用时直接接收返回值：

  array1 = [1.0, 2.0, 3.0]
  array2 = [4.0, 5.0, 6.0]
  result = obj.somefunction(array1, array2)
  print(result)  # 直接拿到修改后的结果
  

2. 优化参数的const属性 #

如果array1和array2是只读的，建议在C++函数中把它们改成const引用：

void somefunction(std::vector<double> &result, const std::vector<double> &array1, const std::vector<double> &array2) {
    // 计算逻辑
}

这样pybind11会做更高效的类型转换，也能避免意外修改输入参数，绑定代码无需额外改动。

3. 避免内存越界风险 #

如果你的C++函数没有自动初始化result的大小，Python端传入的numpy数组必须预先分配足够的空间；如果用list包装的返回值方案，要确保在包装函数里根据输入向量的长度初始化result，否则会触发内存错误。

假设你的类名为MathProcessor，完整的绑定代码如下：

#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <vector>

namespace py = pybind11;

class MathProcessor {
public:
    void somefunction(std::vector<double>& result, const std::vector<double>& array1, const std::vector<double>& array2) {
        // 示例计算：result[i] = array1[i] * array2[i]
        result.resize(array1.size());
        for (size_t i = 0; i < array1.size(); ++i) {
            result[i] = array1[i] * array2[i];
        }
    }
};

PYBIND11_MODULE(processor, m) {
    py::class_<MathProcessor>(m, "MathProcessor")
        .def(py::init<>())
        // 原始绑定，适配numpy数组场景
        .def("somefunction", &MathProcessor::somefunction)
        // 可选：添加包装版本，适配Python list场景
        .def("somefunction_with_return", [](MathProcessor& self, const std::vector<double>& array1, const std::vector<double>& array2) {
            std::vector<double> result;
            self.somefunction(result, array1, array2);
            return result;
        });
}

内容的提问来源于stack exchange，提问作者fbartolic