getObjective: Retrieve objective function value

Description Usage Arguments Value Note Author(s) Examples

View source: R/retrieveMisc.R

Description

getObjective will access the final value(s) of the objective function. It is a generic function, with inputs/outputs on different classes described below:

Usage

1
getObjective(obj, addMinInfo=TRUE, ...)

Arguments

obj

NMRun, or problem inheriting from NMProblem

addMinInfo

Logical flag. Should the minimization info be added if it's available?

...

Additional parameters passed to other methods. problemNum for NMRun objects subProblems for NMSim* objects, and method (numeric vector) for NM7 objects

Value

For x of class NMBasicModel, a numeric vector with minimization information attached as an attribute. If x is of class NMBasicModelNM7, a vector with one entry for each method requested, For x of class NMSimModel, a numeric vector with one element for each subproblem chosen. If x is of class NMSimModelNM7, a vector with each selected subproblem number when only a single method is chosen, or a matrix with a column for each method and row for each sub-problem if multiple methods are selected. If x is of class NMRun, the output will vary according to the problem selected (as above).

Note

The parameters method and subProblem will be restricted to valid ranges suitable for the given object

Author(s)

Mango Solutions

Examples

1
2
3
4
5
## Not run: 
x <- importNm("theoph.con", path  = "examples/theoph")
getObjective(x)

## End(Not run)

RNMImport documentation built on May 2, 2019, 5:21 p.m.