Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richfitz committed Dec 3, 2024
1 parent a9c7ba3 commit 899e13f
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 24 deletions.
32 changes: 18 additions & 14 deletions R/random.R
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,8 @@ monty_random_exponential_mean <- function(mean, state) {

##' @export
##' @rdname monty_random_exponential
monty_random_n_exponential_mean <- function(n_samples, size, mean) {
cpp_monty_random_n_exponential_mean(n_samples, size, mean)
monty_random_n_exponential_mean <- function(n_samples, mean, state) {
cpp_monty_random_n_exponential_mean(n_samples, mean, state)
}


Expand Down Expand Up @@ -285,8 +285,8 @@ monty_random_beta <- function(a, b, state) {

##' @export
##' @rdname monty_random_beta
monty_random_n_beta <- function(n_samples, size, a, b) {
cpp_monty_random_n_beta(n_samples, size, a, b)
monty_random_n_beta <- function(n_samples, a, b, state) {
cpp_monty_random_n_beta(n_samples, a, b, state)
}


Expand Down Expand Up @@ -337,7 +337,7 @@ monty_random_cauchy <- function(location, scale, state) {


##' @export
##' @rdname monty_random_binomial
##' @rdname monty_random_cauchy
monty_random_n_cauchy <- function(n_samples, location, scale, state) {
cpp_monty_random_n_cauchy(n_samples, location, scale, state)
}
Expand All @@ -352,7 +352,7 @@ monty_random_n_cauchy <- function(n_samples, location, scale, state) {
##'
##' @param scale Scale
##''
##' @param n_threads Number of threads to use; see Details
##'
##' @inheritParams monty_random_real
##' @inherit monty_random_real return
##'
Expand All @@ -370,6 +370,7 @@ monty_random_n_gamma_scale <- function(n_samples, shape, scale, state) {
}


##' @param rate Rate
##' @export
##' @rdname monty_random_gamma
monty_random_gamma_rate <- function(shape, rate, state) {
Expand Down Expand Up @@ -412,6 +413,9 @@ monty_random_n_negative_binomial_prob <- function(n_samples, size, prob,
}



##' @param mu The mean (zero or more)
##'
##' @inheritParams monty_random_real
##' @inherit monty_random_real return
##'
Expand Down Expand Up @@ -444,15 +448,15 @@ monty_random_n_negative_binomial_mu <- function(n_samples, size, mu, state) {
##' @inherit monty_random_real return
##'
##' @export
monty_random_normal <- function(size, mean, sd) {
cpp_monty_random_normal(size, mean, sd)
monty_random_normal <- function(mean, sd, state) {
cpp_monty_random_normal(mean, sd, state)
}


##' @export
##' @rdname monty_random_normal
monty_random_n_normal <- function(n_samples, size, mean, sd) {
cpp_monty_random_n_normal(n_samples, size, mean, sd)
monty_random_n_normal <- function(n_samples, mean, sd, state) {
cpp_monty_random_n_normal(n_samples, mean, sd, state)
}


Expand All @@ -468,15 +472,15 @@ monty_random_n_normal <- function(n_samples, size, mean, sd) {
##' @inherit monty_random_real return
##'
##' @export
monty_random_uniform <- function(size, min, max) {
cpp_monty_random_uniform(size, min, max)
monty_random_uniform <- function(min, max, state) {
cpp_monty_random_uniform(min, max, state)
}


##' @export
##' @rdname monty_random_uniform
monty_random_n_uniform <- function(n_samples, size, min, max) {
cpp_monty_random_n_uniform(n_samples, size, min, max)
monty_random_n_uniform <- function(n_samples, min, max, state) {
cpp_monty_random_n_uniform(n_samples, min, max, state)
}


Expand Down
2 changes: 1 addition & 1 deletion man/monty_random_beta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/monty_random_binomial.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions man/monty_random_cauchy.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/monty_random_exponential.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/monty_random_gamma.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/monty_random_negative_binomial.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/monty_random_normal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions man/monty_random_uniform.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 899e13f

Please sign in to comment.