source: branches/HeuristicLab.Problems.BioBoost/HeuristicLab.Problems.BioBoost/3.3/Evaluators/AggregateEvaluator.cs @ 15469

#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.Threading;
using HeuristicLab.BioBoost.ProblemDescription;
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.Collections.Generic;

namespace HeuristicLab.BioBoost.Evaluators {
  [StorableClass]
  public class AggregateEvaluator : AlgorithmOperator, IBioBoostSimulationEvaluator {

    #region ISingleObjectiveEvaluator Members
    public ILookupParameter<DoubleValue> QualityParameter { get { return TotalCostParameter; } }
    #endregion

    #region IMultiObjectEvaluator Members
    public ILookupParameter<DoubleArray> QualitiesParameter { get { return (ILookupParameter<DoubleArray>) Parameters["QualityCriteria"]; } }
    #endregion

    #region Parameters
    public ILookupParameter<ResultCollection> CostsParameter {
      get { return (ILookupParameter<ResultCollection>)Parameters["Costs"]; }
    }
    public ILookupParameter<ResultCollection> IntermediateResultsParameter {
      get { return (ILookupParameter<ResultCollection>)Parameters["IntermediateResults"]; }
    }
    public LookupParameter<BioBoostProblemData> ProblemDataParameter {
      get { return (LookupParameter<BioBoostProblemData>)Parameters["ProblemData"]; }
    }
    public LookupParameter<DoubleValue> TotalCostParameter {
      get { return (LookupParameter<DoubleValue>)Parameters["TotalCost"]; }
    }
    public LookupParameter<BoolValue> RemoveIntermediateResultsParameter {
      get { return (LookupParameter<BoolValue>)Parameters["RemoveIntermediateResults"]; }
    }
    #endregion

    #region Parameter Values
    public ResultCollection Costs {
      get { return CostsParameter.ActualValue; }
    }
    public ResultCollection IntermediateResults {
      get { return IntermediateResultsParameter.ActualValue; }
    }
    public BioBoostProblemData ProblemData {
      get { return ProblemDataParameter.ActualValue; }
      set { ProblemDataParameter.ActualValue = value; }
    }
    public bool RemoveIntermediateResults {
      get { return RemoveIntermediateResultsParameter.ActualValue.Value; }
      set { RemoveIntermediateResultsParameter.ActualValue = new BoolValue(value); }
    }
    #endregion

    #region Construction & Cloning
    [StorableConstructor]
    protected AggregateEvaluator(bool isDeserializing) : base(isDeserializing) { }
    protected AggregateEvaluator(AggregateEvaluator orig, Cloner cloner) : base(orig, cloner) { }
    public AggregateEvaluator() {
      Parameters.Add(new LookupParameter<ResultCollection>("Costs", "Collection of all costs"));
      Parameters.Add(new LookupParameter<ResultCollection>("IntermediateResults", "Collection of all intermediate results."));
      Parameters.Add(new LookupParameter<DoubleValue>("TotalCost", "Total cost of all aggregation steps."));
      Parameters.Add(new LookupParameter<BioBoostProblemData>("ProblemData", "The encapsulated problem instance."));
      Parameters.Add(new LookupParameter<BoolValue>("RemoveIntermediateResults", "Whether to remove intermediate results created during evaluation."));
      Parameters.Add(new LookupParameter<DoubleArray>("QualityCriteria", "The list of quality criteria used for multi-objecjtive optimization."));
      SetOperatorChain(new SingleSuccessorOperator[] {
        new InitializationEvaluator(),
        new FeedstockCostEvaluator(),
        new LogisticCostEvaluator(),
        new ConversionCostEvaluator(),
        new LogisticCostEvaluator(),
        new ConversionCostEvaluator(),
        new SinkEvaluator(),
        new ConcludingEvaluator()
      });
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new AggregateEvaluator(this, cloner);
    }

    [StorableHook(HookType.AfterDeserialization)]
    void AfterDeserialization() {
      if (!Parameters.ContainsKey("QualityCriteria"))
        Parameters.Add(new LookupParameter<DoubleArray>("QualityCriteria", "The list of quality criteria used for multi-objecjtive optimization."));
    }
    #endregion

    protected void SetOperatorChain(IEnumerable<SingleSuccessorOperator> operators) {
      OperatorGraph.InitialOperator = null;
      OperatorGraph.Operators.Clear();
      SingleSuccessorOperator lastOp = null;
      foreach (var op in operators) {
        if (lastOp == null) {
          OperatorGraph.InitialOperator = op;
        } else {
          lastOp.Successor = op;
        }
        lastOp = op;
      }
    }

    protected bool InitializeCostsAndIntermediateResults = true;
    public override IOperation Apply() {
      if (InitializeCostsAndIntermediateResults) {
        CostsParameter.ActualValue = new ResultCollection();
        IntermediateResultsParameter.ActualValue = new ResultCollection();
      }
      return base.Apply();
    }

    // evaluates a solution for a bioboost problem specified by the utlizations and transport targets 
    // and returns the resulting scope after complete evaluation
    // this is called by the BioBoostCompoundSolution to update all solution information after a change
    public static Scope Evaluate(BioBoostProblemData problemData,
      IEnumerable<KeyValuePair<string, DoubleArray>> utilizations,
      IEnumerable<KeyValuePair<string, IntArray>> transportTargets) {
      // prepare scope structure
      // (necessary because InitializationEvaluator clears the solutionCandidateScope)
      var problemScope = new Scope("Problem");
      var solutionCandScope = new Scope("SolutionCandidate");
      problemScope.SubScopes.Add(solutionCandScope);

      // create variables for parameter values
      problemScope.Variables.Add(new Variable("ProblemData", problemData));
      problemScope.Variables.Add(new Variable("RemoveIntermediateResults", new BoolValue(true)));
      foreach (var kvp in utilizations) {
        solutionCandScope.Variables.Add(new Variable(kvp.Key, kvp.Value));
      }
      foreach (var kvp in transportTargets) {
        solutionCandScope.Variables.Add(new Variable(kvp.Key, kvp.Value));
      }

      // effectively executes the operators like an engine
      var eval = new AggregateEvaluator();
      var context = new HeuristicLab.Core.ExecutionContext(null, eval, solutionCandScope);

      // start engine to execute the operatorgraph within this algorithmoperator and wait until it's done
      using (var wh = new AutoResetEvent(false)) {
        var engine = new HeuristicLab.SequentialEngine.SequentialEngine();
        engine.Stopped += (sender, args) => {
          wh.Set();
        };
        engine.ExceptionOccurred += (sender, args) => {
          wh.Set();
        };

        engine.Prepare(context);
        engine.Start();
        wh.WaitOne();
      }
      return solutionCandScope;
    }

  }
}