#region License Information
/* HeuristicLab
* Copyright (C) 2002-2019 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 .
*/
#endregion
using System.Linq;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Encodings.IntegerVectorEncoding;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HEAL.Fossil;
namespace HeuristicLab.Problems.Orienteering {
[StorableType("6E07CAD7-20ED-4507-B2BB-B7393D9BBB95")]
public sealed class BestOrienteeringSolutionAnalyzer : SingleSuccessorOperator, IAnalyzer {
public bool EnabledByDefault {
get { return true; }
}
public IScopeTreeLookupParameter IntegerVector {
get { return (IScopeTreeLookupParameter)Parameters["IntegerVector"]; }
}
public ILookupParameter CoordinatesParameter {
get { return (ILookupParameter)Parameters["Coordinates"]; }
}
public ILookupParameter DistanceMatrixParameter {
get { return (ILookupParameter)Parameters["DistanceMatrix"]; }
}
public ILookupParameter StartingPointParameter {
get { return (ILookupParameter)Parameters["StartingPoint"]; }
}
public ILookupParameter TerminalPointParameter {
get { return (ILookupParameter)Parameters["TerminalPoint"]; }
}
public ILookupParameter ScoresParameter {
get { return (ILookupParameter)Parameters["Scores"]; }
}
public ILookupParameter PointVisitingCostsParameter {
get { return (ILookupParameter)Parameters["PointVisitingCosts"]; }
}
public IScopeTreeLookupParameter QualityParameter {
get { return (IScopeTreeLookupParameter)Parameters["Quality"]; }
}
public IScopeTreeLookupParameter PenaltyParameter {
get { return (IScopeTreeLookupParameter)Parameters["Penalty"]; }
}
public ILookupParameter BestSolutionParameter {
get { return (ILookupParameter)Parameters["BestSolution"]; }
}
public IValueLookupParameter ResultsParameter {
get { return (IValueLookupParameter)Parameters["Results"]; }
}
public ILookupParameter BestKnownQualityParameter {
get { return (ILookupParameter)Parameters["BestKnownQuality"]; }
}
public ILookupParameter BestKnownSolutionParameter {
get { return (ILookupParameter)Parameters["BestKnownSolution"]; }
}
[StorableConstructor]
private BestOrienteeringSolutionAnalyzer(StorableConstructorFlag _) : base(_) { }
private BestOrienteeringSolutionAnalyzer(BestOrienteeringSolutionAnalyzer original, Cloner cloner) : base(original, cloner) { }
public override IDeepCloneable Clone(Cloner cloner) {
return new BestOrienteeringSolutionAnalyzer(this, cloner);
}
public BestOrienteeringSolutionAnalyzer()
: base() {
Parameters.Add(new ScopeTreeLookupParameter("IntegerVector", "The Orienteering solutions which should be analysed."));
Parameters.Add(new LookupParameter("Coordinates", "The x- and y-Coordinates of the points."));
Parameters.Add(new LookupParameter("DistanceMatrix", "The matrix which contains the distances between the points."));
Parameters.Add(new LookupParameter("StartingPoint", "Index of the starting point."));
Parameters.Add(new LookupParameter("TerminalPoint", "Index of the ending point."));
Parameters.Add(new LookupParameter("Scores", "The scores of the points."));
Parameters.Add(new LookupParameter("PointVisitingCosts", "The costs for visiting a point."));
Parameters.Add(new ScopeTreeLookupParameter("Quality", "The qualities of the Orienteering solutions which should be analyzed."));
Parameters.Add(new ScopeTreeLookupParameter("Penalty", "The applied penalty of the Orienteering solutions."));
Parameters.Add(new LookupParameter("BestSolution", "The best Orienteering solution."));
Parameters.Add(new ValueLookupParameter("Results", "The result collection where the best Orienteering solution should be stored."));
Parameters.Add(new LookupParameter("BestKnownQuality", "The quality of the best known solution of this Orienteering instance."));
Parameters.Add(new LookupParameter("BestKnownSolution", "The best known solution of this Orienteering instance."));
}
public override IOperation Apply() {
var solutions = IntegerVector.ActualValue;
var qualities = QualityParameter.ActualValue;
var penalties = PenaltyParameter.ActualValue;
var results = ResultsParameter.ActualValue;
var bestKnownQuality = BestKnownQualityParameter.ActualValue;
int bestIndex = qualities.Select((quality, index) => new { index, quality.Value }).OrderByDescending(x => x.Value).First().index;
if (bestKnownQuality == null || qualities[bestIndex].Value > bestKnownQuality.Value) {
BestKnownQualityParameter.ActualValue = new DoubleValue(qualities[bestIndex].Value);
BestKnownSolutionParameter.ActualValue = (IntegerVector)solutions[bestIndex].Clone();
}
var solution = BestSolutionParameter.ActualValue;
var coordinates = CoordinatesParameter.ActualValue;
var startingPoint = StartingPointParameter.ActualValue;
var terminalPoint = TerminalPointParameter.ActualValue;
var scores = ScoresParameter.ActualValue;
var pointVisitingCosts = PointVisitingCostsParameter.ActualValue;
var distances = DistanceMatrixParameter.ActualValue;
double distance = distances.CalculateTourLength(solutions[bestIndex].ToList(), pointVisitingCosts.Value);
if (solution == null) {
solution = new OrienteeringSolution(
(IntegerVector)solutions[bestIndex].Clone(),
coordinates,
startingPoint,
terminalPoint,
scores,
new DoubleValue(qualities[bestIndex].Value),
new DoubleValue(penalties[bestIndex].Value),
new DoubleValue(distance));
BestSolutionParameter.ActualValue = solution;
results.Add(new Result("Best Orienteering Solution", solution));
} else {
if (solution.Quality.Value < qualities[bestIndex].Value) {
solution.Coordinates = coordinates;
solution.Scores = scores;
solution.IntegerVector = (IntegerVector)solutions[bestIndex].Clone();
solution.Quality.Value = qualities[bestIndex].Value;
solution.Penalty.Value = penalties[bestIndex].Value;
solution.Distance.Value = distance;
}
}
return base.Apply();
}
}
}