blob: 92316da864612ef58d4a73cd067bd484b04cd7cf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SyncRNG.R
\docType{class}
\name{SyncRNG-class}
\alias{SyncRNG-class}
\alias{SyncRNG}
\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')
}
|
