setSolverParm-methods: Set Parameters Used By The Optimization Software

In sybil: Efficient Constrained Based Modelling

Description

Set parameters used by the optimization software. Parameters are set on a key-value basis. Sets of parameters can be set via a named list or a named data frame. The names of the parameters itself and possible values differ from solver to solver. Please consult the documentation of your solver software to get information about available parameters.

Usage

## S4 method for signature 'optObj_clpAPI'
setSolverParm(lp, solverParm)

## S4 method for signature 'optObj_cplexAPI'
setSolverParm(lp, solverParm)

## S4 method for signature 'optObj_glpkAPI'
setSolverParm(lp, solverParm)

## S4 method for signature 'optObj_lpSolveAPI'
setSolverParm(lp, solverParm)

Arguments

lp	An object extending class optObj.
solverParm	A named list or data frame containing sets of parameters. They must not contain NA values and every list or data frame element must have length one.

Methods

signature(lp = "optObj_clpAPI")

method to use with package optObj_clpAPI. It is possible to set numberIterations, maximumIterations and maximumSeconds, which call the respective functions setNumberIterationsCLP, setMaximumIterationsCLP and setMaximumSecondsCLP in clpAPI.

signature(lp = "optObj_cplexAPI")

method to use with package optObj_cplexAPI. In order to set integer parameters (parameters of type CPXINT), the value must be of type integer. For example, like as.integer(42) or 23L.

signature(lp = "optObj_glpkAPI")

method to use with package optObj_glpkAPI.

signature(lp = "optObj_lpSolveAPI")

method to use with package optObj_lpSolveAPI.

Author(s)

Gabriel Gelius-Dietrich <[e-mail]>

Maintainer: Mayo Roettger <[e-mail]>

See Also

Superclass optObj and constructor function optObj.

sybil documentation built on May 31, 2021, 5:08 p.m.