R/zzz.R

In ROI.plugin.deoptim: 'DEoptim' and 'DEoptimR' Plugin for the 'R' Optimization Interface

## ROI plugin: DEoptim

##' VTR = -Inf
##' strategy = 2
##' bs = FALSE
##' NP = NA
##' itermax = 200
##' CR = 0.5
##' F = 0.8
##' trace = TRUE
##' initialpop = NULL
##' storepopfrom = itermax + 1
##' storepopfreq = 1
##' p = 0.2
##' c = 0
##' reltol
##' steptol
##' parallelType = 0
##' packages = c()
##' parVar = c()
##' foreachArgs = list()

ROI_make_signature_deoptimr <- function()
    ROI_plugin_make_signature( objective = c("F"),
                               constraints = c("X", "L", "Q", "F"),
                               types = c("C"),
                               bounds = c("X", "V"),
                               cones = c("X"),
                               maximum = c(TRUE, FALSE) )

ROI_make_signature_deoptim <- function()
    ROI_plugin_make_signature( objective = c("F"),
                               constraints = c("X"),
                               types = c("C"),
                               bounds = c("X", "V"),
                               cones = c("X"),
                               maximum = c(TRUE, FALSE) )

## SOLVER CONTROLS
.add_controls_deoptimr <- function( solver ) {
    ROI_plugin_register_solver_control( solver, "start", "start")
    ROI_plugin_register_solver_control( solver, "dry_run", "dry_run")

    ## DEoptimR
    ROI_plugin_register_solver_control( solver, "eps", "X")
    ROI_plugin_register_solver_control( solver, "NP", "X")
    ROI_plugin_register_solver_control( solver, "Fl", "X")
    ROI_plugin_register_solver_control( solver, "Fu", "X")
    ROI_plugin_register_solver_control( solver, "tau_F", "X")
    ROI_plugin_register_solver_control( solver, "tau_CR", "X")
    ROI_plugin_register_solver_control( solver, "tau_pF", "X")
    ROI_plugin_register_solver_control( solver, "jitter_factor", "X")
    ROI_plugin_register_solver_control( solver, "tol", "tol")
    ROI_plugin_register_solver_control( solver, "maxiter", "max_iter")
    ROI_plugin_register_solver_control( solver, "fnscale", "X")
    ROI_plugin_register_solver_control( solver, "compare_to", "X")
    ROI_plugin_register_solver_control( solver, "add_to_init_pop", "X")
    ROI_plugin_register_solver_control( solver, "trace", "verbose")
    ROI_plugin_register_solver_control( solver, "triter", "X")
    ROI_plugin_register_solver_control( solver, "details", "X")

    invisible( TRUE )
}

.add_controls_deoptim <- function( solver ) {
    ROI_plugin_register_solver_control( solver, "start", "start")
    ROI_plugin_register_solver_control( solver, "dry_run", "dry_run")

    ## DEoptim

    ROI_plugin_register_solver_control( solver, "VTR", "X")
    ROI_plugin_register_solver_control( solver, "strategy", "X")
    ROI_plugin_register_solver_control( solver, "bs", "X")
    ROI_plugin_register_solver_control( solver, "NP", "X")
    ROI_plugin_register_solver_control( solver, "itermax", "max_iter")
    ROI_plugin_register_solver_control( solver, "CR", "X")
    ROI_plugin_register_solver_control( solver, "F", "X")
    ROI_plugin_register_solver_control( solver, "trace", "verbose")
    ROI_plugin_register_solver_control( solver, "initialpop", "X")
    ROI_plugin_register_solver_control( solver, "storepopfrom", "X")
    ROI_plugin_register_solver_control( solver, "storepopfreq", "X")
    ROI_plugin_register_solver_control( solver, "p", "X")
    ROI_plugin_register_solver_control( solver, "c", "X")
    ROI_plugin_register_solver_control( solver, "reltol", "rel_tol")
    ROI_plugin_register_solver_control( solver, "steptol", "X")
    ROI_plugin_register_solver_control( solver, "parallelType", "X")
    ROI_plugin_register_solver_control( solver, "packages", "X")
    ROI_plugin_register_solver_control( solver, "parVar", "X")
    ROI_plugin_register_solver_control( solver, "foreachArgs", "X")

    invisible( TRUE )
}

.onLoad <- function( libname, pkgname ) {
    ## Solver plugin name (based on package name)
    if( ! pkgname %in% ROI_registered_solvers() ){
        ## Register solver methods here.
        ## One can assign several signatures a single solver method
        solver <- "deoptimr"
        ROI_plugin_register_solver_method(
            signatures = ROI_make_signature_deoptimr(),
            solver = solver,
            method = getFunction( "solve_op_deoptimr", where = getNamespace(pkgname)),
            plugin = "deoptim" )
        .add_status_codes( solver )
        .add_controls_deoptimr( solver )

        solver <- "deoptim"
        ROI_plugin_register_solver_method(
            signatures = ROI_make_signature_deoptim(),
            solver = solver,
            method = getFunction( "solve_op_deoptim", where = getNamespace(pkgname)), 
            plugin = "deoptim" )
        .add_status_codes( solver )
        .add_controls_deoptim( solver )
    }
}