从 Rcpp 函数返回指向"新"对象的指针的正确方法

Proper way to return a pointer to a `new` object from an Rcpp function

本文关键字：quot 指针 Rcpp 方法 对象 返回 函数      更新时间：2023-10-16

考虑 1( 具有潜在大内存打印的自定义类，以及 2( 执行一些预处理的顶级函数，然后创建并返回自定义类的新对象。为了避免按值进行不必要的复制，该函数会分配对象并返回指向它的指针。

根据前面的讨论，似乎返回指向新创建对象的指针的正确方法是用Rcpp::XPtr<>包装它。然而，R随后有效地将其视为externalptr，我正在努力寻找正确的方法，将其与现代RCPP_EXPOSED_CLASS和RCPP_MODULE做事方式相结合。

另一种方法是返回原始指针。但是我不能 100% 确定对象内存是否得到正确清理。我跑valgrind测试内存泄漏，但没有找到任何内存泄漏。但是，谁来清理？R？

测试.cpp 

#include <Rcpp.h>
// Custom class
class Double {
public:
Double( double v ) : value(v) {}
double square() {return value*value;}
private:
double value;
};
// Make the class visible
RCPP_EXPOSED_CLASS(Double)
// Option 1: returning raw pointer
Double* makeDouble( double x ) {
Double* pd = new Double(x);
return pd;
}
// Option 2: returning XPtr<>
SEXP makeDouble2( double x ) {
Double* pd = new Double(x);
Rcpp::XPtr<Double> ptr(pd);
return ptr;
}
RCPP_MODULE(double_cpp) {
using namespace Rcpp;
function( "makeDouble", &makeDouble );
function( "makeDouble2", &makeDouble2 );
class_<Double>("Double")
.constructor<double>("Wraps a double")
.method("square", &Double::square, "square of value")
;
}

在 R 中

Rcpp::sourceCpp("test.cpp")
d1 <- makeDouble(5.4)     # <-- who cleans this up???
# C++ object <0x56257d628e70> of class 'Double' <0x56257c69cf90>
d1$square()
# 29.16
d2 <- makeDouble2(2.3)
# <pointer: 0x56257d3c3cd0>
d2$square()
# Error in d2$square : object of type 'externalptr' is not subsettable

我的问题是Rcpp::Xptr<>是否是返回指针的正确方法，如果是这样，我如何让 R 将结果视为Double，而不是externalptr？或者，如果返回原始指针不会导致内存问题，那么谁来清理函数创建的对象？

我认为分别查看不同的方法是有意义的。这使得区别更加清晰。请注意，这与 Rcpp 模块小插曲中的讨论非常相似。

使用Rcpp::XPtr时，您拥有自己的类，并为要公开的每个方法提供导出的C++函数：

#include <Rcpp.h>
// Custom class
class Double {
public:
Double( double v ) : value(v) {}
double square() {return value*value;}
private:
double value;
};
// [[Rcpp::export]]
Rcpp::XPtr<Double> makeDouble(double x) {
Double* pd = new Double(x);
Rcpp::XPtr<Double> ptr(pd);
return ptr;
}
// [[Rcpp::export]]
double squareDouble(Rcpp::XPtr<Double> x) {
return x.get()->square();
}
/***R
(d2 <- makeDouble(5.4))
squareDouble(d2)
*/

输出：

> Rcpp::sourceCpp('59384221/xptr.cpp')
> (d2 <- makeDouble(5.4))
<pointer: 0x560366699b50>
> squareDouble(d2)
[1] 29.16

请注意，在 are 对象只是一个"指针"。您可以添加 S4/RC/R6/...如果你想要更好的东西，在R侧上课。

将外部指针包装到 R 端的类中是使用 Rcpp 模块免费获得的：

#include <Rcpp.h>
// Custom class
class Double {
public:
Double( double v ) : value(v) {}
double square() {return value*value;}
private:
double value;
};
RCPP_MODULE(double_cpp) {
using namespace Rcpp;
class_<Double>("Double")
.constructor<double>("Wraps a double")
.method("square", &Double::square, "square of value")
;
}
/***R
(d1 <- new(Double, 5.4))
d1$square()
*/

输出：

> Rcpp::sourceCpp('59384221/modules.cpp')
> (d1 <- new(Double, 5.4))
C++ object <0x560366452eb0> of class 'Double' <0x56036480f320>
> d1$square()
[1] 29.16

还支持使用工厂方法而不是构造函数C++，但在 R 端具有相同的用法：

#include <Rcpp.h>
// Custom class
class Double {
public:
Double( double v ) : value(v) {}
double square() {return value*value;}
private:
double value;
};
Double* makeDouble( double x ) {
Double* pd = new Double(x);
return pd;
}
RCPP_MODULE(double_cpp) {
using namespace Rcpp;
class_<Double>("Double")
.factory<double>(makeDouble, "Wraps a double")
.method("square", &Double::square, "square of value")
;
}
/***R
(d1 <- new(Double, 5.4))
d1$square()
*/

输出：

> Rcpp::sourceCpp('59384221/modules-factory.cpp')
> (d1 <- new(Double, 5.4))
C++ object <0x5603665aab80> of class 'Double' <0x5603666eaae0>
> d1$square()
[1] 29.16

最后，如果要将 R 端工厂函数与 Rcpp 模块组合在一起，RCPP_EXPOSED_CLASS会派上用场，因为这会创建在 R 和 C++ 之间来回传递对象所需的Rcpp::as和Rcpp::wrap扩展。工厂可以通过function导出，就像你所做的那样，或者使用 Rcpp 属性，我觉得这更自然：

#include <Rcpp.h>
// Custom class
class Double {
public:
Double( double v ) : value(v) {}
double square() {return value*value;}
private:
double value;
};
// Make the class visible
RCPP_EXPOSED_CLASS(Double)
// [[Rcpp::export]]
Double makeDouble( double x ) {
Double d(x);
return d;
}
RCPP_MODULE(double_cpp) {
using namespace Rcpp;
class_<Double>("Double")
.method("square", &Double::square, "square of value")
;
}
/***R
(d1 <- makeDouble(5.4))
d1$square()
*/

输出：

> Rcpp::sourceCpp('59384221/modules-expose.cpp')
> (d1 <- makeDouble(5.4))
C++ object <0x560366ebee10> of class 'Double' <0x560363d5f440>
> d1$square()
[1] 29.16

关于清理：Rcpp::XPtr和 Rcpp 模块都注册了一个默认终结器，用于调用对象的析构函数。如果需要，您还可以添加自定义终结器。

我发现很难为其中一种方法提出建议。也许最好在一些简单的例子中尝试它们中的每一个，看看你觉得什么更自然地使用。

相关文章：