source: branches/FitnessLandscapeAnalysis/HeuristicLab.Analysis.FitnessLandscape/Analysis/RuggednessAnalyzer.cs @ 12563

#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.Analysis.FitnessLandscape.DataTables;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Analysis.FitnessLandscape.Analysis {

  [StorableClass]
  public class RuggednessAnalyzer : AlgorithmOperator, IQualityTrailAnalyzer {
    public bool EnabledByDefault {
      get { return false; }
    }

    #region Parameters
    public LookupParameter<DataTable> QualityTrailParameter {
      get { return (LookupParameter<DataTable>)Parameters["Quality Trail"]; }
    }
    public LookupParameter<DataTable> CorrelationLengthTableParameter {
      get { return (LookupParameter<DataTable>)Parameters["CorrelationLengthTable"]; }
    }
    public LookupParameter<AutoCorrelationTable> AutocorrelationParameter {
      get { return (LookupParameter<AutoCorrelationTable>)Parameters["Autocorrelation"]; }
    }
    public LookupParameter<VariableCollection> ResultsParameter {
      get { return (LookupParameter<VariableCollection>)Parameters["Results"]; }
    }
    public LookupParameter<DoubleValue> AutoCorrelation1Parameter {
      get { return (LookupParameter<DoubleValue>)Parameters["AutoCorrelation1"]; }
    }
    public LookupParameter<IntValue> CorrelationLengthParameter {
      get { return (LookupParameter<IntValue>)Parameters["CorrelationLength"]; }
    }
    #endregion

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

    public RuggednessAnalyzer() {
      Parameters.Add(new LookupParameter<DataTable>("Quality Trail", "The quality of the solution"));
      Parameters.Add(new LookupParameter<DataTable>("CorrelationLengthTable", "Maximum nr of steps between statistically significantly correlated quality values"));
      Parameters.Add(new LookupParameter<AutoCorrelationTable>("Autocorrelation", "Autocorrelation function of successive quality values"));
      Parameters.Add(new LookupParameter<VariableCollection>("Results", "The collection of all results of this algorithm"));
      Parameters.Add(new LookupParameter<DoubleValue>("AutoCorrelation1", "Autocorrelation for one mutation step."));
      Parameters.Add(new LookupParameter<IntValue>("CorrelationLength", "The correlation length."));

      var resultsCollector = new ResultsCollector();
      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(CorrelationLengthTableParameter.Name));
      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>(AutocorrelationParameter.Name));
      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>(AutoCorrelation1Parameter.Name));
      resultsCollector.CollectedValues.Add(new LookupParameter<IntValue>(CorrelationLengthParameter.Name));

      OperatorGraph.InitialOperator = resultsCollector;
      resultsCollector.Successor = null;
    }

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

    public override IOperation Apply() {
      DataTable correlationLengthTable = GetOrCreateCorrelationLengthTable();
      AutoCorrelationTable autocorrelationTable = GetOrCreateAutoCorrelationTable();
      DataTable qualityTrail = QualityTrailParameter.ActualValue;
      if (qualityTrail != null && qualityTrail.Rows.Count > 0) {
        double[] autocorrelationValues;
        int correlationLength = RuggednessCalculator.CalculateCorrelationLength(qualityTrail.Rows.First().Values.ToArray(), out autocorrelationValues);
        correlationLengthTable.Rows["Correlation Length"].Values.Add(correlationLength);
        autocorrelationTable.Rows["Auto Correlation"].Values.Clear();
        autocorrelationTable.Rows["Auto Correlation"].Values.AddRange(autocorrelationValues);
        CorrelationLengthParameter.ActualValue = new IntValue(correlationLength);
        AutoCorrelation1Parameter.ActualValue = new DoubleValue(autocorrelationValues.Length > 1 ? autocorrelationValues[1] : 0.0);
      }
      return base.Apply();
    }

    private AutoCorrelationTable GetOrCreateAutoCorrelationTable() {
      AutoCorrelationTable autocorrelationTable = AutocorrelationParameter.ActualValue;
      if (autocorrelationTable == null) {
        autocorrelationTable = new AutoCorrelationTable("Auto Correlation");
        AutocorrelationParameter.ActualValue = autocorrelationTable;
        var row = new DataRow("Auto Correlation");
        row.VisualProperties.StartIndexZero = true;
        autocorrelationTable.Rows.Add(row);
      }
      return autocorrelationTable;
    }

    private DataTable GetOrCreateCorrelationLengthTable() {
      DataTable correlationLengthTable = CorrelationLengthTableParameter.ActualValue;
      if (correlationLengthTable == null) {
        correlationLengthTable = new DataTable("Correlation Length");
        CorrelationLengthTableParameter.ActualValue = correlationLengthTable;
        correlationLengthTable.Rows.Add(new DataRow("Correlation Length"));
      }
      return correlationLengthTable;
    }
  }
}