R/document_algorithm.R

In multiRL: Reinforcement Learning Tools for Multi-Armed Bandit

#' @title Algorithm Packages (MLE, MAP)
#' @name algorithm
#' @description 
#'  
#'  The package supports the following eight optimization packages for finding 
#'    the optimal values of the model's free parameters 
#'    (default: global = "NLOPT_GN_MLSL", local = "NLOPT_LN_BOBYQA"). 
#'  
#' @section Class: 
#' \code{algorithm [Character]} 
#'  
#' @section Packages: 
#' \enumerate{
#'    \item L-BFGS-B (from \code{stats::optim}) 
#'    \item Simulated Annealing (\code{GenSA::GenSA})
#'    \item Genetic Algorithm (\code{GA::ga})
#'    \item Differential Evolution (\code{DEoptim::DEoptim})
#'    \item Bayesian Optimization (\code{mlrMBO::mbo})
#'    \item Particle Swarm Optimization (\code{pso::psoptim})
#'    \item Covariance Matrix Adapting Evolutionary Strategy (\code{cmaes::cma_es})
#'    \item Nonlinear Optimization (\code{nloptr::nloptr})
#' }
#' 
#' @section Example: 
#' \preformatted{ # supported algorithms
#' control = list(
#'  algorithm = c(
#'    "L-BFGS-B", "GenSA", "GA", "DEoptim",
#'    "Bayesian", "PSO", "CMA-ES", "NLOPT_GN_MLSL"
#'  )
#' )
#' }
NULL