Crate liblbfgs_sys

Crate liblbfgs_sys 

Source

Structs§

lbfgs_parameter_t
L-BFGS optimization parameters. Call lbfgs_parameter_init() function to initialize parameters to the default values.

Constants§

LBFGSERR_CANCELED
The minimization process has been canceled.
LBFGSERR_INCORRECT_TMINMAX
A logic error occurred; alternatively, the interval of uncertainty became too small.
LBFGSERR_INCREASEGRADIENT
The current search direction increases the objective function value.
LBFGSERR_INVALIDPARAMETERS
A logic error (negative line-search step) occurred.
LBFGSERR_INVALID_DELTA
Invalid parameter lbfgs_parameter_t::delta specified.
LBFGSERR_INVALID_EPSILON
Invalid parameter lbfgs_parameter_t::epsilon specified.
LBFGSERR_INVALID_FTOL
Invalid parameter lbfgs_parameter_t::ftol specified.
LBFGSERR_INVALID_GTOL
Invalid parameter lbfgs_parameter_t::gtol specified.
LBFGSERR_INVALID_LINESEARCH
Invalid parameter lbfgs_parameter_t::linesearch specified.
LBFGSERR_INVALID_MAXLINESEARCH
Invalid parameter lbfgs_parameter_t::max_linesearch specified.
LBFGSERR_INVALID_MAXSTEP
Invalid parameter lbfgs_parameter_t::max_step specified.
LBFGSERR_INVALID_MINSTEP
Invalid parameter lbfgs_parameter_t::max_step specified.
LBFGSERR_INVALID_N
Invalid number of variables specified.
LBFGSERR_INVALID_N_SSE
Invalid number of variables (for SSE) specified.
LBFGSERR_INVALID_ORTHANTWISE
Invalid parameter lbfgs_parameter_t::orthantwise_c specified.
LBFGSERR_INVALID_ORTHANTWISE_END
Invalid parameter lbfgs_parameter_t::orthantwise_end specified.
LBFGSERR_INVALID_ORTHANTWISE_START
Invalid parameter lbfgs_parameter_t::orthantwise_start specified.
LBFGSERR_INVALID_TESTPERIOD
Invalid parameter lbfgs_parameter_t::past specified.
LBFGSERR_INVALID_WOLFE
Invalid parameter lbfgs_parameter_t::wolfe specified.
LBFGSERR_INVALID_XTOL
Invalid parameter lbfgs_parameter_t::xtol specified.
LBFGSERR_INVALID_X_SSE
The array x must be aligned to 16 (for SSE).
LBFGSERR_LOGICERROR
Logic error.
LBFGSERR_MAXIMUMITERATION
The algorithm routine reaches the maximum number of iterations.
LBFGSERR_MAXIMUMLINESEARCH
The line-search routine reaches the maximum number of evaluations.
LBFGSERR_MAXIMUMSTEP
The line-search step became larger than lbfgs_parameter_t::max_step.
LBFGSERR_MINIMUMSTEP
The line-search step became smaller than lbfgs_parameter_t::min_step.
LBFGSERR_OUTOFINTERVAL
The line-search step went out of the interval of uncertainty.
LBFGSERR_OUTOFMEMORY
Insufficient memory.
LBFGSERR_ROUNDING_ERROR
A rounding error occurred; alternatively, no line-search step satisfies the sufficient decrease and curvature conditions.
LBFGSERR_UNKNOWNERROR
Unknown error.
LBFGSERR_WIDTHTOOSMALL
Relative width of the interval of uncertainty is at most lbfgs_parameter_t::xtol.
LBFGS_ALREADY_MINIMIZED
The initial variables already minimize the objective function.
LBFGS_CONVERGENCE
L-BFGS reaches convergence.
LBFGS_FLOAT
LBFGS_IEEE_FLOAT
LBFGS_LINESEARCH_BACKTRACKING
The backtracking method with the defualt (regular Wolfe) condition.
LBFGS_LINESEARCH_BACKTRACKING_ARMIJO
Backtracking method with the Armijo condition. The backtracking method finds the step length such that it satisfies the sufficient decrease (Armijo) condition,
LBFGS_LINESEARCH_BACKTRACKING_STRONG_WOLFE
Backtracking method with strong Wolfe condition. The backtracking method finds the step length such that it satisfies both the Armijo condition (LBFGS_LINESEARCH_BACKTRACKING_ARMIJO) and the following condition,
LBFGS_LINESEARCH_BACKTRACKING_WOLFE
Backtracking method with regular Wolfe condition. The backtracking method finds the step length such that it satisfies both the Armijo condition (LBFGS_LINESEARCH_BACKTRACKING_ARMIJO) and the curvature condition,
LBFGS_LINESEARCH_DEFAULT
The default algorithm (MoreThuente method).
LBFGS_LINESEARCH_MORETHUENTE
MoreThuente method proposd by More and Thuente.
LBFGS_STOP
L-BFGS reaches convergence.
LBFGS_SUCCESS
L-BFGS reaches convergence.

Functions§

lbfgs
Start a L-BFGS optimization.
lbfgs_free
Free an array of variables.
lbfgs_malloc
Allocate an array for variables.
lbfgs_parameter_init
Initialize L-BFGS parameters to the default values.
lbfgs_strerror
Get string description of an lbfgs() return code.

Type Aliases§

_bindgen_ty_1
Return values of lbfgs().
_bindgen_ty_2
Line search algorithms.
lbfgs_evaluate_t
Callback interface to provide objective function and gradient evaluations.
lbfgs_progress_t
Callback interface to receive the progress of the optimization process.
lbfgsfloatval_t