optimbase.get: Get the value for the given element

In sbihorel/optimbase: R Port of the 'Scilab' Optimbase Module

Description

Get the value for the given element in an optimization object.

Usage

  optimbase.get(this = NULL, key = NULL)
  optimbase.histget(this = NULL, iter = NULL, key = NULL)

Arguments

this	An optimization object.
key	The name of the key to quiery. The list of available keys for query with optimbase.get is: 'verbose', 'x0', 'fx0', 'xopt', 'fopt', 'tolfunabsolute', 'tolfunrelative', 'tolfunmethod', 'tolxabsolute', 'tolxrelative', 'tolxmethod', 'maxfunevals', 'maxiter', 'iterations', 'function', 'status', 'historyfopt', 'historyxopt', 'verbosetermination', 'outputcommand', 'outputcommandarg', 'numberofvariables', 'storehistory', 'costfargument', 'boundsmin', 'boundsmax', 'nbineqconst', 'logfile', 'logfilehandle', 'logstartup', and'withderivatives'. The list of available keys for query with optimbase.histget is: 'historyxopt' and 'historyfopt'.
iter	The iteration at which the data is stored.

Details

While optimbase.get extracts the entire content of the object element, including historyxopt and historyfopt, optimbase.histget only extracts the content of the history at the iteration iter.

Value

Return the value of the list element key, or an error message if key does not exist.

Author(s)

Author of Scilab optimbase module: Michael Baudin (INRIA - Digiteo)

Author of R adaptation: Sebastien Bihorel ([e-mail])

See Also

optimbase, optimbase.set

sbihorel/optimbase documentation built on Jan. 31, 2022, 1:34 a.m.