Free cookie consent management tool by TermsFeed Policy Generator

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

Last change on this file since 3189 was 3189, checked in by abeham, 14 years ago

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