returnCode {maxLik} | R Documentation |
These function extract success or failure information from optimization objects.
The returnCode
gives a numeric code, and returnMessage
a
brief description about the success or
failure of the optimization, and point to the problems occured (see
documentation for the
corresponding functions).
returnCode(x, ...) ## Default S3 method: returnCode(x, ...) ## S3 method for class 'maxLik' returnCode(x, ...) returnMessage(x, ...) ## S3 method for class 'maxim' returnMessage(x, ...) ## S3 method for class 'maxLik' returnMessage(x, ...)
x |
object, usually an optimization result |
... |
further arguments for other methods |
returnMessage
and returnCode
are a generic functions, with methods
for various optimisation algorithms.
The message should either describe
the convergence (stopping condition),
or the problem.
Integer for returnCode
, character for returnMessage
.
Different optimization routines may define it in a different way.
Ott Toomet
## maximise the exponential bell f1 <- function(x) exp(-x^2) a <- maxNR(f1, start=2) returnCode(a) # should be success (1 or 2) returnMessage(a) ## Now try to maximise log() function a <- maxNR(log, start=2) returnCode(a) # should give a failure (4) returnMessage(a)