R/eval_chf.R

In vincenzocoia/distionary: Create and Evaluate Probability Distributions

#' Cumulative Hazard Function
#'
#' Access a distribution's cumulative hazard function (chf).
#'
#' @inheritParams eval_cdf
#' @inherit eval_cdf return
#' @examples
#' d <- dst_unif(0, 4)
#' eval_chf(d, at = 0:4)
#' enframe_chf(d, at = 0:4)
#' @family distributional representations
#' @rdname chf
#' @export
eval_chf <- function(distribution, at) {
  checkmate::assert_class(distribution, "dst")
  checkmate::assert_numeric(at)
  eval_property(distribution, "chf", at)
}

#' @noRd
eval_chf_from_network <- function(distribution, at) {
  if (vtype(distribution) == "continuous") {
    sf <- eval_survival(distribution, at = at)
    -log(sf)
  } else {
    stop("Not valid for non-continuous distributions.")
  }
}

#' @rdname chf
#' @export
enframe_chf <- function(..., at, arg_name = ".arg", fn_prefix = "chf",
                        sep = "_") {
  enframe_general(
    ...,
    at = at, arg_name = arg_name, fn_prefix = fn_prefix,
    sep = sep, eval_fn = eval_chf
  )
}