From 201e19975461c6fb04d4487346e2a0b68d2359dc Mon Sep 17 00:00:00 2001
From: Gertjan van den Burg <gertjanvandenburg@gmail.com>
Date: Thu, 14 Jan 2021 17:30:12 +0000
Subject: Rename directories, remove extra test dir

---
 R/man/SyncRNG-class.Rd | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 R/man/SyncRNG-class.Rd

(limited to 'R/man/SyncRNG-class.Rd')

diff --git a/R/man/SyncRNG-class.Rd b/R/man/SyncRNG-class.Rd
new file mode 100644
index 0000000..92316da
--- /dev/null
+++ b/R/man/SyncRNG-class.Rd
@@ -0,0 +1,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')
+
+}
-- 
cgit v1.2.3