计划执行与检查节点
executing-plans
按既定实施计划完成工作,保持过程检查和反馈。
add-rcpp-integration【效率与协作】高性能C++コードのためにRcppまたはRcppArmadilloをRパッケージに統合する。 セットアップ、C++関数の記述、RcppExportsの生成、コンパイル済みコードのテスト、 デバッグを網羅。プロファイリングでボトルネックが確認されたR関数が遅すぎる場合、 既存のC/C++ライブラリとのインターフェースが必要な場合、またはコンパイル済みコードが 有利なアルゴリズム(ループ、再帰、線形代数)を実装する時に使用する。
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
パフォーマンスが重要な処理にRcppを使用してRパッケージにC++コードを統合する。
usethis::use_rcpp()
これにより:
src/ディレクトリが作成されるRcppが追加されるR/packagename-package.Rに@useDynLibと@importFrom Rcpp sourceCppが作成される.gitignoreが更新されるRcppArmadilloの場合:
usethis::use_rcpp_armadillo()
期待結果: src/ディレクトリが作成される。DESCRIPTIONのLinkingToとImportsにRcppが追加される。R/packagename-package.Rに@useDynLibディレクティブが含まれる。
失敗時: usethis::use_rcpp()が失敗する場合、手動でsrc/を作成し、DESCRIPTIONにLinkingTo: RcppとImports: Rcppを追加し、パッケージレベルのドキュメントファイルに#' @useDynLib packagename, .registration = TRUEと#' @importFrom Rcpp sourceCppを追加する。
src/my_function.cppを作成する:
#include <Rcpp.h>
using namespace Rcpp;
//' Compute cumulative sum efficiently
//'
//' @param x A numeric vector
//' @return A numeric vector of cumulative sums
//' @export
// [[Rcpp::export]]
NumericVector cumsum_cpp(NumericVector x) {
int n = x.size();
NumericVector out(n);
out[0] = x[0];
for (int i = 1; i < n; i++) {
out[i] = out[i - 1] + x[i];
}
return out;
}
RcppArmadilloの場合:
#include <RcppArmadillo.h>
// [[Rcpp::depends(RcppArmadillo)]]
//' Matrix multiplication using Armadillo
//'
//' @param A A numeric matrix
//' @param B A numeric matrix
//' @return The matrix product A * B
//' @export
// [[Rcpp::export]]
arma::mat mat_mult(const arma::mat& A, const arma::mat& B) {
return A * B;
}
期待結果: src/my_function.cppに有効な// [[Rcpp::export]]アノテーションとroxygen形式の//'ドキュメントコメントを持つC++ソースファイルが存在する。
失敗時: ファイルが#include <Rcpp.h>(Armadilloの場合は<RcppArmadillo.h>)を使用していること、エクスポートアノテーションが関数シグネチャの直上の独立した行にあること、戻り値の型が有効なRcpp型にマップされることを確認する。
Rcpp::compileAttributes()
devtools::document()
期待結果: R/RcppExports.Rとsrc/RcppExports.cppが自動的に生成される。
失敗時: C++の構文エラーを確認する。エクスポートされる各関数の上に// [[Rcpp::export]]タグが存在することを確認する。
devtools::load_all()
期待結果: パッケージがエラーなくコンパイルされて読み込まれる。
失敗時: コンパイラ出力のエラーを確認する。一般的な問題:
Rcpp::depends属性の欠如test_that("cumsum_cpp matches base R", {
x <- c(1, 2, 3, 4, 5)
expect_equal(cumsum_cpp(x), cumsum(x))
})
test_that("cumsum_cpp handles edge cases", {
expect_equal(cumsum_cpp(numeric(0)), numeric(0))
expect_equal(cumsum_cpp(c(NA_real_, 1)), c(NA_real_, NA_real_))
})
期待結果: テストがパスし、C++関数がR相当の結果と同一の結果を生成し、エッジケース(空のベクトル、NA値)を正しく処理することが確認される。
失敗時: NAの処理でテストが失敗する場合、C++コードでNumericVector::is_na()を使用した明示的なNAチェックを追加する。空の入力でテストが失敗する場合、関数の先頭にゼロ長ベクトルに対するガード条件を追加する。
src/Makevarsを作成する:
PKG_CXXFLAGS = -O2
パッケージルートにcleanupを作成する(CRAN用):
#!/bin/sh
rm -f src/*.o src/*.so src/*.dll
実行可能にする:chmod +x cleanup
期待結果: src/Makevarsがコンパイラフラグを設定し、cleanupスクリプトがコンパイル済みオブジェクトを削除する。両ファイルがパッケージルートレベルに存在する。
失敗時: cleanupに実行権限があることを確認する(chmod +x cleanup)。Makefileスタイルのルールを追加する場合、Makevarsがインデントにスペースではなくタブを使用していることを確認する。
コンパイル済みアーティファクトが処理されていることを確認する:
^src/.*\.o$
^src/.*\.so$
^src/.*\.dll$
期待結果: .Rbuildignoreパターンが、ソースファイルとMakevarsを保持しながら、パッケージtarballにコンパイル済みオブジェクトファイルが含まれないようにする。
失敗時: devtools::check()を実行してsrc/内の予期しないファイルに関するNOTEを確認する。.o、.so、.dllファイルのみを除外するように.Rbuildignoreパターンを調整する。
devtools::load_all()が警告なくコンパイルされるR CMD checkがコンパイル警告なしでパスするcompileAttributes()の忘れ: C++ファイルを変更した後はRcppExportsを再生成しなければならないintではなくdoubleを使用するdeleteしないことRcpp::NumericVector::is_na()でチェックする@useDynLibの欠如: パッケージレベルのドキュメントには@useDynLib packagename, .registration = TRUEが必要create-r-package - Rcpp追加前のパッケージセットアップwrite-testthat-tests - コンパイル済み関数のテストsetup-github-actions-ci - CIにはC++ツールチェーンが必要submit-to-cran - コンパイル済みパッケージはCRANの追加チェックが必要