source: branches/PerformanceComparison/HeuristicLab.OptimizationExpertSystem.Common/3.3/OverallBestRecommender.cs @ 13774

#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 HeuristicLab.Analysis;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using System;
using System.Collections.Generic;
using System.Linq;

namespace HeuristicLab.OptimizationExpertSystem.Common {
  [Item("Overall Best Recommender", "")]
  [StorableClass]
  public class OverallBestRecommender : ParameterizedNamedItem, IAlgorithmInstanceRecommender {
    private KnowledgeCenter okc;

    private IFixedValueParameter<EnumValue<ProblemInstanceProximityType>> ProximityTypeParameter {
      get { return (IFixedValueParameter<EnumValue<ProblemInstanceProximityType>>)Parameters["ProximityType"]; }
    }

    private IFixedValueParameter<DoubleValue> NeighborhoodFactorParameter {
      get { return (IFixedValueParameter<DoubleValue>)Parameters["NeighborhoodFactor"]; }
    }

    public ProblemInstanceProximityType ProximityType {
      get { return ProximityTypeParameter.Value.Value; }
      set { ProximityTypeParameter.Value.Value = value; }
    }

    public double NeighborhoodFactor {
      get { return NeighborhoodFactorParameter.Value.Value; }
      set { NeighborhoodFactorParameter.Value.Value = value; }
    }
    
    [StorableConstructor]
    private OverallBestRecommender(bool deserializing) : base(deserializing) { }
    private OverallBestRecommender(OverallBestRecommender original, Cloner cloner)
      : base(original, cloner) { }
    public OverallBestRecommender(KnowledgeCenter okc) {
      this.okc = okc;
      Parameters.Add(new FixedValueParameter<EnumValue<ProblemInstanceProximityType>>("ProximityType", "The type of neighbor proximity.", new EnumValue<ProblemInstanceProximityType>(ProblemInstanceProximityType.FeatureSpace)));
      Parameters.Add(new FixedValueParameter<DoubleValue>("NeighborhoodFactor", "Penalize neighbors that are far away.", new DoubleValue(5)));
    }

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

    public IEnumerable<IAlgorithm> GetRanking() {
      if (okc.Problem.ProblemId == -1) yield break;

      var instances = new List<Tuple<IAlgorithm, double>>();
      foreach (var relevantRuns in okc.GetKnowledgeBaseByAlgorithm()) {
        var algorithm = relevantRuns.Key;
        var pis = relevantRuns.Value.Select(x => ((StringValue)x.Parameters["Problem Name"]).Value).Distinct()
                              .Select(x => Tuple.Create(x, okc.ProblemInstances.SingleOrDefault(y => ((StringValue)y.Parameters["Problem Name"]).Value == x)))
                              .Where(x => x.Item2 != null)
                              .Select(x => Tuple.Create(x.Item1, ((DoubleValue)x.Item2.Parameters["BestKnownQuality"]).Value))
                              .ToDictionary(x => x.Item1, x => x.Item2);
        var avgERT = 0.0;
        var count = 0;
        foreach (var problemRuns in relevantRuns.Value.GroupBy(x => ((StringValue)x.Parameters["Problem Name"]).Value)) {
          var bkq = pis[problemRuns.Key];
          var ert = ExpectedRuntimeHelper.CalculateErt(problemRuns.ToList(), "QualityPerEvaluations", (okc.Maximization ? (1 - okc.MinimumTarget.Value) : (1 + okc.MinimumTarget.Value)) * bkq, okc.Maximization).ExpectedRuntime;
          if (double.IsNaN(ert)) ert = int.MaxValue;
          avgERT += ert;
          count++;
        }
        avgERT /= count;
        instances.Add(Tuple.Create(algorithm, avgERT));
      }

      foreach (var alg in instances.OrderBy(x => x.Item2).Select(x => (IAlgorithm)x.Item1.Clone()))
        yield return alg;
    }
  }
}