LBFGSResults
The LBFGSResults
case class is used to group together all the outputs resulting from a call to a method implementing the L-BFGS optimization algorithm.
Value parameters
- finalFunctionValue
-
Option
value that represents the final value obtained for the objective function in the L-BFGS optimization. If the objective function was never evaluated due to errors in the arguments provided by the user to the L-BFGS method, this field will be set toNone
orSome(0)
depending on how the L-BFGS method was implemented. For new L-BFGS implementations, returningNone
is preferred overSome(0)
when the objective function is never evaluated. - lineSearchIncomplete
-
Option
value that represents the best incomplete results obtained by the line search algorithm before a failure occurred when performing a line search during the L-BFGS optimization. If the L-BFGS optimization is successful or produces an error that is not the result of a call to a line search algorithm, this value will be set toNone
. If the L-BFGS optimization is stopped due to an error produced by a call to a line search algorithm, this value will be set toSome
with an instance ofLBFGSLineSearchIncomplete
that represents the best result obtained by the line search algorithm before the error occurred. Some L-BFGS implementations are incapable of returning this data and will always returnNone
, regardless of the circumstances. - optimizedVariables
-
VectorD
that contains the optimized values of the variables that were provided as inputs to the L-BFGS optimization. - returnCode
-
LBFGSReturnCode
that represents the outcome of L-BFGS optimization.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any