R/mapairy_distribution.R

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

#' @title Map-Airy Distribution Functions
#' @name mapairy_distribution
#' @description Functions to compute the probability density function, cumulative distribution function, and quantile function for the Map-Airy distribution.
#' @param x quantile
#' @param location location parameter (default is 0)
#' @param scale 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/mapairy_dist.html) for more details on the mathematical background.
#' @examples
#' # Map-Airy distribution with location 0 and scale 1
#' dist <- mapairy_distribution(0, 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)
#'
#' # Convenience functions
#' mapairy_pdf(3)
#' mapairy_lpdf(3)
#' mapairy_cdf(3)
#' mapairy_lcdf(3)
#' mapairy_quantile(0.5)
NULL

#' @rdname mapairy_distribution
#' @export
mapairy_distribution <- function(location = 0, scale = 1) {
  structure(
    list(
      extptr = .Call(`mapairy_init_`, location, scale),
      location = location,
      scale = scale
    ),
    class = c("mapairy_distribution", "boost_distribution")
  )
}

#' @rdname mapairy_distribution
#' @export
mapairy_pdf <- function(x, location = 0, scale = 1) {
  pdf(mapairy_distribution(location, scale), x)
}

#' @rdname mapairy_distribution
#' @export
mapairy_lpdf <- function(x, location = 0, scale = 1) {
  logpdf(mapairy_distribution(location, scale), x)
}

#' @rdname mapairy_distribution
#' @export
mapairy_cdf <- function(x, location = 0, scale = 1) {
  cdf(mapairy_distribution(location, scale), x)
}

#' @rdname mapairy_distribution
#' @export
mapairy_lcdf <- function(x, location = 0, scale = 1) {
  logcdf(mapairy_distribution(location, scale), x)
}

#' @rdname mapairy_distribution
#' @export
mapairy_quantile <- function(p, location = 0, scale = 1) {
  quantile(mapairy_distribution(location, scale), p)
}