Provided within is a high quality and fast PPRNG that is able to be used in an 'OpenMP' parallel environment compiled under either C++98 or C++11. The objective of this package release is to consolidate the distribution of the 'sitmo' library on CRAN by enabling others to link to the 'sitmo' header file instead of including a copy of 'sitmo' within their individual package. Lastly, the package contains example implementations using 'sitmo' and three accompanying vignette that provide additional information.
The repository houses the
sitmo R package for Parallel Psuedo Random Number Generation (PPRNG). The package provides a way to obtain the
sitmo header files via LinkTo.
sitmo is available on both CRAN (Stable) and GitHub (Development). Using CRAN to download and install
sitmo is the preferred option as it is significantly more stable vs. the GitHub version.
To install the package from CRAN, you can simply type:
The package will be installed and available in a similar fashion to other R packages. The main exception to this note is that to use
sitmo to create a package you will need to acquire a compiler. This is detailed under the development install instructions.
To install the package, you must first have a compiler on your system that is compatible with R.
For help on obtaining a compiler consult:
With a compiler in hand, one can then install the package from GitHub by:
There are two ways to use
sitmo. The first is to use
sitmo in a standalone script. The script is typically built using
sourceCpp(). The second approach allows for
sitmo to be used within an R package.
C++ file, the
sitmo package provides an Rcpp plugins' depends statement that must be included after
sitmo.h header. This plugin statement indicates that a dependency is
Below is a hello world example meant to show a basic implementation of
// C++11 RNG library// SITMO PPRNG// Rcpp depends attribute is required for standalone use.// It is not needed if in package linking to the sitmo package (detailed next).// [[Rcpp::depends(sitmo)]]// [[Rcpp::export]]Rcpp::NumericVector/*** Rsitmo_draws_ex(5)*/
sitmo in your R package, modify the
DESCRIPTION file by adding:
LinkingTo: Rcpp, sitmo Imports: Rcpp (>= 0.12.11)
To use C++11's statistical distributions, you may want to add the following to your
CXX_STD = CXX11
C++ file, then add:
// SITMO PPRNG
Rcpp.plugin.maker()by using the exported variable name, e.g.
::, in place of the internal variable name, e.g.
sitmoURL to point to
sitmo_two_seeds()src and documentation in "Deployment of
sitmowithin C++ Code" so that it uses the second seed for eng2 and returns an n x 2 matrix instead of n x 3. (#5, thanks @helske)
sitmoCxxFlags()functions to display
src/init.cto address R 3.4 C++ registration requirement (#2)
sitmowithin C++ Code" vignette.
sitmoheader file in an R package.
sitmowithin C++ Code
sitmo's BigCrush Results