maxLik (version 1.3-6)

returnCode: Success or failure of the optimization

Description

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).

Usage

returnCode(x, ...)
# S3 method for default
returnCode(x, ...)
# S3 method for maxLik
returnCode(x, ...)
returnMessage(x, ...)
# S3 method for maxim
returnMessage(x, ...)
# S3 method for maxLik
returnMessage(x, ...)

Arguments

x

object, usually an optimization result

...

further arguments for other methods

Value

Integer for returnCode, character for returnMessage. Different optimization routines may define it in a different way.

Details

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.

See Also

maxNR, maxBFGS

Examples

# NOT RUN {
## 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)
# }