Question

我有一个第三方C库，用于编写R扩展名。我需要创建一些在库中定义的结构（并初始化它们）我需要将它们作为S4对象的一部分进行维护（将这些结构视为定义计算状态，销毁它们将破坏所有剩余的计算和已经计算过的所有结果）。我正在考虑创建一个S4对象来将这些结构指针保存为void*指针，但是根本不清楚如何这样做，插槽的类型是什么？

Answer 1

正如@hrbrmstr所指出的，你可以使用externalptr类型来保持这些对象“活着”，这在写作R扩展的this section中有所涉及，尽管我没有看到任何您需要将任何内容存储为void*的原因。如果使用一点C ++没有任何问题，Rcpp class XPtr可以消除管理EXTPTRSXP所涉及的大量样板文件。例如，假设以下简化示例代表您的第三方库的API：

#include <Rcpp.h>
#include <stdlib.h>

typedef struct {
    unsigned int count;
    double total;
} CStruct;

CStruct* init_CStruct() {
    return (CStruct*)::malloc(sizeof(CStruct));
}

void free_CStruct(CStruct* ptr) {
    ::free(ptr);
    ::printf("free_CStruct called.\n");
}

typedef Rcpp::XPtr<CStruct, Rcpp::PreserveStorage, free_CStruct> xptr_t;

使用new创建的指针时，使用Rcpp::XPtr<SomeClass>通常就足够了，因为default finalizer只是在保留的对象上调用delete。但是，由于您正在处理C API，我们必须提供（默认）模板参数Rcpp::PreserveStorage，更重要的是，提供适当的终结器（在此示例中为free_CStruct），以便{{1当对应的R对象被垃圾收集时，不会通过XPtr等分配的内存上调用delete。

继续该示例，假设您编写以下函数以与malloc进行交互：

CStruct

此时，您已经做了足够的事情从R：

开始处理

// [[Rcpp::export]]
xptr_t MakeCStruct() {
    CStruct* ptr = init_CStruct();
    ptr->count = 0;
    ptr->total = 0;

    return xptr_t(ptr, true);
}

// [[Rcpp::export]]
void UpdateCStruct(xptr_t ptr, SEXP x) {
    if (TYPEOF(x) == REALSXP) {
        R_xlen_t i = 0, sz = XLENGTH(x);
        for ( ; i < sz; i++) {
            if (!ISNA(REAL(x)[i])) {
                ptr->count++;
                ptr->total += REAL(x)[i];
            }
        }
        return;
    }

    if (TYPEOF(x) == INTSXP) {
        R_xlen_t i = 0, sz = XLENGTH(x);
        for ( ; i < sz; i++) {
            if (!ISNA(INTEGER(x)[i])) {
                ptr->count++;
                ptr->total += INTEGER(x)[i];
            }
        }
        return;
    }

    Rf_warning("Invalid SEXPTYPE.\n");
}

// [[Rcpp::export]]
void SummarizeCStruct(xptr_t ptr) {
    ::printf(
        "count: %d\ntotal: %f\naverage: %f\n",
        ptr->count, ptr->total,
        ptr->count > 0 ? ptr->total / ptr->count : 0
    );
}

// [[Rcpp::export]]
int GetCStructCount(xptr_t ptr) {
    return ptr->count;
}

// [[Rcpp::export]]
double GetCStructTotal(xptr_t ptr) {
    return ptr->total;
}

// [[Rcpp::export]]
void ResetCStruct(xptr_t ptr) {
    ptr->count = 0;
    ptr->total = 0.0;
}

CStructs会初始化ptr <- MakeCStruct()并将其存储为R中的CStruct
externalptr会修改UpdateCStruct(ptr, x)中存储的数据，CStruct会打印摘要等。
SummarizeCStruct(ptr)将删除rm(ptr); gc()对象并强制垃圾收集器运行，从而调用ptr并销毁C端的对象

您提到了使用S4类，这是在一个地方包含所有这些功能的一个选项。这是一种可能性：

free_CStruct(ptr)

然后，我们可以像这样使用setClass( "CStruct", slots = c( ptr = "externalptr", update = "function", summarize = "function", get_count = "function", get_total = "function", reset = "function" ) ) setMethod( "initialize", "CStruct", function(.Object) { .Object@ptr <- MakeCStruct() .Object@update <- function(x) { UpdateCStruct(.Object@ptr, x) } .Object@summarize <- function() { SummarizeCStruct(.Object@ptr) } .Object@get_count <- function() { GetCStructCount(.Object@ptr) } .Object@get_total <- function() { GetCStructTotal(.Object@ptr) } .Object@reset <- function() { ResetCStruct(.Object@ptr) } .Object } )：

CStruct

当然，另一种选择是使用Rcpp Modules，它或多或少地处理R侧的类定义样板（但是使用引用类而不是S4类）。

带有指向C结构

1 个答案: