source: addons/HeuristicLab.Problems.BioBoost/HeuristicLab.Problems.BioBoost/3.3/Analysis/BestBioBoostSolutionAnalyzer.cs @ 17777

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System.Collections.Generic;
using HeuristicLab.BioBoost.ProblemDescription;
using HeuristicLab.BioBoost.Representation;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using System.Linq;
using HEAL.Attic;

namespace HeuristicLab.BioBoost.Analysis {

  [Item("BestBioBoostSolutionAnalyzer", "An operator for analyzing the best bioboost solution.")]
  [StorableType("B6E57285-A990-4675-9BD2-C3D61DF46E96")]
  public class BestBioBoostSolutionAnalyzer : SingleSuccessorOperator, IAnalyzer {

    public bool EnabledByDefault { get { return true; } }

    #region Parameters
    public LookupParameter<BoolValue> MaximizationParameter {
      get { return (LookupParameter<BoolValue>) Parameters["Maximization"]; }
    }
    public ScopeTreeLookupParameter<DoubleValue> TotalCostParameter {
      get { return (ScopeTreeLookupParameter<DoubleValue>) Parameters["TotalCost"]; }
    } 
    public LookupParameter<BioBoostProblemData> ProblemDataParameter {
      get { return (LookupParameter<BioBoostProblemData>) Parameters["ProblemData"]; }
    }
    public LookupParameter<BioBoostCompoundSolution> BestSolutionParameter {
      get { return (LookupParameter<BioBoostCompoundSolution>) Parameters["BestSolution"]; }
    }
    public ValueLookupParameter<ResultCollection> ResultsParameter {
      get { return (ValueLookupParameter<ResultCollection>)Parameters["Results"]; }
    }
    public LookupParameter<DoubleValue> BestKnownQualityParameter {
      get { return (LookupParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
    }
    public LookupParameter<DoubleValue> BestQualityParameter {
      get { return (LookupParameter<DoubleValue>)Parameters["BestQuality"]; }
    }
    public LookupParameter<BioBoostCompoundSolution> BestKnownSolutionParameter {
      get { return (LookupParameter<BioBoostCompoundSolution>)Parameters["BestKnownSolution"]; }
    }
    public LookupParameter<ItemCollection<BioBoostCompoundSolution>> SolutionHistoryParameter {
      get { return (LookupParameter<ItemCollection<BioBoostCompoundSolution>>)Parameters["SolutionHistory"]; }
    }
    public ValueLookupParameter<BoolValue> TrackHistoryParameter {
      get { return (ValueLookupParameter<BoolValue>) Parameters["TrackHistory"]; }
    }
    #endregion

    #region Parameter Values
    public bool Maximization {
      get { return MaximizationParameter.ActualValue.Value;  }
    }
    public BioBoostProblemData ProblemData {
      get { return ProblemDataParameter.ActualValue; }
    }
    public BioBoostCompoundSolution BestSolution {
      get { return BestSolutionParameter.ActualValue; }
      set { BestSolutionParameter.ActualValue = value; }
    }
    private bool TrackHistory { get { return TrackHistoryParameter.ActualValue.Value;  } }
    #endregion

    #region Construction & Cloning
    [StorableConstructor]
    protected BestBioBoostSolutionAnalyzer(StorableConstructorFlag _) : base(_) { }
    protected BestBioBoostSolutionAnalyzer(BestBioBoostSolutionAnalyzer orig, Cloner cloner) : base(orig, cloner) {}
    public BestBioBoostSolutionAnalyzer() {
      Parameters.Add(new LookupParameter<BoolValue>("Maximization", "Whether this is a maximization problem."));
      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("TotalCost", "The total cost of the whole scenario."));
      Parameters.Add(new LookupParameter<BioBoostProblemData>("ProblemData", "The collection of problem data."));
      Parameters.Add(new LookupParameter<BioBoostCompoundSolution>("BestSolution", "Aggregation of solution components."));
      Parameters.Add(new ValueLookupParameter<ResultCollection>("Results", "The result collection where the best solution should be stored."));
      Parameters.Add(new LookupParameter<DoubleValue>("BestKnownQuality", "The quality of the best known solution of this instance."));
      Parameters.Add(new LookupParameter<DoubleValue>("BestQuality", "The quality of the best solution of this run."));
      Parameters.Add(new LookupParameter<BioBoostCompoundSolution>("BestKnownSolution", "The best known solution of this instance."));
      Parameters.Add(new LookupParameter<ItemCollection<BioBoostCompoundSolution>>("SolutionHistory", "The history of best solutions over time."));
      Parameters.Add(new ValueLookupParameter<BoolValue>("TrackHistory", "True if all best solutions (over time) should be recorded in SolutionHistory", new BoolValue(false)));
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new BestBioBoostSolutionAnalyzer(this, cloner);
    }

    [StorableHook(HookType.AfterDeserialization)]
    public void AfterDeserialization() {
      if (!Parameters.ContainsKey("Maximization"))
        Parameters.Add(new LookupParameter<BoolValue>("Maximization", "Whether this is a maximization problem."));
      if (!Parameters.ContainsKey("SolutionHistory"))
        Parameters.Add(new LookupParameter<ItemCollection<BioBoostCompoundSolution>>("SolutionHistory", "The history of best solutions over time."));
      if (!Parameters.ContainsKey("TrackHistory"))
        Parameters.Add(new ValueLookupParameter<BoolValue>("TrackHistory", "True if all best solutions (over time) should be recorded in SolutionHistory", new BoolValue(false)));
      if (!Parameters.ContainsKey("BestQuality"))
        Parameters.Add(new LookupParameter<DoubleValue>("BestQuality", "The quality of the best solution of this run."));
    }
    #endregion

    IEnumerable<IScope> GetSubScopes(IScope scope, int depth) {
      if (depth == 1)
        return scope.SubScopes;
      return scope.SubScopes.Select(s => GetSubScopes(s, depth - 1)).Aggregate((l1, l2) => l1.Concat(l2));
    }

    public override IOperation Apply() {
      var costs = TotalCostParameter.ActualValue.Select((cost, idx) => new {cost.Value, idx}).OrderBy(p => p.Value);
      var best = Maximization ? costs.Last() : costs.First();
      var bestScope = TotalCostParameter.Depth == 0 ? ExecutionContext.Scope : GetSubScopes(ExecutionContext.Scope, TotalCostParameter.Depth).ToList()[best.idx];
      var newBestSolution = new BioBoostCompoundSolution(bestScope, ProblemData);
      if (BestSolution == null) {
        BestSolution = newBestSolution;
        ResultsParameter.ActualValue.Add(new Result("BestSolution", BestSolution));
      } else {
        BestSolution.UpdateTo(newBestSolution);
      }
      if (BestKnownQualityParameter.ActualValue == null ||
          Maximization && best.Value > BestKnownQualityParameter.ActualValue.Value ||
          !Maximization && best.Value < BestKnownQualityParameter.ActualValue.Value) {
        BestKnownQualityParameter.ActualValue = new DoubleValue(best.Value);
        BestKnownSolutionParameter.ActualValue = BestSolution;
      }
      if (TrackHistory &&
          (BestQualityParameter.ActualValue == null ||
           Maximization && best.Value > BestQualityParameter.ActualValue.Value ||
           !Maximization && best.Value < BestQualityParameter.ActualValue.Value)) {
        IResult solutionHistoryResult = null;
        if (!ResultsParameter.ActualValue.TryGetValue("SolutionHistory", out solutionHistoryResult)) {
          solutionHistoryResult = new Result("SolutionHistory", new ItemCollection<BioBoostCompoundSolution>());
          ResultsParameter.ActualValue.Add(solutionHistoryResult);
        }
        ((ItemCollection<BioBoostCompoundSolution>) solutionHistoryResult.Value).Add(
          (BioBoostCompoundSolution) newBestSolution.SlimClone());
      }
      return base.Apply();
    }

  }
}