new_optimizer {optimizeR} | R Documentation |
Construct optimizer
object
Description
This function constructs an S3 optimizer
object.
Usage
new_optimizer(
x = list(),
.optimizer = function() {
},
optimizer_name = character(),
optimizer_arguments = list(),
.objective = character(),
.initial = character(),
.value = character(),
.parameter = character(),
.direction = character(),
.output_ignore = character()
)
Arguments
x |
A |
.optimizer |
A
|
optimizer_name |
A |
optimizer_arguments |
A |
.objective |
A |
.initial |
A |
.value |
A |
.parameter |
A |
.direction |
A |
.output_ignore |
A |
Value
An S3 object of class optimizer
.
Format
An optimizer
object is a list
of six elements:
- optimizer
A
function
, the optimization algorithm.- optimizer_name
A
character
, the name ofoptimizer
.- optimizer_arguments
A named
list
, where each element is an additional function argument foroptimizer
.- optimizer_direction
Either
"min"
if the optimizer minimizes or"max"
if the optimizer maximizes.- optimizer_labels
A named
list
of fourcharacter
:- objective
the name of the function input of
optimizer
- initial
the name of the starting parameter values input of
optimizer
- value
the name of the optimal function value in the output list of
optimizer
- parameter
the name of the optimal parameter vector in the output list of
optimizer
.
- output_ignore
A
character
vector of element names in the outputlist
ofoptimizer
that are ignored. The elementsvalue
andparameter
are added automatically tooutput_ignore
, because they are saved separately, see the output documentation ofapply_optimizer
.