Changeset 14517

Timestamp:

12/22/16 10:07:46 (7 years ago)

Author:

jkarder

Message:

#2524: made BasicAlgorithm pausable

Location:

trunk/sources

Files:

• HeuristicLab.Algorithms.ParameterlessPopulationPyramid/3.3/HillClimber.cs (modified) (4 diffs)
• HeuristicLab.Algorithms.ParameterlessPopulationPyramid/3.3/ParameterlessPopulationPyramid.cs (modified) (4 diffs)
• HeuristicLab.Optimization.Views/3.3/BasicAlgorithmView.cs (modified) (1 diff)
• HeuristicLab.Optimization/3.3/Algorithms/BasicAlgorithm.cs (modified) (9 diffs)

trunk/sources/HeuristicLab.Algorithms.ParameterlessPopulationPyramid/3.3/HillClimber.cs

@@ -48 +48 @@
 
     private const string IterationsParameterName = "Iterations";
+    private const string BestQualityResultName = "Best quality";
+    private const string IterationsResultName = "Iterations";
 
     public override Type ProblemType {
@@ -66 +68 @@
     }
 
+    #region ResultsProperties
+    private double ResultsBestQuality {
+      get { return ((DoubleValue)Results[BestQualityResultName].Value).Value; }
+      set { ((DoubleValue)Results[BestQualityResultName].Value).Value = value; }
+    }
+    private int ResultsIterations {
+      get { return ((IntValue)Results[IterationsResultName].Value).Value; }
+      set { ((IntValue)Results[IterationsResultName].Value).Value = value; }
+    }
+    #endregion
+
     [StorableConstructor]
     protected HillClimber(bool deserializing) : base(deserializing) { }
@@ -77 +90 @@
     public HillClimber()
       : base() {
+      pausable = true;
       random = new MersenneTwister();
       Parameters.Add(new FixedValueParameter<IntValue>(IterationsParameterName, "", new IntValue(100)));
     }
+
+    [StorableHook(HookType.AfterDeserialization)]
+    private void AfterDeserialization() {
+      // BackwardsCompatibility3.3
+      #region Backwards compatible code, remove with 3.4
+      pausable = true;
+      #endregion
+    }
+
+    protected override void Initialize(CancellationToken cancellationToken) {
+      Results.Add(new Result(BestQualityResultName, new DoubleValue(double.NaN)));
+      Results.Add(new Result(IterationsResultName, new IntValue(0)));
+      base.Initialize(cancellationToken);
+    }
     protected override void Run(CancellationToken cancellationToken) {
-      var BestQuality = new DoubleValue(double.NaN);
-      Results.Add(new Result("Best quality", BestQuality));
-      for (int iteration = 0; iteration < Iterations; iteration++) {
+      while (ResultsIterations < Iterations) {
+        cancellationToken.ThrowIfCancellationRequested();
+
         var solution = new BinaryVector(Problem.Length);
         for (int i = 0; i < solution.Length; i++) {
@@ -92 +120 @@
 
         fitness = ImproveToLocalOptimum(Problem, solution, fitness, random);
-        if (double.IsNaN(BestQuality.Value) || Problem.IsBetter(fitness, BestQuality.Value)) {
-          BestQuality.Value = fitness;
+        if (double.IsNaN(ResultsBestQuality) || Problem.IsBetter(fitness, ResultsBestQuality)) {
+          ResultsBestQuality = fitness;
         }
+
+        ResultsIterations++;
       }
     }

trunk/sources/HeuristicLab.Algorithms.ParameterlessPopulationPyramid/3.3/ParameterlessPopulationPyramid.cs

@@ -165 +165 @@
 
     public ParameterlessPopulationPyramid() {
+      pausable = true;
       Parameters.Add(new FixedValueParameter<IntValue>(MaximumIterationsParameterName, "", new IntValue(Int32.MaxValue)));
       Parameters.Add(new FixedValueParameter<IntValue>(MaximumEvaluationsParameterName, "", new IntValue(Int32.MaxValue)));
@@ -170 +171 @@
       Parameters.Add(new FixedValueParameter<IntValue>(SeedParameterName, "The random seed used to initialize the new pseudo random number generator.", new IntValue(0)));
       Parameters.Add(new FixedValueParameter<BoolValue>(SetSeedRandomlyParameterName, "True if the random seed should be set to a random value, otherwise false.", new BoolValue(true)));
+    }
+
+    [StorableHook(HookType.AfterDeserialization)]
+    private void AfterDeserialization() {
+      // BackwardsCompatibility3.3
+      #region Backwards compatible code, remove with 3.4
+      pausable = true;
+      #endregion
     }
 
@@ -213 +222 @@
     }
 
-    protected override void Run(CancellationToken cancellationToken) {
+    protected override void Initialize(CancellationToken cancellationToken) {
       // Set up the algorithm
       if (SetSeedRandomly) Seed = new System.Random().Next();
@@ -242 +251 @@
       Results.Add(new Result("Stored Solutions", table));
 
+      base.Initialize(cancellationToken);
+    }
+
+    protected override void Run(CancellationToken cancellationToken) {
       // Loop until iteration limit reached or canceled.
-      for (ResultsIterations = 0; ResultsIterations < MaximumIterations; ResultsIterations++) {
-        double fitness = double.NaN;
-
-        try {
-          fitness = iterate();
-          cancellationToken.ThrowIfCancellationRequested();
-        } finally {
-          ResultsEvaluations = tracker.Evaluations;
-          ResultsBestSolution = new BinaryVector(tracker.BestSolution);
-          ResultsBestQuality = tracker.BestQuality;
-          ResultsBestFoundOnEvaluation = tracker.BestFoundOnEvaluation;
-          ResultsQualitiesBest.Values.Add(tracker.BestQuality);
-          ResultsQualitiesIteration.Values.Add(fitness);
-          ResultsLevels.Values.Add(pyramid.Count);
-          ResultsSolutions.Values.Add(seen.Count);
-        }
+      while (ResultsIterations < MaximumIterations) {
+        cancellationToken.ThrowIfCancellationRequested();
+        double fitness = iterate();
+
+        ResultsEvaluations = tracker.Evaluations;
+        ResultsBestSolution = new BinaryVector(tracker.BestSolution);
+        ResultsBestQuality = tracker.BestQuality;
+        ResultsBestFoundOnEvaluation = tracker.BestFoundOnEvaluation;
+        ResultsQualitiesBest.Values.Add(tracker.BestQuality);
+        ResultsQualitiesIteration.Values.Add(fitness);
+        ResultsLevels.Values.Add(pyramid.Count);
+        ResultsSolutions.Values.Add(seen.Count);
+
+        ResultsIterations++;
       }
     }

trunk/sources/HeuristicLab.Optimization.Views/3.3/BasicAlgorithmView.cs

@@ -36 +36 @@
     protected override void SetEnabledStateOfControls() {
       base.SetEnabledStateOfControls();
-      pauseButton.Enabled = false;
+      pauseButton.Enabled &= Content != null && Content.Pausable;
     }
 
     protected override void SetEnabledStateOfExecutableButtons() {
       base.SetEnabledStateOfExecutableButtons();
-      pauseButton.Enabled = false;
+      pauseButton.Enabled &= Content != null && Content.Pausable;
     }
   }

trunk/sources/HeuristicLab.Optimization/3.3/Algorithms/BasicAlgorithm.cs

@@ -24 +24 @@
 using System.Threading.Tasks;
 using HeuristicLab.Common;
+using HeuristicLab.Core;
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
@@ -29 +30 @@
   [StorableClass]
   public abstract class BasicAlgorithm : Algorithm, IStorableContent {
+    private bool initialized;
+    private bool pausePending;
+    private DateTime lastUpdateTime;
+    protected bool pausable;
+
     public string Filename { get; set; }
+    public bool Pausable { get { return pausable; } }
 
     [Storable]
@@ -47 +54 @@
     protected BasicAlgorithm(BasicAlgorithm original, Cloner cloner)
       : base(original, cloner) {
+      pausable = original.pausable;
       results = cloner.Clone(original.Results);
     }
@@ -58 +66 @@
       base.Prepare();
       results.Clear();
+      initialized = false;
       OnPrepared();
     }
@@ -64 +73 @@
       base.Start();
       CancellationTokenSource = new CancellationTokenSource();
-
+      pausePending = false;
       OnStarted();
       Task task = Task.Factory.StartNew(Run, cancellationTokenSource.Token, cancellationTokenSource.Token);
@@ -80 +89 @@
         CancellationTokenSource.Dispose();
         CancellationTokenSource = null;
-        OnStopped();
+        if (pausePending) OnPaused();
+        else OnStopped();
       });
     }
 
     public override void Pause() {
-      throw new NotSupportedException("Pause is not supported in basic algorithms.");
+      if (!Pausable)
+        throw new NotSupportedException("Pause is not supported by this algorithm.");
+
+      base.Pause();
+      pausePending = true;
+      cancellationTokenSource.Cancel();
     }
 
@@ -92 +107 @@
       // alternatively check the IsCancellationRequested property of the cancellation token
       base.Stop();
-      CancellationTokenSource.Cancel();
+      if (ExecutionState == ExecutionState.Paused) OnStopped();
+      else CancellationTokenSource.Cancel();
     }
 
-
-    private DateTime lastUpdateTime;
     private void Run(object state) {
       CancellationToken cancellationToken = (CancellationToken)state;
@@ -105 +119 @@
       timer.Start();
       try {
+        if (!initialized)
+          Initialize(cancellationToken);
+        initialized = true;
         Run(cancellationToken);
       } finally {
@@ -113 +130 @@
     }
 
+    protected virtual void Initialize(CancellationToken cancellationToken) { }
     protected abstract void Run(CancellationToken cancellationToken);