Merge pull request #50 from valeriyvan/fix/comment

Add comment
valeriyvan · Oct 2, 2023 · b890adb · b890adb
2 parents fd36829 + 9c68980
commit b890adb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Sources/geometrize/GeometrizeModelHillClimb.swift b/Sources/geometrize/GeometrizeModelHillClimb.swift
@@ -3,6 +3,10 @@ import Foundation
 /// The model class is the model for the core optimization/fitting algorithm.
 class GeometrizeModelHillClimb: GeometrizeModelBase {
 
+    // Runs concurrently maxThreads optimization sessions and returns array of optimization results.
+    // step function then takes the only result with the best score.
+    // Therefore it does make sense decrease shapeCount proportionally when increasing maxThreads
+    // to achieve same effectiveness.
     private func getHillClimbState( // swiftlint:disable:this function_parameter_count
         shapeCreator: () -> any Shape,
         alpha: UInt8,