R/solvergater.R

In maciejsmolka/solvergater: External Solver Gateway in R

#' solvergater: External solver gateway in R
#'
#' The solvergater package provides the following categories of functions:
#' solver handlers, objective providers and helpers.
#'
#' @section Solver handlers:
#' * [r_solver()]
#' * [shell_solver()]
#' * [fake_simple_solver()]
#' * [run()]
#' * [nparams()]
#' * [nparams<-()]
#' * [provides_jacobian()]
#' * [run_count()]
#'
#' @section Objective providers:
#' * [objective()]
#' * [objective_functions()]
#' * [make_functions()]
#' * [differentiable()]
#' * [squared_error()]
#'
#' @section Helpers:
#' * [read_matrix()]
#' * [write_matrix()]
#' * [output_file()]
#'
#' @docType package
#' @name solvergater
NULL