Changeset 17577

Timestamp:

05/29/20 15:18:44 (4 years ago)

Author:

abeham

Message:

#2521: remove scope-based contexts, add helper methods to ScopeUtil, adapt operators

Location:

branches/2521_ProblemRefactoring

Files:

• HeuristicLab.Encodings.BinaryVectorEncoding/3.3/BinaryVectorProblem.cs (modified) (1 diff)
• HeuristicLab.Optimization/3.3/BasicProblems/Interfaces/ISolutionContext.cs (modified) (2 diffs)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/ScopeUtil.cs (modified) (2 diffs)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveAnalyzer.cs (modified) (1 diff)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveEvaluator.cs (modified) (1 diff)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveImprover.cs (modified) (3 diffs)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveMoveEvaluator.cs (modified) (1 diff)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveMoveGenerator.cs (modified) (2 diffs)
• HeuristicLab.Optimization/3.3/BasicProblems/Operators/SolutionContextScope.cs (deleted)
• HeuristicLab.Optimization/3.3/BasicProblems/SolutionContext.cs (modified) (3 diffs)
• HeuristicLab.Optimization/3.3/HeuristicLab.Optimization-3.3.csproj (modified) (1 diff)

branches/2521_ProblemRefactoring/HeuristicLab.Encodings.BinaryVectorEncoding/3.3/BinaryVectorProblem.cs

@@ -71 +71 @@
 
     public override void Analyze(ISingleObjectiveSolutionContext<BinaryVector>[] solutionContexts, ResultCollection results, IRandom random) {
+      base.Analyze(solutionContexts, results, random);
       var best = GetBest(solutionContexts);
       var currentBest = BestResultParameter.ActualValue;
       if (currentBest == null || IsBetter(best.EvaluationResult.Quality, currentBest.EvaluationResult.Quality))
-        BestResultParameter.ActualValue = (ISingleObjectiveSolutionContext<BinaryVector>)best.Clone();
+        BestResultParameter.ActualValue = new SingleObjectiveSolutionContext<BinaryVector>(
+          (BinaryVector)best.EncodedSolution.Clone(), (ISingleObjectiveEvaluationResult)best.EvaluationResult.Clone());
     }
 

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Interfaces/ISolutionContext.cs

@@ -20 +20 @@
 #endregion
 
+using System.Collections.Generic;
 using HEAL.Attic;
 using HeuristicLab.Core;
@@ -29 +30 @@
 
     bool IsEvaluated { get; }
+    IEnumerable<KeyValuePair<string, object>> AdditionalData { get; }
     IEncodedSolution EncodedSolution { get; }
 

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/ScopeUtil.cs

@@ -28 +28 @@
 namespace HeuristicLab.Optimization {
   public static class ScopeUtil {
+    private const string EvaluationResultName = "EvaluationResult";
 
+    // TODO: Create SolutionContexts that derive from IScope to have a unified datastructure (e.g. #1614)
     public static TEncodedSolution CopyEncodedSolutionToScope<TEncodedSolution>(IScope scope, IEncoding<TEncodedSolution> encoding, TEncodedSolution solution)
       where TEncodedSolution : class, IEncodedSolution {
@@ -63 +65 @@
     }
 
+    public static ISingleObjectiveSolutionContext<TEncodedSolution> CreateSolutionContext<TEncodedSolution>(IScope scope, IEncoding<TEncodedSolution> encoding)
+      where TEncodedSolution : class, IEncodedSolution {
+      var solution = GetEncodedSolution(scope, encoding);
+      var context = new SingleObjectiveSolutionContext<TEncodedSolution>(solution);
+      foreach (var variable in scope.Variables) {
+        if (variable.Name != encoding.Name)
+          context.SetAdditionalData(variable.Name, variable.Value);
+      }
+      if (scope.Variables.TryGetValue(EvaluationResultName, out var variable2)) {
+        context.EvaluationResult = (ISingleObjectiveEvaluationResult)variable2.Value;
+      }
+      return context;
+    }
+
+    public static void CopyToScope<TEncodedSolution>(IScope scope, ISingleObjectiveSolutionContext<TEncodedSolution> solutionContext)
+      where TEncodedSolution : class, IEncodedSolution {
+      foreach (var item in solutionContext.AdditionalData) {
+        if (item.Value is IItem i) {
+          if (!scope.Variables.TryGetValue(item.Key, out var variable))
+            scope.Variables.Add(new Variable(item.Key, i));
+          else variable.Value = i;
+        }
+      }
+      if (!scope.Variables.TryGetValue(EvaluationResultName, out var variable2)) {
+        scope.Variables.Add(new Variable(EvaluationResultName, solutionContext.EvaluationResult));
+      } else variable2.Value = solutionContext.EvaluationResult;
+    }
   }
 }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveAnalyzer.cs

@@ -79 +79 @@
 
       var solutionContexts = scopes.Select(scope => {
-        var solution = ScopeUtil.GetEncodedSolution(scope, encoding);
-        var quality = ((DoubleValue)scope.Variables[QualityParameter.ActualName].Value).Value;
-        var solutionContext = new SingleObjectiveSolutionContextScope<TEncodedSolution>(scope, solution);
-        return solutionContext;
+        return ScopeUtil.CreateSolutionContext(scope, encoding);
       }).ToArray();
 
       Analyze(solutionContexts, results, random);
+      foreach (var s in solutionContexts.Zip(scopes, Tuple.Create)) {
+        ScopeUtil.CopyToScope(s.Item2, s.Item1);
+      }
       return base.Apply();
     }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveEvaluator.cs

@@ -63 +63 @@
       var random = RandomParameter.ActualValue;
       var encoding = EncodingParameter.ActualValue;
-      var solution = ScopeUtil.GetEncodedSolution(ExecutionContext.Scope, encoding);
-      var solutionContext = new SingleObjectiveSolutionContextScope<TEncodedSolution>(ExecutionContext.Scope, solution);
+      var solutionContext = ScopeUtil.CreateSolutionContext(ExecutionContext.Scope, encoding);
 
       Evaluate(solutionContext, random, CancellationToken.None);
-      var qualityValue = solutionContext.EvaluationResult.Quality;
+      
+      QualityParameter.ActualValue = new DoubleValue(solutionContext.EvaluationResult.Quality);
+      ScopeUtil.CopyToScope(ExecutionContext.Scope, solutionContext);
 
-      QualityParameter.ActualValue = new DoubleValue(qualityValue);
       return base.InstrumentedApply();
     }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveImprover.cs

@@ -90 +90 @@
       var maxAttempts = ImprovementAttemptsParameter.ActualValue.Value;
       var sampleSize = SampleSizeParameter.ActualValue.Value;
-      var solution = ScopeUtil.GetEncodedSolution(ExecutionContext.Scope, encoding);
-      var solutionContext = new SingleObjectiveSolutionContextScope<TEncodedSolution>(ExecutionContext.Scope, solution);
+      var solutionContext = ScopeUtil.CreateSolutionContext(ExecutionContext.Scope, encoding);
 
       double quality;
@@ -102 +101 @@
       var count = 0;
       for (var i = 0; i < maxAttempts; i++) {
-        TEncodedSolution best = default(TEncodedSolution);
+        ISingleObjectiveSolutionContext<TEncodedSolution> best = default;
         var bestQuality = quality;
         foreach (var neighbor in GetNeighbors(solutionContext, random).Take(sampleSize)) {
-          Evaluate(neighbor, random, CancellationToken);
+          if (!neighbor.IsEvaluated)
+            Evaluate(neighbor, random, CancellationToken);
           var q = neighbor.EvaluationResult.Quality;
           count++;
           if (maximize && bestQuality > q || !maximize && bestQuality < q) continue;
-          best = neighbor.EncodedSolution;
+          best = neighbor;
           bestQuality = q;
         }
         if (best == null) break;
-        solution = best;
+        solutionContext = best;
         quality = bestQuality;
       }
@@ -119 +119 @@
       LocalEvaluatedSolutionsParameter.ActualValue = new IntValue(count);
       QualityParameter.ActualValue = new DoubleValue(quality);
-
-      ScopeUtil.CopyEncodedSolutionToScope(ExecutionContext.Scope, encoding, solution);
+      ScopeUtil.CopyEncodedSolutionToScope(ExecutionContext.Scope, encoding, solutionContext.EncodedSolution);
+      ScopeUtil.CopyToScope(ExecutionContext.Scope, solutionContext);
       return base.Apply();
     }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveMoveEvaluator.cs

@@ -70 +70 @@
       var random = RandomParameter.ActualValue;
       var encoding = EncodingParameter.ActualValue;
-      var solution = ScopeUtil.GetEncodedSolution(ExecutionContext.Scope, encoding);
-      var solutionContext = new SingleObjectiveSolutionContextScope<TEncodedSolution>(ExecutionContext.Scope, solution);
+      var solutionContext = ScopeUtil.CreateSolutionContext(ExecutionContext.Scope, encoding);
 
-      Evaluate(solutionContext, random, CancellationToken.None);
+      if (!solutionContext.IsEvaluated)
+        Evaluate(solutionContext, random, CancellationToken.None);
       var qualityValue = solutionContext.EvaluationResult.Quality;
 
       MoveQualityParameter.ActualValue = new DoubleValue(qualityValue);
+      ScopeUtil.CopyToScope(ExecutionContext.Scope, solutionContext);
       return base.Apply();
     }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Operators/SingleObjectiveMoveGenerator.cs

@@ -68 +68 @@
       var sampleSize = SampleSizeParameter.ActualValue.Value;
       var encoding = EncodingParameter.ActualValue;
-      var solution = ScopeUtil.GetEncodedSolution(ExecutionContext.Scope, encoding);
-      var solutionContext = new SingleObjectiveSolutionContextScope<TEncodedSolution>(ExecutionContext.Scope, solution);
+      var solutionContext = ScopeUtil.CreateSolutionContext(ExecutionContext.Scope, encoding);
 
       var nbhood = GetNeighbors(solutionContext, random).Take(sampleSize).ToList();
@@ -76 +75 @@
         moveScopes[i] = new Scope(i.ToString(CultureInfo.InvariantCulture.NumberFormat));
         ScopeUtil.CopyEncodedSolutionToScope(moveScopes[i], encoding, nbhood[i].EncodedSolution);
+        ScopeUtil.CopyToScope(moveScopes[i], nbhood[i]);
       }
       ExecutionContext.Scope.SubScopes.AddRange(moveScopes);

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/SolutionContext.cs

@@ -35 +35 @@
     [Storable]
     private readonly Dictionary<string, object> data = new Dictionary<string, object>();
+    public IEnumerable<KeyValuePair<string, object>> AdditionalData { get { return data; } }
 
     IEncodedSolution ISolutionContext.EncodedSolution { get { return EncodedSolution; } }
@@ -77 +78 @@
   public class SingleObjectiveSolutionContext<TEncodedSolution> : SolutionContext<TEncodedSolution>, ISingleObjectiveSolutionContext<TEncodedSolution>
    where TEncodedSolution : class, IEncodedSolution {
-    public new ISingleObjectiveEvaluationResult EvaluationResult { get; set; }
+    public new ISingleObjectiveEvaluationResult EvaluationResult {
+      get { return (ISingleObjectiveEvaluationResult)base.EvaluationResult; }
+      set { base.EvaluationResult = value; }
+    }
 
     public SingleObjectiveSolutionContext(TEncodedSolution encodedSolution) : base(encodedSolution) { }
@@ -98 +102 @@
   public class MultiObjectiveSolutionContext<TEncodedSolution> : SolutionContext<TEncodedSolution>, IMultiObjectiveSolutionContext<TEncodedSolution>
    where TEncodedSolution : class, IEncodedSolution {
-    public new IMultiObjectiveEvaluationResult EvaluationResult { get; set; }
+    public new IMultiObjectiveEvaluationResult EvaluationResult {
+      get { return (IMultiObjectiveEvaluationResult)base.EvaluationResult; }
+      set { base.EvaluationResult = value; }
+    }
 
     public MultiObjectiveSolutionContext(TEncodedSolution encodedSolution) : base(encodedSolution) { }

branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/HeuristicLab.Optimization-3.3.csproj

@@ -134 +134 @@
     <Compile Include="BasicProblems\Operators\MultiEncodingManipulator.cs" />
     <Compile Include="BasicProblems\Operators\MultiEncodingOperator.cs" />
-    <Compile Include="BasicProblems\Operators\SolutionContextScope.cs" />
     <Compile Include="BasicProblems\Problem.cs" />
     <Compile Include="BasicProblems\Encoding.cs" />