aboutsummaryrefslogtreecommitdiff
path: root/man/SyncRNG-class.Rd
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2021-01-14 17:15:44 +0000
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2021-01-14 17:15:44 +0000
commit4214782b1e06ce8510d70cc2fc36a3b544508948 (patch)
treed0f848e77771b833160bda6d50649bb001eb4f59 /man/SyncRNG-class.Rd
parentadd NEWS.md to git (diff)
downloadSyncRNG-4214782b1e06ce8510d70cc2fc36a3b544508948.tar.gz
SyncRNG-4214782b1e06ce8510d70cc2fc36a3b544508948.zip
Move R package to separate directory
Rearranging repository
Diffstat (limited to 'man/SyncRNG-class.Rd')
-rw-r--r--man/SyncRNG-class.Rd38
1 files changed, 0 insertions, 38 deletions
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')
-
-}
-