R/rayleigh_distribution.R

In boostmath: 'R' Bindings for the 'Boost' Math Functions

#' @title Rayleigh Distribution Functions
#' @name rayleigh_distribution
#' @description Functions to compute the probability density function, cumulative distribution function, and quantile function for the Rayleigh distribution.
#' @param x quantile
#' @param sigma scale parameter (default is 1)
#' @param p probability (0 <= p <= 1)
#' @return A single numeric value with the computed probability density, log-probability density, cumulative distribution, log-cumulative distribution, or quantile depending on the function called.
#' @seealso [Boost Documentation](https://www.boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/dist_ref/dists/rayleigh.html) for more details on the mathematical background.
#' @examples
#' # Rayleigh distribution with sigma = 1
#' dist <- rayleigh_distribution(1)
#' # Apply generic functions
#' cdf(dist, 0.5)
#' logcdf(dist, 0.5)
#' pdf(dist, 0.5)
#' logpdf(dist, 0.5)
#' hazard(dist, 0.5)
#' chf(dist, 0.5)
#' mean(dist)
#' median(dist)
#' mode(dist)
#' range(dist)
#' quantile(dist, 0.2)
#' standard_deviation(dist)
#' support(dist)
#' variance(dist)
#' skewness(dist)
#' kurtosis(dist)
#' kurtosis_excess(dist)
#'
#' # Convenience functions
#' rayleigh_pdf(1)
#' rayleigh_lpdf(1)
#' rayleigh_cdf(1)
#' rayleigh_lcdf(1)
#' rayleigh_quantile(0.5)
NULL

#' @rdname rayleigh_distribution
#' @export
rayleigh_distribution <- function(sigma = 1) {
  structure(
    list(
      extptr = .Call(`rayleigh_init_`, sigma),
      sigma = sigma
    ),
    class = c("rayleigh_distribution", "boost_distribution")
  )
}

#' @rdname rayleigh_distribution
#' @export
rayleigh_pdf <- function(x, sigma = 1) {
  pdf(rayleigh_distribution(sigma), x)
}

#' @rdname rayleigh_distribution
#' @export
rayleigh_lpdf <- function(x, sigma = 1) {
  logpdf(rayleigh_distribution(sigma), x)
}

#' @rdname rayleigh_distribution
#' @export
rayleigh_cdf <- function(x, sigma = 1) {
  cdf(rayleigh_distribution(sigma), x)
}

#' @rdname rayleigh_distribution
#' @export
rayleigh_lcdf <- function(x, sigma = 1) {
  logcdf(rayleigh_distribution(sigma), x)
}

#' @rdname rayleigh_distribution
#' @export
rayleigh_quantile <- function(p, sigma = 1) {
  quantile(rayleigh_distribution(sigma), p)
}