package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-10-15 19:50:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

optimize: Update documentation for Global and clean up usage of globa… (#265)

Browse Source 
* optimize: Update documentation for Global and clean up usage of globalStatus
This commit is contained in:
Brendan Tracey
2017-10-17 09:15:41 -06:00
committed by GitHub
parent aff0e10c44
commit 38fbc22caf
3 changed files with 168 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
optimize/minimize.go
View File

@@ -121,8 +121,8 @@ func checkConvergence(loc *Location, settings *Settings, local bool) Status {
return NotTerminated
}
// updateStats updates the statistics based on the operation.
func updateStats(stats *Stats, op Operation) {
// updateEvaluationStats updates the statistics based on the operation.
func updateEvaluationStats(stats *Stats, op Operation) {
if op&FuncEvaluation != 0 {
stats.FuncEvaluations++
}
@@ -169,8 +169,9 @@ func checkLimits(loc *Location, stats *Stats, settings *Settings) Status {
return NotTerminated
}
// TODO(btracey): better name
func iterCleanup(status Status, err error, stats *Stats, settings *Settings, statuser Statuser, startTime time.Time, loc *Location, op Operation) (Status, error) {
// finishIteration performs cleanup tasks at the end of an optimization iteration.
// It checks the status, sends information to recorders, and updates the runtime.
func finishIteration(status Status, err error, stats *Stats, settings *Settings, statuser Statuser, startTime time.Time, loc *Location, op Operation) (Status, error) {
if status != NotTerminated || err != nil {
return status, err
}