getSolverParm-methods: Retrieve Current Parameter Settings Used By The Optimization...

In sybil: Efficient Constrained Based Modelling

Description

Retrieve current parameter settings used by the optimization software.

Usage

## S4 method for signature 'optObj_clpAPI'
getSolverParm(lp)

## S4 method for signature 'optObj_cplexAPI'
getSolverParm(lp)

## S4 method for signature 'optObj_glpkAPI'
getSolverParm(lp)

## S4 method for signature 'optObj_lpSolveAPI'
getSolverParm(lp)

Arguments

lp	An object extending class optObj.

Value

Returns a list containing the current parameter settings or zero/non-zero.

Methods

signature(lp = "optObj_clpAPI")

method to use with package optObj_clpAPI. This method calls functions clpAPI::getHitMaximumIterationsCLP, clpAPI::getMaximumIterationsCLP and clpAPI::getMaximumSecondsCLP and returns a list containing hitMaximumIterations, maximumIterations and maximumSeconds respectively. hitMaximumIterations should be TRUE, if maximum number of iteration (or time) bound was hit.

signature(lp = "optObj_cplexAPI")

method to use with package optObj_cplexAPI. This method writes the current parameter settings to the file "cplex_parameters.prm". The method returns zero if successfull, otherwise non-zero.

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.