Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that non-zero return value of a callback is used as return value of lbfgs() #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions include/lbfgs.h
Original file line number Diff line number Diff line change
Expand Up @@ -400,8 +400,9 @@ typedef lbfgsfloatval_t (*lbfgs_evaluate_t)(
* @param n The number of variables.
* @param k The iteration count.
* @param ls The number of evaluations called for this iteration.
* @retval int Zero to continue the optimization process. Returning a
* non-zero value will cancel the optimization process.
* @retval int Zero (#LBFGS_SUCCESS) to continue the optimization process.
* Returning a non-zero value will cancel the optimization
* process and lbfgs() returns the value as its return value.
*/
typedef int (*lbfgs_progress_t)(
void *instance,
Expand Down