Rename FunctionGradientEvals in Settings and Stats to FuncGradEvaluations

Author: vladimir-ch

local.go

@@ -273,14 +273,14 @@ func checkConvergence(loc *Location, iterType IterationType, stats *Stats, setti
 	}
 
 	if settings.FuncEvaluations > 0 {
-		totalFun := stats.FuncEvaluations + stats.FunctionGradientEvals
+		totalFun := stats.FuncEvaluations + stats.FuncGradEvaluations
 		if totalFun >= settings.FuncEvaluations {
 			return FunctionEvaluationLimit
 		}
 	}
 
 	if settings.GradEvaluations > 0 {
-		totalGrad := stats.GradEvaluations + stats.FunctionGradientEvals
+		totalGrad := stats.GradEvaluations + stats.FuncGradEvaluations
 		if totalGrad >= settings.GradEvaluations {
 			return GradientEvaluationLimit
 		}
@@ -334,13 +334,13 @@ func evaluate(funcInfo *functionInfo, evalType EvaluationType, xNext []float64,
 		}
 		if funcInfo.IsFunctionGradient {
 			loc.F = funcInfo.functionGradient.FuncGrad(loc.X, loc.Gradient)
-			stats.FunctionGradientEvals++
+			stats.FuncGradEvaluations++
 			return
 		}
 	case FuncGradEvaluation:
 		if funcInfo.IsFunctionGradient {
 			loc.F = funcInfo.functionGradient.FuncGrad(loc.X, loc.Gradient)
-			stats.FunctionGradientEvals++
+			stats.FuncGradEvaluations++
 			return
 		}
 		if funcInfo.IsGradient {

printer.go

@@ -71,7 +71,7 @@ func (p *Printer) Record(loc *Location, _ EvaluationType, iter IterationType, st
 	// Make the value strings
 	var valueStrings [nPrinterOut]string
 	valueStrings[0] = strconv.Itoa(stats.MajorIterations)
-	valueStrings[1] = strconv.Itoa(stats.FuncEvaluations + stats.FunctionGradientEvals)
+	valueStrings[1] = strconv.Itoa(stats.FuncEvaluations + stats.FuncGradEvaluations)
 	valueStrings[2] = fmt.Sprintf("%g", loc.F)
 	if p.printGrad {
 		norm := floats.Norm(loc.Gradient, math.Inf(1))

types.go

@@ -89,11 +89,11 @@ type Result struct {
 
 // Stats contains the statistics of the run.
 type Stats struct {
-	MajorIterations       int           // Total number of major iterations
-	FuncEvaluations       int           // Number of evaluations of Func()
-	GradEvaluations       int           // Number of evaluations of Grad()
-	FunctionGradientEvals int           // Number of evaluations of FuncGrad()
-	Runtime               time.Duration // Total runtime of the optimization
+	MajorIterations     int           // Total number of major iterations
+	FuncEvaluations     int           // Number of evaluations of Func()
+	GradEvaluations     int           // Number of evaluations of Grad()
+	FuncGradEvaluations int           // Number of evaluations of FuncGrad()
+	Runtime             time.Duration // Total runtime of the optimization
 }
 
 // FunctionInfo is data to give to the optimizer about the objective function.

unconstrained_test.go

@@ -738,7 +738,7 @@ func testLocal(t *testing.T, tests []unconstrainedTest, method Method) {
 		// Check that providing initial data reduces the number of function
 		// and/or gradient calls exactly by one.
 		if funcInfo.IsFunctionGradient {
-			if result.FunctionGradientEvals != result2.FunctionGradientEvals+1 {
+			if result.FuncGradEvaluations != result2.FuncGradEvaluations+1 {
 				t.Errorf("Providing initial data does not reduce the number of function/gradient calls for:\n%v", test)
 				continue
 			}