rcpptimer: Rcpp Tic-Toc Timer with OpenMP Support

TL;DR

The rcpptimer package offers an easy-to-use, high-resolution timing tool for C++ code within R, supporting nested timers and OpenMP, simplifying benchmarking and profiling for Rcpp users.

Contribution

It introduces a user-friendly, high-resolution timer with OpenMP support for Rcpp, filling a gap in benchmarking tools for R users writing C++ code.

Findings

Supports nanosecond-level timing resolution

Enables nested and overlapping timers

Integrates seamlessly with R and Rcpp

Abstract

Efficient code writing is both a critical and challenging task, especially with the growing demand for computationally intensive algorithms in statistical and machine-learning applications. Despite the availability of significant computational power today, the need for optimized algorithm implementations remains crucial. Many R users rely on Rcpp to write performant code in C++, but writing and benchmarking C++ code presents its own difficulties. While R's benchmarking tools are insufficient for measuring the execution times of C++ code segments, C++'s native profiling tools often come with a steep learning curve. The rcpptimer package bridges this gap by offering a simple and efficient solution for timing C++ code within the Rcpp ecosystem. This novel package introduces a user-friendly tic-toc class that supports overlapping and nested timers and OpenMP parallelism, providing nanosecond-level time resolution. Results, including summary statistics, are seamlessly passed back to R without requiring users to write any C++ code. This paper contextualizes the rcpptimer package within the broader ecosystem of R and C++ profiling tools, explains the motivation behind its development, and offers a comprehensive overview of its implementation. Supplementary to this paper, we provide multiple vignettes that thoroughly explain this package's usage.