Cách thích hợp để trả về một con trỏ tới một đối tượng `new` từ hàm Rcpp

Xem xét 1) một lớp tùy chỉnh có khả năng in bộ nhớ lớn và 2) hàm cấp cao nhất thực hiện một số tiền xử lý, sau đó tạo và trả về một đối tượng mới của lớp tùy chỉnh của chúng tôi. Để tránh sao chép không cần thiết theo giá trị, hàm phân bổ đối tượng và trả về một con trỏ cho nó.

Dựa trên một cuộc thảo luận trước đó , có vẻ như cách thích hợp để trả lại một con trỏ cho một đối tượng mới được tạo là bọc nó lại Rcpp::XPtr<>. Tuy nhiên, R sau đó thấy nó hiệu quả như externalptr, và tôi đang vật lộn để tìm ra cách thức phù hợp để đúc nó với cách làm hiện đại RCPP_EXPOSED_CLASSvà RCPP_MODULEcách làm.

Thay thế là trả về con trỏ thô. Nhưng sau đó tôi không chắc chắn 100% rằng bộ nhớ đối tượng được dọn sạch đúng cách. Tôi đã chạy valgrindđể kiểm tra rò rỉ bộ nhớ và nó không tìm thấy. Tuy nhiên, ai làm sạch? R?

test.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")
    ;
}

Trong 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

Câu hỏi của tôi là liệu Rcpp::Xptr<>cách trả về con trỏ thích hợp, và nếu vậy, làm thế nào để tôi có được R để xem kết quả như thế nào Double, không externalptr? Ngoài ra, nếu trả về một con trỏ thô không gây ra vấn đề về bộ nhớ, ai sẽ dọn sạch đối tượng mà hàm tạo ra?

Tôi nghĩ rằng nó có ý nghĩa để xem xét các cách tiếp cận khác nhau một cách riêng biệt. Điều này làm cho sự khác biệt rõ ràng hơn. Lưu ý rằng điều này khá giống với cuộc thảo luận trong họa tiết Rcpp Modules.

Khi sử dụng, Rcpp::XPtrbạn có lớp của mình và cung cấp các hàm C ++ đã xuất cho mọi phương thức bạn muốn trưng ra:

#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)
*/

Đầu ra:

> Rcpp::sourceCpp('59384221/xptr.cpp')

> (d2 <- makeDouble(5.4))
<pointer: 0x560366699b50>

> squareDouble(d2)
[1] 29.16

Lưu ý rằng trong R đối tượng chỉ là một "con trỏ". Bạn có thể thêm một lớp S4 / RC / R6 / ... ở bên R nếu bạn muốn thứ gì đó đẹp hơn.

Gói con trỏ bên ngoài vào một lớp ở bên R là thứ bạn nhận được miễn phí bằng cách sử dụng các mô-đun 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()
*/

Đầu ra:

> Rcpp::sourceCpp('59384221/modules.cpp')

> (d1 <- new(Double, 5.4))
C++ object <0x560366452eb0> of class 'Double' <0x56036480f320>

> d1$square()
[1] 29.16

Nó cũng được hỗ trợ để sử dụng phương thức xuất xưởng thay vì hàm tạo trong C ++ nhưng với cách sử dụng giống hệt nhau ở phía 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()
*/

Đầu ra:

> Rcpp::sourceCpp('59384221/modules-factory.cpp')

> (d1 <- new(Double, 5.4))
C++ object <0x5603665aab80> of class 'Double' <0x5603666eaae0>

> d1$square()
[1] 29.16

Cuối cùng, RCPP_EXPOSED_CLASSrất hữu ích nếu bạn muốn kết hợp chức năng nhà máy bên R với Mô-đun Rcpp, vì điều này tạo ra các phần mở rộng Rcpp::asvà Rcpp::wrapcần thiết để chuyển các đối tượng qua lại giữa R và C ++. Nhà máy có thể được xuất qua functionnhư bạn đã làm hoặc sử dụng Thuộc tính Rcpp, điều mà tôi thấy tự nhiên hơn:

#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()
*/

Đầu ra:

> Rcpp::sourceCpp('59384221/modules-expose.cpp')

> (d1 <- makeDouble(5.4))
C++ object <0x560366ebee10> of class 'Double' <0x560363d5f440>

> d1$square()
[1] 29.16

Liên quan đến dọn dẹp: Cả Rcpp::XPtrMô-đun và Rcpp đều đăng ký một bộ hoàn thiện mặc định gọi hàm hủy của đối tượng. Bạn cũng có thể thêm một bộ hoàn thiện tùy chỉnh nếu cần.

Tôi thấy khó đưa ra một khuyến nghị cho một trong những cách tiếp cận này. Có lẽ tốt nhất là thử từng cái trong số chúng trên một ví dụ đơn giản và xem những gì bạn thấy tự nhiên hơn để sử dụng.