Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Algorithms.SimulatedAnnealing/3.3/SimulatedAnnealing.cs @ 3616

Last change on this file since 3616 was 3616, checked in by swagner, 14 years ago

Worked on refactoring of algorithm analysis and tracing (#999)

  • adapted GA and TSP
  • removed stuff related to visualizers
File size: 18.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Optimization;
29using HeuristicLab.Operators;
30using HeuristicLab.Optimization.Operators;
31using HeuristicLab.Parameters;
32using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
33using HeuristicLab.PluginInfrastructure;
34using HeuristicLab.Random;
35
36namespace HeuristicLab.Algorithms.SimulatedAnnealing {
37  [Item("Simulated Annealing", "A simulated annealing algorithm.")]
38  [Creatable("Algorithms")]
39  [StorableClass]
40  public sealed class SimulatedAnnealing : EngineAlgorithm {
41    #region Problem Properties
42    public override Type ProblemType {
43      get { return typeof(ISingleObjectiveProblem); }
44    }
45    public new ISingleObjectiveProblem Problem {
46      get { return (ISingleObjectiveProblem)base.Problem; }
47      set { base.Problem = value; }
48    }
49    #endregion
50
51    #region Parameter Properties
52    private ValueParameter<IntValue> SeedParameter {
53      get { return (ValueParameter<IntValue>)Parameters["Seed"]; }
54    }
55    private ValueParameter<BoolValue> SetSeedRandomlyParameter {
56      get { return (ValueParameter<BoolValue>)Parameters["SetSeedRandomly"]; }
57    }
58    private ConstrainedValueParameter<IMultiMoveGenerator> MoveGeneratorParameter {
59      get { return (ConstrainedValueParameter<IMultiMoveGenerator>)Parameters["MoveGenerator"]; }
60    }
61    private ConstrainedValueParameter<IMoveMaker> MoveMakerParameter {
62      get { return (ConstrainedValueParameter<IMoveMaker>)Parameters["MoveMaker"]; }
63    }
64    private ConstrainedValueParameter<ISingleObjectiveMoveEvaluator> MoveEvaluatorParameter {
65      get { return (ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>)Parameters["MoveEvaluator"]; }
66    }
67    private ConstrainedValueParameter<IDiscreteDoubleValueModifier> AnnealingOperatorParameter {
68      get { return (ConstrainedValueParameter<IDiscreteDoubleValueModifier>)Parameters["AnnealingOperator"]; }
69    }
70    private ValueParameter<IntValue> MaximumIterationsParameter {
71      get { return (ValueParameter<IntValue>)Parameters["MaximumIterations"]; }
72    }
73    private ValueParameter<IntValue> InnerIterationsParameter {
74      get { return (ValueParameter<IntValue>)Parameters["InnerIterations"]; }
75    }
76    private ValueParameter<DoubleValue> StartTemperatureParameter {
77      get { return (ValueParameter<DoubleValue>)Parameters["StartTemperature"]; }
78    }
79    private ValueParameter<DoubleValue> EndTemperatureParameter {
80      get { return (ValueParameter<DoubleValue>)Parameters["EndTemperature"]; }
81    }
82    #endregion
83
84    #region Properties
85    public IntValue Seed {
86      get { return SeedParameter.Value; }
87      set { SeedParameter.Value = value; }
88    }
89    public BoolValue SetSeedRandomly {
90      get { return SetSeedRandomlyParameter.Value; }
91      set { SetSeedRandomlyParameter.Value = value; }
92    }
93    public IMultiMoveGenerator MoveGenerator {
94      get { return MoveGeneratorParameter.Value; }
95      set { MoveGeneratorParameter.Value = value; }
96    }
97    public IMoveMaker MoveMaker {
98      get { return MoveMakerParameter.Value; }
99      set { MoveMakerParameter.Value = value; }
100    }
101    public ISingleObjectiveMoveEvaluator MoveEvaluator {
102      get { return MoveEvaluatorParameter.Value; }
103      set { MoveEvaluatorParameter.Value = value; }
104    }
105    public IntValue MaximumIterations {
106      get { return MaximumIterationsParameter.Value; }
107      set { MaximumIterationsParameter.Value = value; }
108    }
109    public IntValue InnerIterations {
110      get { return InnerIterationsParameter.Value; }
111      set { InnerIterationsParameter.Value = value; }
112    }
113    public DoubleValue StartTemperature {
114      get { return StartTemperatureParameter.Value; }
115      set { StartTemperatureParameter.Value = value; }
116    }
117    public DoubleValue EndTemperature {
118      get { return EndTemperatureParameter.Value; }
119      set { EndTemperatureParameter.Value = value; }
120    }
121    private RandomCreator RandomCreator {
122      get { return (RandomCreator)OperatorGraph.InitialOperator; }
123    }
124    private SolutionsCreator SolutionsCreator {
125      get { return (SolutionsCreator)RandomCreator.Successor; }
126    }
127    private SimulatedAnnealingMainLoop MainLoop {
128      get { return (SimulatedAnnealingMainLoop)SolutionsCreator.Successor; }
129    }
130
131    private List<IDiscreteDoubleValueModifier> annealingOperators;
132    private IEnumerable<IDiscreteDoubleValueModifier> AnnealingOperators {
133      get { return annealingOperators; }
134    }
135    #endregion
136
137    public SimulatedAnnealing()
138      : base() {
139      Parameters.Add(new ValueParameter<IntValue>("Seed", "The random seed used to initialize the new pseudo random number generator.", new IntValue(0)));
140      Parameters.Add(new ValueParameter<BoolValue>("SetSeedRandomly", "True if the random seed should be set to a random value, otherwise false.", new BoolValue(true)));
141      Parameters.Add(new ConstrainedValueParameter<IMultiMoveGenerator>("MoveGenerator", "The operator used to generate moves to the neighborhood of the current solution."));
142      Parameters.Add(new ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>("MoveEvaluator", "The operator used to evaluate a move."));
143      Parameters.Add(new ConstrainedValueParameter<IMoveMaker>("MoveMaker", "The operator used to perform a move."));
144      Parameters.Add(new ConstrainedValueParameter<IDiscreteDoubleValueModifier>("AnnealingOperator", "The operator used to modify the temperature."));
145      Parameters.Add(new ValueParameter<IntValue>("MaximumIterations", "The maximum number of generations which should be processed.", new IntValue(100)));
146      Parameters.Add(new ValueParameter<IntValue>("InnerIterations", "The amount of inner iterations (number of moves before temperature is adjusted again).", new IntValue(10)));
147      Parameters.Add(new ValueParameter<DoubleValue>("StartTemperature", "The initial temperature.", new DoubleValue(100)));
148      Parameters.Add(new ValueParameter<DoubleValue>("EndTemperature", "The final temperature which should be reached when iterations reaches maximum iterations.", new DoubleValue(1e-6)));
149
150      RandomCreator randomCreator = new RandomCreator();
151      SolutionsCreator solutionsCreator = new SolutionsCreator();
152      SimulatedAnnealingMainLoop mainLoop = new SimulatedAnnealingMainLoop();
153      OperatorGraph.InitialOperator = randomCreator;
154
155      randomCreator.RandomParameter.ActualName = "Random";
156      randomCreator.SeedParameter.ActualName = SeedParameter.Name;
157      randomCreator.SeedParameter.Value = null;
158      randomCreator.SetSeedRandomlyParameter.ActualName = SetSeedRandomlyParameter.Name;
159      randomCreator.SetSeedRandomlyParameter.Value = null;
160      randomCreator.Successor = solutionsCreator;
161
162      solutionsCreator.NumberOfSolutions = new IntValue(1);
163      solutionsCreator.Successor = mainLoop;
164
165      mainLoop.MoveGeneratorParameter.ActualName = MoveGeneratorParameter.Name;
166      mainLoop.MoveEvaluatorParameter.ActualName = MoveEvaluatorParameter.Name;
167      mainLoop.MoveMakerParameter.ActualName = MoveMakerParameter.Name;
168      mainLoop.AnnealingOperatorParameter.ActualName = AnnealingOperatorParameter.Name;
169      mainLoop.MaximumIterationsParameter.ActualName = MaximumIterationsParameter.Name;
170      mainLoop.StartTemperatureParameter.ActualName = StartTemperatureParameter.Name;
171      mainLoop.EndTemperatureParameter.ActualName = EndTemperatureParameter.Name;
172      mainLoop.RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
173      mainLoop.ResultsParameter.ActualName = "Results";
174
175      Initialize();
176    }
177    [StorableConstructor]
178    private SimulatedAnnealing(bool deserializing) : base(deserializing) { }
179
180    public override IDeepCloneable Clone(Cloner cloner) {
181      SimulatedAnnealing clone = (SimulatedAnnealing)base.Clone(cloner);
182      clone.Initialize();
183      return clone;
184    }
185
186    public override void Prepare() {
187      if (Problem != null && MoveGenerator != null && MoveMaker != null && MoveEvaluator != null)
188        base.Prepare();
189    }
190
191    #region Events
192    protected override void OnProblemChanged() {
193      ParameterizeStochasticOperator(Problem.SolutionCreator);
194      ParameterizeStochasticOperator(Problem.Evaluator);
195      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
196      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
197        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
198      }
199      ParameterizeSolutionsCreator();
200      ParameterizeMainLoop();
201      UpdateMoveGenerator();
202      UpdateMoveParameters();
203      ParameterizeMoveEvaluators();
204      ParameterizeMoveMakers();
205      ParameterizeMoveGenerators();
206      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
207      base.OnProblemChanged();
208    }
209    protected override void Problem_SolutionCreatorChanged(object sender, EventArgs e) {
210      ParameterizeStochasticOperator(Problem.SolutionCreator);
211      ParameterizeSolutionsCreator();
212      base.Problem_SolutionCreatorChanged(sender, e);
213    }
214    protected override void Problem_EvaluatorChanged(object sender, EventArgs e) {
215      ParameterizeStochasticOperator(Problem.Evaluator);
216      ParameterizeSolutionsCreator();
217      ParameterizeMainLoop();
218      ParameterizeMoveEvaluators();
219      ParameterizeMoveMakers();
220      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
221      base.Problem_EvaluatorChanged(sender, e);
222    }
223    protected override void Problem_OperatorsChanged(object sender, EventArgs e) {
224      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
225      // This may seem pointless, but some operators already have the eventhandler registered, others don't
226      // FIXME: Is there another way to solve this problem?
227      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
228        op.MoveQualityParameter.ActualNameChanged -= new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
229        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
230      }
231      UpdateMoveGenerator();
232      UpdateMoveParameters();
233      ParameterizeMainLoop();
234      ParameterizeMoveEvaluators();
235      ParameterizeMoveMakers();
236      ParameterizeMoveGenerators();
237      base.Problem_OperatorsChanged(sender, e);
238    }
239    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
240      ParameterizeMainLoop();
241      ParameterizeMoveEvaluators();
242      ParameterizeMoveMakers();
243    }
244    private void MoveGeneratorParameter_ValueChanged(object sender, EventArgs e) {
245      UpdateMoveParameters();
246    }
247    private void MoveEvaluatorParameter_ValueChanged(object sender, EventArgs e) {
248      ParameterizeMainLoop();
249      ParameterizeMoveEvaluators();
250      ParameterizeMoveMakers();
251    }
252    private void MoveEvaluator_MoveQualityParameter_ActualNameChanged(object sender, EventArgs e) {
253      ParameterizeMainLoop();
254      ParameterizeMoveEvaluators();
255      ParameterizeMoveMakers();
256    }
257    #endregion
258
259    #region Helpers
260    [StorableHook(HookType.AfterDeserialization)]
261    private void Initialize() {
262      if (Problem != null) {
263        Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
264        foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
265          op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
266        }
267      }
268      MoveGeneratorParameter.ValueChanged += new EventHandler(MoveGeneratorParameter_ValueChanged);
269      MoveEvaluatorParameter.ValueChanged += new EventHandler(MoveEvaluatorParameter_ValueChanged);
270      InitializeAnnealingOperators();
271    }
272    private void InitializeAnnealingOperators() {
273      annealingOperators = new List<IDiscreteDoubleValueModifier>();
274      annealingOperators.AddRange(ApplicationManager.Manager.GetInstances<IDiscreteDoubleValueModifier>().OrderBy(x => x.Name));
275      ParameterizeAnnealingOperators();
276      AnnealingOperatorParameter.ValidValues.Clear();
277      foreach (IDiscreteDoubleValueModifier op in annealingOperators)
278        AnnealingOperatorParameter.ValidValues.Add(op);
279    }
280    private void UpdateMoveGenerator() {
281      IMultiMoveGenerator oldMoveGenerator = MoveGenerator;
282      MoveGeneratorParameter.ValidValues.Clear();
283      if (Problem != null) {
284        foreach (IMultiMoveGenerator generator in Problem.Operators.OfType<IMultiMoveGenerator>().OrderBy(x => x.Name))
285          MoveGeneratorParameter.ValidValues.Add(generator);
286      }
287      if (oldMoveGenerator != null) {
288        IMultiMoveGenerator newMoveGenerator = MoveGeneratorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveGenerator.GetType());
289        if (newMoveGenerator != null) MoveGenerator = newMoveGenerator;
290      }
291      if (MoveGenerator == null) {
292        ClearMoveParameters();
293      }
294    }
295    private void UpdateMoveParameters() {
296      IMoveMaker oldMoveMaker = MoveMaker;
297      ISingleObjectiveMoveEvaluator oldMoveEvaluator = MoveEvaluator;
298      ClearMoveParameters();
299      if (MoveGenerator != null) {
300        List<Type> moveTypes = MoveGenerator.GetType().GetInterfaces().Where(x => typeof(IMoveOperator).IsAssignableFrom(x)).ToList();
301        foreach (Type type in moveTypes.ToList()) {
302          if (moveTypes.Any(t => t != type && type.IsAssignableFrom(t)))
303            moveTypes.Remove(type);
304        }
305        foreach (Type type in moveTypes) {
306          var operators = Problem.Operators.Where(x => type.IsAssignableFrom(x.GetType())).OrderBy(x => x.Name);
307          foreach (IMoveMaker moveMaker in operators.OfType<IMoveMaker>())
308            MoveMakerParameter.ValidValues.Add(moveMaker);
309          foreach (ISingleObjectiveMoveEvaluator moveEvaluator in operators.OfType<ISingleObjectiveMoveEvaluator>())
310            MoveEvaluatorParameter.ValidValues.Add(moveEvaluator);
311        }
312        if (oldMoveMaker != null) {
313          IMoveMaker mm = MoveMakerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveMaker.GetType());
314          if (mm != null) MoveMaker = mm;
315        }
316        if (oldMoveEvaluator != null) {
317          ISingleObjectiveMoveEvaluator me = MoveEvaluatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveEvaluator.GetType());
318          if (me != null) MoveEvaluator = me;
319        }
320      }
321    }
322    private void ClearMoveParameters() {
323      MoveMakerParameter.ValidValues.Clear();
324      MoveEvaluatorParameter.ValidValues.Clear();
325    }
326    private void ParameterizeSolutionsCreator() {
327      SolutionsCreator.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
328      SolutionsCreator.SolutionCreatorParameter.ActualName = Problem.SolutionCreatorParameter.Name;
329    }
330    private void ParameterizeMainLoop() {
331      MainLoop.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
332      MainLoop.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
333      MainLoop.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
334      if (MoveEvaluator != null)
335        MainLoop.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
336    }
337    private void ParameterizeStochasticOperator(IOperator op) {
338      if (op is IStochasticOperator)
339        ((IStochasticOperator)op).RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
340    }
341    private void ParameterizeMoveEvaluators() {
342      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
343        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
344      }
345    }
346    private void ParameterizeMoveMakers() {
347      foreach (IMoveMaker op in Problem.Operators.OfType<IMoveMaker>()) {
348        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
349        if (MoveEvaluator != null)
350          op.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
351      }
352    }
353    private void ParameterizeAnnealingOperators() {
354      foreach (IDiscreteDoubleValueModifier op in annealingOperators) {
355        op.IndexParameter.ActualName = "Iterations";
356        op.StartIndexParameter.Value = new IntValue(0);
357        op.EndIndexParameter.ActualName = MaximumIterationsParameter.Name;
358        op.ValueParameter.ActualName = "Temperature";
359        op.StartValueParameter.ActualName = StartTemperatureParameter.Name;
360        op.EndValueParameter.ActualName = EndTemperatureParameter.Name;
361        ParameterizeStochasticOperator(op);
362      }
363    }
364    private void ParameterizeMoveGenerators() {
365      foreach (IMultiMoveGenerator op in Problem.Operators.OfType<IMultiMoveGenerator>()) {
366        op.SampleSizeParameter.ActualName = InnerIterationsParameter.Name;
367      }
368    }
369    #endregion
370  }
371}
Note: See TracBrowser for help on using the repository browser.