R/converged.R

In poissonconsulting/ml: Maximum Likelihood Analysis using R Expressions

#' Converged
#'
#' Test if an ml_analysis object converged.
#'
#' @param x An ml_analysis object.
#' @return A flag indicating whether the analysis converged.
#'
#' @export
#' @examples
#' expr <- "sum(dnorm(len, mu, sigma, log = TRUE))"
#' start <- list(mu = 20, sigma = 8)
#' data <- datasets::ToothGrowth
#' analysis <- ml_fit(expr, start, data = data)
#' ml_converged(analysis)
ml_converged <- function(x) {
  chk_s3_class(x, "ml_analysis")
  x$optim$convergence == 0L && !any(x$optim$hessian == 0)
}