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

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

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

另一种方法是返回原始指针。但是，我不能100％地确定对象内存是否已正确清理。我跑去valgrind测试内存泄漏，但没有发现任何泄漏。但是，谁清理呢？R？

测试文件

#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

请注意，在R中，对象只是“指针”。如果您想要更好的东西，可以在R侧添加S4 / RC / R6 / ...类。

使用Rcpp模块可以免费将外部指针包装到R侧的类中：

#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

最后，RCPP_EXPOSED_CLASS如果您想将R侧工厂功能与Rcpp模块结合使用，将非常方便，因为这会创建Rcpp::as和Rcpp::wrap扩展，以在R和C ++之间来回传递对象。可以通过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模块都注册了一个默认终结器，该终结器调用对象的析构函数。如果需要，您还可以添加自定义的终结器。

我发现很难对其中一种方法提出建议。也许最好在一个简单的示例上尝试它们中的每一个，然后看看您发现更自然的用法。