Rエクステンションを書くときに名前付きVECSXPを返す方法

Question

最近、私はバグがありました。それを修正するときに、要素の名前が付けられたVECSXP（つまりRリストタイプ）を返すことができるかどうか疑問に思っていました。このC++コード：

SEXP do_bla() 
{ 
    int prtCnt = 0; 
    SEXP a = PROTECT(allocMatrix(REALSXP, 5, 5)); 
    prtCnt++; 
    SEXP b = PROTECT(allocVector(REALSXP, 5)); 
    prtCnt++; 
    SEXP OS = PROTECT(allocVector(VECSXP, 2)); 
    prtCnt++; 
    SET_VECTOR_ELT(OS, 0, a); 
    SET_VECTOR_ELT(OS, 1, b); 
    UNPROTECT(prtCnt); 
    return OS; 
} 

はRに私に二つの要素（行列およびベクトル）のリストを与える：

s[[1]]; s[[2]] 

：このようにインデックス付けすることができる

s <- .Call("do_bla", ....) 

これを可能にするためには何を変更する必要がありますか：

s$a; s$b 

これは可能ですか？

Answer 1

Writing R Extensionsの5.9.4節を参照してください。名前のベクトルを割り当てて入力し、リストにnames属性を設定します。

library(inline) 
named <- cfunction(signature(), ' 
    /* allocate and populate list */ 
    SEXP OS = PROTECT(allocVector(VECSXP, 2)); 
    SET_VECTOR_ELT(OS, 0, allocMatrix(REALSXP, 5, 5)); 
    SET_VECTOR_ELT(OS, 1, allocVector(REALSXP, 5)); 

    /* create names */ 
    SEXP nms = PROTECT(allocVector(STRSXP, 2)); 
    SET_STRING_ELT(nms, 0, mkChar("foo")); 
    SET_STRING_ELT(nms, 1, mkChar("bar")); 

    /* assign names to list */ 
    setAttrib(OS, R_NamesSymbol, nms); 

    /* cleanup and return */ 
    UNPROTECT(2); 
    return OS;') 

Answer 2

RのC API関数を使用して、これを行うために、より慣用的な方法があるかもしれません - しかし、次の追加は動作するはずです - 私はそれがより安全に、より簡潔であるようRcppを経由してC++にこだわる傾向がある：

SEXP n = PROTECT(Rf_allocVector(STRSXP, 2)); 
prtCnt++; 
SET_STRING_ELT(n, 0, Rf_mkChar("a")); 
SET_STRING_ELT(n, 1, Rf_mkChar("b")); 
Rf_setAttrib(OS, R_NamesSymbol, n); 

しかし、RのC関数に付属する定型文の多くを削除できるので、Rcppを使用することを強くお勧めします。

#include <Rcpp.h> 

// [[Rcpp::export]] 
SEXP do_bla() { 
    int prtCnt = 0; 
    SEXP a = PROTECT(Rf_allocMatrix(REALSXP, 5, 5)); 
    prtCnt++; 
    SEXP b = PROTECT(Rf_allocVector(REALSXP, 5)); 
    prtCnt++; 
    SEXP OS = PROTECT(Rf_allocVector(VECSXP, 2)); 
    prtCnt++; 
    SET_VECTOR_ELT(OS, 0, a); 
    SET_VECTOR_ELT(OS, 1, b); 

    SEXP n = PROTECT(Rf_allocVector(STRSXP, 2)); 
    prtCnt++; 
    SET_STRING_ELT(n, 0, Rf_mkChar("a")); 
    SET_STRING_ELT(n, 1, Rf_mkChar("b")); 
    Rf_setAttrib(OS, R_NamesSymbol, n); 

    UNPROTECT(prtCnt); 
    return OS; 
} 

// [[Rcpp::export]] 
SEXP do_bla2() { 
    return Rcpp::List::create(
     Rcpp::Named("a") = Rcpp::NumericMatrix(5, 5), 
     Rcpp::Named("b") = Rcpp::NumericVector(5)); 
} 

// [[Rcpp::export]] 
SEXP do_bla3() { 
    Rcpp::NumericMatrix m(5, 5); 
    Rcpp::NumericVector v(5); 
    Rcpp::List res = Rcpp::List::create(m, v); 
    res.names() = Rcpp::CharacterVector::create("a", "b"); 
    return res; 
} 

あなたが直接<Rinternals.h>を使用している場合はmkCharとsetAttribの代わりに、Rf_mkCharとRf_setAttribを使用する必要があります。ここにあなたの元の関数の修正版と一緒に2つの選択肢が、あります。

---

do_bla() 
# $a 
#    [,1]   [,2]   [,3]   [,4]   [,5] 
# [1,] 2.371515e-322 4.743030e-322 9.654277e-315 8.695555e-322 6.518868e-310 
# [2,] 2.794759e-316 2.371515e-322 6.763004e-317 2.371515e-322 6.952759e-310 
# [3,] 3.458460e-323 2.797257e-316 1.630417e-322 2.852530e-316 1.630417e-322 
# [4,] 6.441834e+170 1.976263e-323 4.092581e-316 1.976263e-323 4.125824e-316 
# [5,] 1.818440e-306 6.952931e-310 4.008825e-316 2.121996e-314 2.154669e-316 
# 
# $b 
# [1] 2.144130e-316 2.168146e-316 3.468674e-316 2.155101e-316 2.172224e-316 
# 
do_bla2() 
# $a 
#  [,1] [,2] [,3] [,4] [,5] 
# [1,] 0 0 0 0 0 
# [2,] 0 0 0 0 0 
# [3,] 0 0 0 0 0 
# [4,] 0 0 0 0 0 
# [5,] 0 0 0 0 0 
# 
# $b 
#[1] 0 0 0 0 0 

do_bla3() 
# $a 
#  [,1] [,2] [,3] [,4] [,5] 
# [1,] 0 0 0 0 0 
# [2,] 0 0 0 0 0 
# [3,] 0 0 0 0 0 
# [4,] 0 0 0 0 0 
# [5,] 0 0 0 0 0 
# 
# $b 
#[1] 0 0 0 0 0