Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.VehicleRouting/3.4/VehicleRoutingProblem.cs @ 13788

Last change on this file since 13788 was 13173, checked in by abeham, 9 years ago

#2454: added some acronyms
File size: 16.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using HeuristicLab.Analysis;
27using HeuristicLab.Common;
28using HeuristicLab.Core;
29using HeuristicLab.Data;
30using HeuristicLab.Optimization;
31using HeuristicLab.Optimization.Operators;
32using HeuristicLab.Parameters;
33using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
34using HeuristicLab.PluginInfrastructure;
35using HeuristicLab.Problems.Instances;
36using HeuristicLab.Problems.VehicleRouting.Encodings.Alba;
37using HeuristicLab.Problems.VehicleRouting.Interfaces;
38using HeuristicLab.Problems.VehicleRouting.Interpreters;
39using HeuristicLab.Problems.VehicleRouting.ProblemInstances;
40using HeuristicLab.Problems.VehicleRouting.Variants;
41
42namespace HeuristicLab.Problems.VehicleRouting {
43  [Item("Vehicle Routing Problem (VRP)", "Represents a Vehicle Routing Problem.")]
44  [Creatable(CreatableAttribute.Categories.CombinatorialProblems, Priority = 110)]
45  [StorableClass]
46  public sealed class VehicleRoutingProblem : Problem, ISingleObjectiveHeuristicOptimizationProblem, IStorableContent, IProblemInstanceConsumer<IVRPData> {
47    public string Filename { get; set; }
48
49    public static new Image StaticItemImage {
50      get { return HeuristicLab.Common.Resources.VSImageLibrary.Type; }
51    }
52
53    #region Parameter Properties
54    public ValueParameter<BoolValue> MaximizationParameter {
55      get { return (ValueParameter<BoolValue>)Parameters["Maximization"]; }
56    }
57    IParameter ISingleObjectiveHeuristicOptimizationProblem.MaximizationParameter {
58      get { return MaximizationParameter; }
59    }
60    public ValueParameter<IVRPProblemInstance> ProblemInstanceParameter {
61      get { return (ValueParameter<IVRPProblemInstance>)Parameters["ProblemInstance"]; }
62    }
63    public OptionalValueParameter<DoubleValue> BestKnownQualityParameter {
64      get { return (OptionalValueParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
65    }
66    IParameter ISingleObjectiveHeuristicOptimizationProblem.BestKnownQualityParameter {
67      get { return BestKnownQualityParameter; }
68    }
69    public OptionalValueParameter<VRPSolution> BestKnownSolutionParameter {
70      get { return (OptionalValueParameter<VRPSolution>)Parameters["BestKnownSolution"]; }
71    }
72    public IConstrainedValueParameter<IVRPCreator> SolutionCreatorParameter {
73      get { return (IConstrainedValueParameter<IVRPCreator>)Parameters["SolutionCreator"]; }
74    }
75    IParameter IHeuristicOptimizationProblem.SolutionCreatorParameter {
76      get { return SolutionCreatorParameter; }
77    }
78    public IValueParameter<IVRPEvaluator> EvaluatorParameter {
79      get { return (IValueParameter<IVRPEvaluator>)Parameters["Evaluator"]; }
80    }
81    IParameter IHeuristicOptimizationProblem.EvaluatorParameter {
82      get { return EvaluatorParameter; }
83    }
84    #endregion
85
86    #region Properties
87    public IVRPProblemInstance ProblemInstance {
88      get { return ProblemInstanceParameter.Value; }
89      set { ProblemInstanceParameter.Value = value; }
90    }
91
92    public VRPSolution BestKnownSolution {
93      get { return BestKnownSolutionParameter.Value; }
94      set { BestKnownSolutionParameter.Value = value; }
95    }
96
97    public DoubleValue BestKnownQuality {
98      get { return BestKnownQualityParameter.Value; }
99      set { BestKnownQualityParameter.Value = value; }
100    }
101
102    public ISingleObjectiveEvaluator Evaluator {
103      get { return EvaluatorParameter.Value; }
104    }
105
106    IEvaluator IHeuristicOptimizationProblem.Evaluator {
107      get { return this.Evaluator; }
108    }
109
110    ISolutionCreator IHeuristicOptimizationProblem.SolutionCreator {
111      get { return SolutionCreatorParameter.Value; }
112    }
113    public IVRPCreator SolutionCreator {
114      get { return SolutionCreatorParameter.Value; }
115      set { SolutionCreatorParameter.Value = value; }
116    }
117    #endregion
118
119    [StorableConstructor]
120    private VehicleRoutingProblem(bool deserializing) : base(deserializing) { }
121    public VehicleRoutingProblem()
122      : base() {
123      Parameters.Add(new ValueParameter<BoolValue>("Maximization", "Set to false as the Vehicle Routing Problem is a minimization problem.", new BoolValue(false)));
124      Parameters.Add(new ValueParameter<IVRPProblemInstance>("ProblemInstance", "The VRP problem instance"));
125      Parameters.Add(new OptionalValueParameter<DoubleValue>("BestKnownQuality", "The quality of the best known solution of this VRP instance."));
126      Parameters.Add(new OptionalValueParameter<VRPSolution>("BestKnownSolution", "The best known solution of this VRP instance."));
127
128      Parameters.Add(new ConstrainedValueParameter<IVRPCreator>("SolutionCreator", "The operator which should be used to create new VRP solutions."));
129      Parameters.Add(new ValueParameter<IVRPEvaluator>("Evaluator", "The operator which should be used to evaluate VRP solutions."));
130
131      EvaluatorParameter.Hidden = true;
132
133      InitializeRandomVRPInstance();
134      InitializeOperators();
135
136      AttachEventHandlers();
137      AttachProblemInstanceEventHandlers();
138
139      EvaluatorParameter.Value = ProblemInstance.SolutionEvaluator;
140    }
141
142    public override IDeepCloneable Clone(Cloner cloner) {
143      cloner.Clone(ProblemInstance);
144      return new VehicleRoutingProblem(this, cloner);
145    }
146
147    private VehicleRoutingProblem(VehicleRoutingProblem original, Cloner cloner)
148      : base(original, cloner) {
149      this.AttachEventHandlers();
150      this.AttachProblemInstanceEventHandlers();
151
152      ProblemInstance.SolutionEvaluator = EvaluatorParameter.Value;
153    }
154
155    #region Events
156    public event EventHandler SolutionCreatorChanged;
157    private void OnSolutionCreatorChanged() {
158      EventHandler handler = SolutionCreatorChanged;
159      if (handler != null) handler(this, EventArgs.Empty);
160    }
161    public event EventHandler EvaluatorChanged;
162    private void OnEvaluatorChanged() {
163      EventHandler handler = EvaluatorChanged;
164      if (handler != null) handler(this, EventArgs.Empty);
165    }
166    #endregion
167
168    #region Helpers
169    [StorableHook(HookType.AfterDeserialization)]
170    private void AfterDeserialization() {
171      AttachEventHandlers();
172      AttachProblemInstanceEventHandlers();
173
174      ProblemInstance.SolutionEvaluator = EvaluatorParameter.Value;
175    }
176
177    [Storable(Name = "operators", AllowOneWay = true)]
178    private List<IOperator> StorableOperators {
179      set { Operators.AddRange(value); }
180    }
181
182    private void AttachEventHandlers() {
183      ProblemInstanceParameter.ValueChanged += new EventHandler(ProblemInstanceParameter_ValueChanged);
184      BestKnownSolutionParameter.ValueChanged += new EventHandler(BestKnownSolutionParameter_ValueChanged);
185      EvaluatorParameter.ValueChanged += new EventHandler(EvaluatorParameter_ValueChanged);
186      SolutionCreatorParameter.ValueChanged += new EventHandler(SolutionCreatorParameter_ValueChanged);
187    }
188
189    private void AttachProblemInstanceEventHandlers() {
190      if (ProblemInstance != null) {
191        ProblemInstance.EvaluationChanged += new EventHandler(ProblemInstance_EvaluationChanged);
192      }
193    }
194
195    private void EvalBestKnownSolution() {
196      if (BestKnownSolution != null) {
197        //call evaluator
198        BestKnownQuality = new DoubleValue(ProblemInstance.Evaluate(BestKnownSolution.Solution).Quality);
199        BestKnownSolution.Quality = BestKnownQuality;
200      } else {
201        BestKnownQuality = null;
202      }
203    }
204
205    void BestKnownSolutionParameter_ValueChanged(object sender, EventArgs e) {
206      EvalBestKnownSolution();
207    }
208
209    void ProblemInstance_EvaluationChanged(object sender, EventArgs e) {
210      EvalBestKnownSolution();
211    }
212
213    void ProblemInstanceParameter_ValueChanged(object sender, EventArgs e) {
214      InitializeOperators();
215      AttachProblemInstanceEventHandlers();
216
217      EvaluatorParameter.Value = ProblemInstance.SolutionEvaluator;
218
219      OnSolutionCreatorChanged();
220      OnEvaluatorChanged();
221      OnOperatorsChanged();
222    }
223
224    public void SetProblemInstance(IVRPProblemInstance instance) {
225      ProblemInstanceParameter.ValueChanged -= new EventHandler(ProblemInstanceParameter_ValueChanged);
226
227      ProblemInstance = instance;
228      AttachProblemInstanceEventHandlers();
229
230      OnSolutionCreatorChanged();
231      OnEvaluatorChanged();
232
233      ProblemInstanceParameter.ValueChanged += new EventHandler(ProblemInstanceParameter_ValueChanged);
234    }
235
236    private void SolutionCreatorParameter_ValueChanged(object sender, EventArgs e) {
237      OnSolutionCreatorChanged();
238    }
239    private void EvaluatorParameter_ValueChanged(object sender, EventArgs e) {
240      if (ProblemInstance != null)
241        ProblemInstance.SolutionEvaluator = EvaluatorParameter.Value;
242      OnEvaluatorChanged();
243    }
244
245    private void InitializeOperators() {
246      var solutionCreatorParameter = SolutionCreatorParameter as ConstrainedValueParameter<IVRPCreator>;
247      solutionCreatorParameter.ValidValues.Clear();
248
249      Operators.Clear();
250
251      if (ProblemInstance != null) {
252        Operators.AddRange(
253        ProblemInstance.Operators.Concat(
254          ApplicationManager.Manager.GetInstances<IGeneralVRPOperator>().Cast<IOperator>()).OrderBy(op => op.Name));
255        Operators.Add(new VRPSimilarityCalculator());
256        Operators.Add(new QualitySimilarityCalculator());
257        Operators.Add(new NoSimilarityCalculator());
258        Operators.Add(new PopulationSimilarityAnalyzer(Operators.OfType<ISolutionSimilarityCalculator>()));
259
260        IVRPCreator defaultCreator = null;
261        foreach (IVRPCreator creator in Operators.Where(o => o is IVRPCreator)) {
262          solutionCreatorParameter.ValidValues.Add(creator);
263          if (creator is Encodings.Alba.RandomCreator)
264            defaultCreator = creator;
265        }
266        Operators.Add(new AlbaLambdaInterchangeLocalImprovementOperator());
267        if (defaultCreator != null)
268          solutionCreatorParameter.Value = defaultCreator;
269      }
270
271      ParameterizeOperators();
272    }
273
274    private void ParameterizeOperators() {
275      foreach (IOperator op in Operators.OfType<IOperator>()) {
276        if (op is IMultiVRPOperator) {
277          (op as IMultiVRPOperator).SetOperators(Operators.OfType<IOperator>());
278        }
279      }
280      if (ProblemInstance != null) {
281        foreach (ISingleObjectiveImprovementOperator op in Operators.OfType<ISingleObjectiveImprovementOperator>()) {
282          op.SolutionParameter.ActualName = SolutionCreator.VRPToursParameter.ActualName;
283          op.SolutionParameter.Hidden = true;
284        }
285        foreach (ISingleObjectivePathRelinker op in Operators.OfType<ISingleObjectivePathRelinker>()) {
286          op.ParentsParameter.ActualName = SolutionCreator.VRPToursParameter.ActualName;
287          op.ParentsParameter.Hidden = true;
288        }
289        foreach (ISolutionSimilarityCalculator op in Operators.OfType<ISolutionSimilarityCalculator>()) {
290          op.SolutionVariableName = SolutionCreator.VRPToursParameter.ActualName;
291          op.QualityVariableName = ProblemInstance.SolutionEvaluator.QualityParameter.ActualName;
292          var calc = op as VRPSimilarityCalculator;
293          if (calc != null) calc.ProblemInstance = ProblemInstance;
294        }
295      }
296    }
297
298    #endregion
299
300    private void InitializeRandomVRPInstance() {
301      System.Random rand = new System.Random();
302
303      CVRPTWProblemInstance problem = new CVRPTWProblemInstance();
304      int cities = 100;
305
306      problem.Coordinates = new DoubleMatrix(cities + 1, 2);
307      problem.Demand = new DoubleArray(cities + 1);
308      problem.DueTime = new DoubleArray(cities + 1);
309      problem.ReadyTime = new DoubleArray(cities + 1);
310      problem.ServiceTime = new DoubleArray(cities + 1);
311
312      problem.Vehicles.Value = 100;
313      problem.Capacity.Value = 200;
314
315      for (int i = 0; i <= cities; i++) {
316        problem.Coordinates[i, 0] = rand.Next(0, 100);
317        problem.Coordinates[i, 1] = rand.Next(0, 100);
318
319        if (i == 0) {
320          problem.Demand[i] = 0;
321          problem.DueTime[i] = Int16.MaxValue;
322          problem.ReadyTime[i] = 0;
323          problem.ServiceTime[i] = 0;
324        } else {
325          problem.Demand[i] = rand.Next(10, 50);
326          problem.DueTime[i] = rand.Next((int)Math.Ceiling(problem.GetDistance(0, i, null)), 1200);
327          problem.ReadyTime[i] = problem.DueTime[i] - rand.Next(0, 100);
328          problem.ServiceTime[i] = 90;
329        }
330      }
331
332      this.ProblemInstance = problem;
333    }
334
335    public void ImportSolution(string solutionFileName) {
336      SolutionParser parser = new SolutionParser(solutionFileName);
337      parser.Parse();
338
339      HeuristicLab.Problems.VehicleRouting.Encodings.Potvin.PotvinEncoding encoding = new Encodings.Potvin.PotvinEncoding(ProblemInstance);
340
341      int cities = 0;
342      foreach (List<int> route in parser.Routes) {
343        Tour tour = new Tour();
344        tour.Stops.AddRange(route);
345        cities += tour.Stops.Count;
346
347        encoding.Tours.Add(tour);
348      }
349
350      if (cities != ProblemInstance.Coordinates.Rows - 1)
351        ErrorHandling.ShowErrorDialog(new Exception("The optimal solution does not seem to correspond with the problem data"));
352      else {
353        VRPSolution solution = new VRPSolution(ProblemInstance, encoding, new DoubleValue(0));
354        BestKnownSolutionParameter.Value = solution;
355      }
356    }
357
358    #region Instance Consuming
359    public void Load(IVRPData data, IVRPDataInterpreter interpreter) {
360      VRPInstanceDescription instance = interpreter.Interpret(data);
361
362      Name = instance.Name;
363      Description = instance.Description;
364
365      BestKnownQuality = null;
366      BestKnownSolution = null;
367
368      if (ProblemInstance != null && instance.ProblemInstance != null &&
369        instance.ProblemInstance.GetType() == ProblemInstance.GetType())
370        SetProblemInstance(instance.ProblemInstance);
371      else
372        ProblemInstance = instance.ProblemInstance;
373
374      OnReset();
375
376      if (instance.BestKnownQuality != null) {
377        BestKnownQuality = new DoubleValue((double)instance.BestKnownQuality);
378      }
379
380      if (instance.BestKnownSolution != null) {
381        VRPSolution solution = new VRPSolution(ProblemInstance, instance.BestKnownSolution, new DoubleValue(0));
382        BestKnownSolution = solution;
383      }
384    }
385    #endregion
386
387    #region IProblemInstanceConsumer<VRPData> Members
388
389    public void Load(IVRPData data) {
390      var interpreterDataType = data.GetType();
391      var interpreterType = typeof(IVRPDataInterpreter<>).MakeGenericType(interpreterDataType);
392
393      var interpreters = ApplicationManager.Manager.GetTypes(interpreterType);
394
395      var concreteInterpreter = interpreters.Single(t => GetInterpreterDataType(t) == interpreterDataType);
396
397      Load(data, (IVRPDataInterpreter)Activator.CreateInstance(concreteInterpreter));
398    }
399
400    private Type GetInterpreterDataType(Type type) {
401      var parentInterfaces = type.BaseType.GetInterfaces();
402      var interfaces = type.GetInterfaces().Except(parentInterfaces);
403
404      var interpreterInterface = interfaces.Single(i => typeof(IVRPDataInterpreter).IsAssignableFrom(i));
405      return interpreterInterface.GetGenericArguments()[0];
406    }
407
408    #endregion
409  }
410}
Note: See TracBrowser for help on using the repository browser.