source: branches/1614_GeneralizedQAP/HeuristicLab.Analysis.FitnessLandscape/3.3/CharacteristicCalculator/UpDownWalkCalculator.cs @ 16953

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2016 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;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using HEAL.Attic;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Optimization;

namespace HeuristicLab.Analysis.FitnessLandscape {
  [Item("Up/Down Walk Calculator", "Calculates characteristics from an up/down walk.")]
  [StorableType("8BFA83BD-231E-43C6-AA1A-0F9094163B26")]
  public class UpDownWalkCalculator : NamedItem, ICharacteristicCalculator {

    [Storable]
    private IProblem problem;
    public IProblem Problem {
      get { return problem; }
      set {
        if (problem == value) return;
        problem = value;
        var soProblem = problem as ISingleObjectiveHeuristicOptimizationProblem;
        walker.Problem = soProblem;
      }
    }

    [Storable]
    private UpDownWalk walker;

    [StorableConstructor]
    private UpDownWalkCalculator(StorableConstructorFlag _) : base(_) { }
    private UpDownWalkCalculator(UpDownWalkCalculator original, Cloner cloner)
      : base(original, cloner) {
      problem = cloner.Clone(original.problem);
      walker = cloner.Clone(original.walker);
      characteristics = cloner.Clone(original.characteristics);
    }
    public UpDownWalkCalculator() : this(new UpDownWalk()) { }
    public UpDownWalkCalculator(UpDownWalk walker) {
      Name = ItemName;
      Description = ItemDescription;
      this.walker = walker;
      characteristics = new CheckedItemList<StringValue>(
        new[] { "AutoCorrelation1", "CorrelationLength", "InformationContent",
        "PartialInformationContent", "DensityBasinInformation", "InformationStability", 
        "Diversity", "Regularity", "TotalEntropy", "PeakInformationContent",
        "PeakDensityBasinInformation", "DownWalkLength", "UpWalkLength", "UpWalkLenVar",
        "DownWalkLenVar", "LowerVariance", "UpperVariance" }.Select(x => new StringValue(x)));
    }

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

    private CheckedItemList<StringValue> characteristics;
    public ReadOnlyCheckedItemList<StringValue> Characteristics {
      get { return characteristics.AsReadOnly(); }
    }

    public bool CanCalculate() {
      return Problem is ISingleObjectiveHeuristicOptimizationProblem
        && Problem.Operators.Any(x => x is IManipulator);
    }

    public IEnumerable<IResult> Calculate() {
      walker.Prepare(true);
      using (var waitHandle = new AutoResetEvent(false)) {
        EventHandler evHandle = (sender, e) => {
          if (walker.ExecutionState == ExecutionState.Paused
          || walker.ExecutionState == ExecutionState.Stopped) waitHandle.Set();
        };
        walker.ExecutionStateChanged += evHandle;
        walker.Start();
        waitHandle.WaitOne();
        walker.ExecutionStateChanged -= evHandle;
      }
      foreach (var p in characteristics.CheckedItems) {
        yield return new Result("UpDownWalk." + walker.MutatorParameter.Value.Name + "." + p.Value.Value, walker.Results[p.Value.Value].Value);
      }
      walker.Prepare(true);
    }

    public void CollectParameterValues(IDictionary<string, IItem> values) {
      walker.CollectParameterValues(values);
    }

    public IKeyedItemCollection<string, IParameter> Parameters {
      get { return ((IParameterizedItem)walker).Parameters; }
    }
  }
}