source: branches/FitnessLandscapeAnalysis/HeuristicLab.Analysis.FitnessLandscape/Analysis/QualityTrailMultiAnalyzer.cs @ 13042

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2010 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.Linq;
using HeuristicLab.Collections;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Optimization.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.PluginInfrastructure;
namespace HeuristicLab.Analysis.FitnessLandscape {

  [Item("QualityTrailAnalyzer", "An analyzer that creates a quality trail which can be further analyzed by several analyzers.")]
  [StorableClass]
  public class QualityTrailMultiAnalyzer : CheckedMultiOperator<IQualityTrailAnalyzer>, IAnalyzer {
    public bool EnabledByDefault {
      get { return false; }
    }

    public override bool CanChangeName {
      get { return false; }
    }

    public ValueLookupParameter<IntValue> UpdateIntervalParameter {
      get { return (ValueLookupParameter<IntValue>)Parameters["QualityTrailUpdateInterval"]; }
    }
    public LookupParameter<IntValue> UpdateCounterParameter {
      get { return (LookupParameter<IntValue>)Parameters["QualityTrailUpdateCounter"]; }
    }
    public ValueLookupParameter<DataTable> QualityTrailParameter {
      get { return (ValueLookupParameter<DataTable>)Parameters["Quality Trail"]; }
    }
    public LookupParameter<VariableCollection> ResultsParameter {
      get { return (LookupParameter<VariableCollection>)Parameters["Results"]; }
    }
    public LookupParameter<DoubleValue> QualityParameter {
      get { return (LookupParameter<DoubleValue>)Parameters["Quality"]; }
    }
    public ScopeTreeLookupParameter<DoubleValue> QualitiesParameter {
      get { return (ScopeTreeLookupParameter<DoubleValue>)Parameters["Qualities"]; }
    }
    public OperatorParameter ResultsCollector {
      get { return (OperatorParameter)Parameters["ResultsCollector"]; }
    }
    public LookupParameter<BoolValue> MaximizationParameter {
      get { return (LookupParameter<BoolValue>)Parameters["Maximization"]; }
    }

    public IntValue UpdateInterval {
      get { return UpdateIntervalParameter.Value; }
      set { UpdateIntervalParameter.Value = value; }
    }

    [StorableConstructor]
    protected QualityTrailMultiAnalyzer(bool deserializing) : base(deserializing) { }
    protected QualityTrailMultiAnalyzer(QualityTrailMultiAnalyzer original, Cloner cloner) : base(original, cloner) { }

    public QualityTrailMultiAnalyzer()
      : base() {
      Parameters.Add(new ValueLookupParameter<IntValue>("QualityTrailUpdateInterval", "The interval at which the contained analyzers should be applied.", new IntValue(1)));
      Parameters.Add(new LookupParameter<IntValue>("QualityTrailUpdateCounter", "The number of times the Analyzer was called since the last update."));
      Parameters.Add(new ValueLookupParameter<DataTable>("Quality Trail", "All historical quality values throughout the algorithm run"));
      Parameters.Add(new LookupParameter<DoubleValue>("Quality", "Single quality value from the current iteration/generation"));
      Parameters.Add(new ScopeTreeLookupParameter<DoubleValue>("Qualities", "Quality values of the whole population", "Quality", 1));
      Parameters.Add(new LookupParameter<VariableCollection>("Results", "The collected results"));
      Parameters.Add(new OperatorParameter("ResultsCollector"));
      Parameters.Add(new LookupParameter<BoolValue>("Maximization", "Whether the problem is a maximization problem"));

      foreach (var analyzer in ApplicationManager.Manager.GetInstances<IQualityTrailAnalyzer>())
        Operators.Add(analyzer);

      var resultsCollector = new ResultsCollector();
      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(QualityTrailParameter.Name));
      ResultsCollector.Value = resultsCollector;
    }

    public override IDeepCloneable Clone(Cloner cloner) {
      return new QualityTrailMultiAnalyzer(this, cloner);
    }

    public override IOperation InstrumentedApply() {
      UpdateQualityTrail();

      IntValue interval = UpdateIntervalParameter.ActualValue;
      if (interval == null) interval = new IntValue(1);

      IntValue counter = UpdateCounterParameter.ActualValue;
      if (counter == null) {
        counter = new IntValue(interval.Value);
        UpdateCounterParameter.ActualValue = counter;
      } else counter.Value++;

      OperationCollection next = new OperationCollection();
      next.Add(ExecutionContext.CreateOperation(ResultsCollector.Value));
      if (counter.Value == interval.Value) {
        counter.Value = 0;
        foreach (IndexedItem<IQualityTrailAnalyzer> item in Operators.CheckedItems)
          next.Add(ExecutionContext.CreateOperation(item.Value));

      }
      next.Add(base.InstrumentedApply());
      return next;
    }

    private void UpdateQualityTrail() {
      DataTable qualityTrail = QualityTrailParameter.ActualValue;
      if (qualityTrail == null) {
        qualityTrail = new DataTable("Quality Trail");
        qualityTrail.Rows.Add(new DataRow("Qualities"));
        QualityTrailParameter.ActualValue = qualityTrail;
      }
      if (QualityParameter.ActualValue != null)
        qualityTrail.Rows["Qualities"].Values.Add(QualityParameter.ActualValue.Value);
      if (QualitiesParameter.ActualName != null &&
        QualitiesParameter.ActualValue.Count() > 0 &&
        MaximizationParameter != null)
        if (MaximizationParameter.ActualValue.Value)
          qualityTrail.Rows["Qualities"].Values.Add(QualitiesParameter.ActualValue.Select(dv => dv.Value).Max());
        else
          qualityTrail.Rows["Qualities"].Values.Add(QualitiesParameter.ActualValue.Select(dv => dv.Value).Min());

    }
  }
}