From 5245e3a8f8bcaabcbf793cacc7047dce4017dfc6 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 14 Oct 2016 21:47:36 +0200 Subject: minor documentation fixes and add cran-comments --- man/SyncRNG-class.Rd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'man') diff --git a/man/SyncRNG-class.Rd b/man/SyncRNG-class.Rd index 599b540..d09f331 100644 --- a/man/SyncRNG-class.Rd +++ b/man/SyncRNG-class.Rd @@ -30,7 +30,7 @@ user} \item{\code{shuffle(x)}}{Randomly shuffle a provided array of values} }} \examples{ -s = SyncRNG(seed=123456) +s <- SyncRNG(seed=123456) for (i in 1:10) cat(s$randi(), '\\n') } -- cgit v1.2.3 From 3fb8d4aca52c3004d52bd510e183c1d5682b5540 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sun, 16 Oct 2016 12:13:36 +0200 Subject: update to latest version of roxygen --- man/SyncRNG-class.Rd | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'man') diff --git a/man/SyncRNG-class.Rd b/man/SyncRNG-class.Rd index d09f331..6f6d27d 100644 --- a/man/SyncRNG-class.Rd +++ b/man/SyncRNG-class.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/SyncRNG.R \docType{class} \name{SyncRNG-class} @@ -13,7 +13,7 @@ A Reference Class for SyncRNG \describe{ \item{\code{seed}}{The seed for the random number generator} -\item{\code{state}}{The current state of the RNG, should not be modified by the +\item{\code{state}}{The current state of the RNG, should not be modified by the user} }} \section{Methods}{ @@ -33,5 +33,6 @@ user} s <- SyncRNG(seed=123456) for (i in 1:10) cat(s$randi(), '\\n') + } -- cgit v1.2.3 From c7c6d55dfb75804b119ae310e5c59ac238348665 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 15 Dec 2017 17:26:12 -0500 Subject: update version and documentation --- man/SyncRNG-class.Rd | 2 +- man/syncrng-package.Rd | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 man/syncrng-package.Rd (limited to 'man') diff --git a/man/SyncRNG-class.Rd b/man/SyncRNG-class.Rd index 6f6d27d..7a2c69b 100644 --- a/man/SyncRNG-class.Rd +++ b/man/SyncRNG-class.Rd @@ -6,7 +6,7 @@ \alias{SyncRNG-class} \title{A Reference Class for SyncRNG} \description{ -A Reference Class for SyncRNG +See \link{syncrng-package} for package documentation. } \section{Fields}{ diff --git a/man/syncrng-package.Rd b/man/syncrng-package.Rd new file mode 100644 index 0000000..a1b3d32 --- /dev/null +++ b/man/syncrng-package.Rd @@ -0,0 +1,52 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/syncrng-package.R +\docType{package} +\name{syncrng-package} +\alias{syncrng-package} +\title{SyncRNG - Synchronized Random Numbers in R and Python} +\description{ +The SyncRNG package provides a random number generator implemented in C and +linked to both R and Python. This way, you can generate the same random +number sequence in both languages by using the same seed. + +The package implements a Tausworthe LSFR RNG (more details at +\url{https://gertjanvandenburg.com/blog/syncrng/}). This is a very fast +pseudo-random number generator. +} +\section{Usage}{ + +There are two ways to use this package in R. It can be used as a reference +class, where a SyncRNG object is used to keep the state of the generator and +numbers are generated using the object methods. It can also be used as a +user-defined random number generator using the strategy outlined in +.Random.user. See the examples section below. +} +\examples{ +library(SyncRNG) + +# As user defined RNG: + +set.seed(0, 'user', 'user') +runif(2) +# [1] 3.666952e-04 6.257184e-05 +set.seed(0, 'user', 'user') +rnorm(2) +# [1] 0.01006027 0.42889422 + +# As class: + +s <- SyncRNG(seed=0) +s$rand() +# [1] 0.0003666952 +s$rand() +# [1] 6.257184e-05 + +} +\author{ +Gerrit J.J. van den Burg\cr +Maintainer: Gerrit J.J. van den Burg +} +\references{ +URL: \url{https://github.com/GjjvdBurg/SyncRNG} +} + -- cgit v1.2.3 From 4214782b1e06ce8510d70cc2fc36a3b544508948 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Thu, 14 Jan 2021 17:15:44 +0000 Subject: Move R package to separate directory Rearranging repository --- man/SyncRNG-class.Rd | 38 ------------------------------------ man/syncrng-package.Rd | 52 -------------------------------------------------- 2 files changed, 90 deletions(-) delete mode 100644 man/SyncRNG-class.Rd delete mode 100644 man/syncrng-package.Rd (limited to 'man') diff --git a/man/SyncRNG-class.Rd b/man/SyncRNG-class.Rd deleted file mode 100644 index 7a2c69b..0000000 --- a/man/SyncRNG-class.Rd +++ /dev/null @@ -1,38 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/SyncRNG.R -\docType{class} -\name{SyncRNG-class} -\alias{SyncRNG} -\alias{SyncRNG-class} -\title{A Reference Class for SyncRNG} -\description{ -See \link{syncrng-package} for package documentation. -} -\section{Fields}{ - -\describe{ -\item{\code{seed}}{The seed for the random number generator} - -\item{\code{state}}{The current state of the RNG, should not be modified by the -user} -}} -\section{Methods}{ - -\describe{ -\item{\code{initialize(..., seed = 0)}}{Initialize the RNG using the C function R_syncrng_seed} - -\item{\code{rand()}}{Generate a single random float in the range [0, 1)} - -\item{\code{randbelow(n)}}{Generate a random integer below a given number} - -\item{\code{randi()}}{Generate a single random 32-bit integer} - -\item{\code{shuffle(x)}}{Randomly shuffle a provided array of values} -}} -\examples{ -s <- SyncRNG(seed=123456) -for (i in 1:10) - cat(s$randi(), '\\n') - -} - diff --git a/man/syncrng-package.Rd b/man/syncrng-package.Rd deleted file mode 100644 index a1b3d32..0000000 --- a/man/syncrng-package.Rd +++ /dev/null @@ -1,52 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/syncrng-package.R -\docType{package} -\name{syncrng-package} -\alias{syncrng-package} -\title{SyncRNG - Synchronized Random Numbers in R and Python} -\description{ -The SyncRNG package provides a random number generator implemented in C and -linked to both R and Python. This way, you can generate the same random -number sequence in both languages by using the same seed. - -The package implements a Tausworthe LSFR RNG (more details at -\url{https://gertjanvandenburg.com/blog/syncrng/}). This is a very fast -pseudo-random number generator. -} -\section{Usage}{ - -There are two ways to use this package in R. It can be used as a reference -class, where a SyncRNG object is used to keep the state of the generator and -numbers are generated using the object methods. It can also be used as a -user-defined random number generator using the strategy outlined in -.Random.user. See the examples section below. -} -\examples{ -library(SyncRNG) - -# As user defined RNG: - -set.seed(0, 'user', 'user') -runif(2) -# [1] 3.666952e-04 6.257184e-05 -set.seed(0, 'user', 'user') -rnorm(2) -# [1] 0.01006027 0.42889422 - -# As class: - -s <- SyncRNG(seed=0) -s$rand() -# [1] 0.0003666952 -s$rand() -# [1] 6.257184e-05 - -} -\author{ -Gerrit J.J. van den Burg\cr -Maintainer: Gerrit J.J. van den Burg -} -\references{ -URL: \url{https://github.com/GjjvdBurg/SyncRNG} -} - -- cgit v1.2.3