Fix callback return values and clarify docs #383
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a sibling PR to #382 and part of fixing #377.
I went through and audited the code to find places where the return values of callback functions were being ignored. I modified optimizers as necessary to handle those return values, attempting to terminate optimization before any more steps were taken.
I also modified the documentation to clarify that
bool
s should be returned. However, forBeginOptimization()
andEndOptimization()
returning abool
doesn't make sense---so I made those returnvoid
.In a couple places there were various other cleanups that I did, but nothing that affected functionality in any real way unrelated to callbacks.
Once this is done/merged, I also plan to update the technical report's section on callbacks and re-upload to arXiv.