带有指向 C 结构的指针的 S4 对象

Question

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

Answer 1

正如@hrbrmstr 所指出的，您可以使用externalptr 类型来保持此类对象“活动”，这在编写R 扩展的this section 中有所提及，尽管我看不出有任何理由为什么您会这样做需要将任何内容存储为void*。如果您对使用一点 C++ 没有任何问题，Rcpp class XPtr 可以消除与管理EXTPTRSXPs 相关的大量样板文件。例如，假设以下简化示例代表您的第三方库的 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），以便 XPtr 不会调用 @ 987654336@ 在通过malloc 等分配的内存上，当相应的 R 对象被垃圾回收时。

继续该示例，假设您编写以下函数来与您的CStruct 交互：

// [[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;
}

---

此时，您已经完成了足够的工作，可以从 R 开始处理 CStructs：

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

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

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
    }
) 

---

然后，我们可以像这样使用CStructs：

ptr <- new("CStruct")
ptr@summarize()
# count: 0
# total: 0.000000
# average: 0.000000

set.seed(123)
ptr@update(rnorm(100))
ptr@summarize()
# count: 100
# total: 9.040591
# average: 0.090406

ptr@update(rnorm(100))
ptr@summarize()
# count: 200
# total: -1.714089
# average: -0.008570

ptr@reset()
ptr@summarize()
# count: 0
# total: 0.000000
# average: 0.000000

rm(ptr); gc()
# free_CStruct called.
#          used (Mb) gc trigger (Mb) max used (Mb)
# Ncells 484713 25.9     940480 50.3   601634 32.2
# Vcells 934299  7.2    1650153 12.6  1308457 10.0

---

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