Free cookie consent management tool by TermsFeed Policy Generator

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

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

Continued work on algorithm batch processing (#947).
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  [StorableClass]
38  public sealed class SimulatedAnnealing : EngineAlgorithm {
39    #region Problem Properties
40    public override Type ProblemType {
41      get { return typeof(ISingleObjectiveProblem); }
42    }
43    public new ISingleObjectiveProblem Problem {
44      get { return (ISingleObjectiveProblem)base.Problem; }
45      set { base.Problem = value; }
46    }
47    #endregion
48
49    #region Parameter Properties
50    private ValueParameter<IntValue> SeedParameter {
51      get { return (ValueParameter<IntValue>)Parameters["Seed"]; }
52    }
53    private ValueParameter<BoolValue> SetSeedRandomlyParameter {
54      get { return (ValueParameter<BoolValue>)Parameters["SetSeedRandomly"]; }
55    }
56    private ConstrainedValueParameter<IMultiMoveGenerator> MoveGeneratorParameter {
57      get { return (ConstrainedValueParameter<IMultiMoveGenerator>)Parameters["MoveGenerator"]; }
58    }
59    private ConstrainedValueParameter<IMoveMaker> MoveMakerParameter {
60      get { return (ConstrainedValueParameter<IMoveMaker>)Parameters["MoveMaker"]; }
61    }
62    private ConstrainedValueParameter<ISingleObjectiveMoveEvaluator> MoveEvaluatorParameter {
63      get { return (ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>)Parameters["MoveEvaluator"]; }
64    }
65    private ConstrainedValueParameter<IDiscreteDoubleValueModifier> AnnealingOperatorParameter {
66      get { return (ConstrainedValueParameter<IDiscreteDoubleValueModifier>)Parameters["AnnealingOperator"]; }
67    }
68    private ValueParameter<IntValue> MaximumIterationsParameter {
69      get { return (ValueParameter<IntValue>)Parameters["MaximumIterations"]; }
70    }
71    private ValueParameter<IntValue> InnerIterationsParameter {
72      get { return (ValueParameter<IntValue>)Parameters["InnerIterations"]; }
73    }
74    private ValueParameter<DoubleValue> StartTemperatureParameter {
75      get { return (ValueParameter<DoubleValue>)Parameters["StartTemperature"]; }
76    }
77    private ValueParameter<DoubleValue> EndTemperatureParameter {
78      get { return (ValueParameter<DoubleValue>)Parameters["EndTemperature"]; }
79    }
80    #endregion
81
82    #region Properties
83    public IntValue Seed {
84      get { return SeedParameter.Value; }
85      set { SeedParameter.Value = value; }
86    }
87    public BoolValue SetSeedRandomly {
88      get { return SetSeedRandomlyParameter.Value; }
89      set { SetSeedRandomlyParameter.Value = value; }
90    }
91    public IMultiMoveGenerator MoveGenerator {
92      get { return MoveGeneratorParameter.Value; }
93      set { MoveGeneratorParameter.Value = value; }
94    }
95    public IMoveMaker MoveMaker {
96      get { return MoveMakerParameter.Value; }
97      set { MoveMakerParameter.Value = value; }
98    }
99    public ISingleObjectiveMoveEvaluator MoveEvaluator {
100      get { return MoveEvaluatorParameter.Value; }
101      set { MoveEvaluatorParameter.Value = value; }
102    }
103    public IntValue MaximumIterations {
104      get { return MaximumIterationsParameter.Value; }
105      set { MaximumIterationsParameter.Value = value; }
106    }
107    public IntValue InnerIterations {
108      get { return InnerIterationsParameter.Value; }
109      set { InnerIterationsParameter.Value = value; }
110    }
111    public DoubleValue StartTemperature {
112      get { return StartTemperatureParameter.Value; }
113      set { StartTemperatureParameter.Value = value; }
114    }
115    public DoubleValue EndTemperature {
116      get { return EndTemperatureParameter.Value; }
117      set { EndTemperatureParameter.Value = value; }
118    }
119    private RandomCreator RandomCreator {
120      get { return (RandomCreator)OperatorGraph.InitialOperator; }
121    }
122    private SolutionsCreator SolutionsCreator {
123      get { return (SolutionsCreator)RandomCreator.Successor; }
124    }
125    private SimulatedAnnealingMainLoop MainLoop {
126      get { return (SimulatedAnnealingMainLoop)SolutionsCreator.Successor; }
127    }
128
129    private List<IDiscreteDoubleValueModifier> annealingOperators;
130    private IEnumerable<IDiscreteDoubleValueModifier> AnnealingOperators {
131      get { return annealingOperators; }
132    }
133    #endregion
134
135    [StorableConstructor]
136    private SimulatedAnnealing(bool deserializing) : base() { }
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
178    public override IDeepCloneable Clone(Cloner cloner) {
179      SimulatedAnnealing clone = (SimulatedAnnealing)base.Clone(cloner);
180      clone.Initialize();
181      return clone;
182    }
183
184    public override void Prepare() {
185      base.Prepare();
186      if (Engine != null) {
187        if (Problem == null || MoveGenerator == null || MoveMaker == null || MoveEvaluator == null)
188          Engine.Prepare(null);
189      }
190    }
191
192    #region Events
193    protected override void OnProblemChanged() {
194      ParameterizeStochasticOperator(Problem.SolutionCreator);
195      ParameterizeStochasticOperator(Problem.Evaluator);
196      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
197      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
198        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
199      }
200      ParameterizeSolutionsCreator();
201      ParameterizeMainLoop();
202      UpdateMoveGenerator();
203      UpdateMoveParameters();
204      ParameterizeMoveEvaluators();
205      ParameterizeMoveMakers();
206      ParameterizeMoveGenerators();
207      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
208      base.OnProblemChanged();
209    }
210    protected override void Problem_SolutionCreatorChanged(object sender, EventArgs e) {
211      ParameterizeStochasticOperator(Problem.SolutionCreator);
212      ParameterizeSolutionsCreator();
213      base.Problem_SolutionCreatorChanged(sender, e);
214    }
215    protected override void Problem_EvaluatorChanged(object sender, EventArgs e) {
216      ParameterizeStochasticOperator(Problem.Evaluator);
217      ParameterizeSolutionsCreator();
218      ParameterizeMainLoop();
219      ParameterizeMoveEvaluators();
220      ParameterizeMoveMakers();
221      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
222      base.Problem_EvaluatorChanged(sender, e);
223    }
224    protected override void Problem_VisualizerChanged(object sender, EventArgs e) {
225      ParameterizeStochasticOperator(Problem.Visualizer);
226      ParameterizeMainLoop();
227      if (Problem.Visualizer != null) Problem.Visualizer.VisualizationParameter.ActualNameChanged += new EventHandler(Visualizer_VisualizationParameter_ActualNameChanged);
228      base.Problem_VisualizerChanged(sender, e);
229    }
230    protected override void Problem_OperatorsChanged(object sender, EventArgs e) {
231      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
232      // This may seem pointless, but some operators already have the eventhandler registered, others don't
233      // FIXME: Is there another way to solve this problem?
234      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
235        op.MoveQualityParameter.ActualNameChanged -= new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
236        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
237      }
238      UpdateMoveGenerator();
239      UpdateMoveParameters();
240      ParameterizeMainLoop();
241      ParameterizeMoveEvaluators();
242      ParameterizeMoveMakers();
243      ParameterizeMoveGenerators();
244      base.Problem_OperatorsChanged(sender, e);
245    }
246    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
247      ParameterizeMainLoop();
248      ParameterizeMoveEvaluators();
249      ParameterizeMoveMakers();
250    }
251    private void MoveGeneratorParameter_ValueChanged(object sender, EventArgs e) {
252      UpdateMoveParameters();
253    }
254    private void MoveEvaluatorParameter_ValueChanged(object sender, EventArgs e) {
255      ParameterizeMainLoop();
256      ParameterizeMoveEvaluators();
257      ParameterizeMoveMakers();
258    }
259    private void MoveEvaluator_MoveQualityParameter_ActualNameChanged(object sender, EventArgs e) {
260      ParameterizeMainLoop();
261      ParameterizeMoveEvaluators();
262      ParameterizeMoveMakers();
263    }
264    private void Visualizer_VisualizationParameter_ActualNameChanged(object sender, EventArgs e) {
265      ParameterizeMainLoop();
266    }
267    #endregion
268
269    #region Helpers
270    [StorableHook(HookType.AfterDeserialization)]
271    private void Initialize() {
272      if (Problem != null) {
273        Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
274        foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
275          op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
276        }
277      }
278      MoveGeneratorParameter.ValueChanged += new EventHandler(MoveGeneratorParameter_ValueChanged);
279      MoveEvaluatorParameter.ValueChanged += new EventHandler(MoveEvaluatorParameter_ValueChanged);
280      InitializeAnnealingOperators();
281    }
282    private void InitializeAnnealingOperators() {
283      annealingOperators = new List<IDiscreteDoubleValueModifier>();
284      if (ApplicationManager.Manager != null) {
285        annealingOperators.AddRange(ApplicationManager.Manager.GetInstances<IDiscreteDoubleValueModifier>().OrderBy(x => x.Name));
286        ParameterizeAnnealingOperators();
287      }
288      AnnealingOperatorParameter.ValidValues.Clear();
289      foreach (IDiscreteDoubleValueModifier op in annealingOperators)
290        AnnealingOperatorParameter.ValidValues.Add(op);
291    }
292    private void UpdateMoveGenerator() {
293      IMultiMoveGenerator oldMoveGenerator = MoveGenerator;
294      MoveGeneratorParameter.ValidValues.Clear();
295      if (Problem != null) {
296        foreach (IMultiMoveGenerator generator in Problem.Operators.OfType<IMultiMoveGenerator>().OrderBy(x => x.Name))
297          MoveGeneratorParameter.ValidValues.Add(generator);
298      }
299      if (oldMoveGenerator != null) {
300        IMultiMoveGenerator newMoveGenerator = MoveGeneratorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveGenerator.GetType());
301        if (newMoveGenerator != null) MoveGenerator = newMoveGenerator;
302      }
303      if (MoveGenerator == null) {
304        ClearMoveParameters();
305      }
306    }
307    private void UpdateMoveParameters() {
308      IMoveMaker oldMoveMaker = MoveMaker;
309      ISingleObjectiveMoveEvaluator oldMoveEvaluator = MoveEvaluator;
310      ClearMoveParameters();
311      if (MoveGenerator != null) {
312        List<Type> moveTypes = MoveGenerator.GetType().GetInterfaces().Where(x => typeof(IMoveOperator).IsAssignableFrom(x)).ToList();
313        foreach (Type type in moveTypes.ToList()) {
314          if (moveTypes.Any(t => t != type && type.IsAssignableFrom(t)))
315            moveTypes.Remove(type);
316        }
317        foreach (Type type in moveTypes) {
318          var operators = Problem.Operators.Where(x => type.IsAssignableFrom(x.GetType())).OrderBy(x => x.Name);
319          foreach (IMoveMaker moveMaker in operators.OfType<IMoveMaker>())
320            MoveMakerParameter.ValidValues.Add(moveMaker);
321          foreach (ISingleObjectiveMoveEvaluator moveEvaluator in operators.OfType<ISingleObjectiveMoveEvaluator>())
322            MoveEvaluatorParameter.ValidValues.Add(moveEvaluator);
323        }
324        if (oldMoveMaker != null) {
325          IMoveMaker mm = MoveMakerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveMaker.GetType());
326          if (mm != null) MoveMaker = mm;
327        }
328        if (oldMoveEvaluator != null) {
329          ISingleObjectiveMoveEvaluator me = MoveEvaluatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveEvaluator.GetType());
330          if (me != null) MoveEvaluator = me;
331        }
332      }
333    }
334    private void ClearMoveParameters() {
335      MoveMakerParameter.ValidValues.Clear();
336      MoveEvaluatorParameter.ValidValues.Clear();
337    }
338    private void ParameterizeSolutionsCreator() {
339      SolutionsCreator.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
340      SolutionsCreator.SolutionCreatorParameter.ActualName = Problem.SolutionCreatorParameter.Name;
341    }
342    private void ParameterizeMainLoop() {
343      MainLoop.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
344      MainLoop.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
345      MainLoop.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
346      if (MoveEvaluator != null)
347        MainLoop.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
348      MainLoop.VisualizerParameter.ActualName = Problem.VisualizerParameter.Name;
349      if (Problem.Visualizer != null)
350        MainLoop.VisualizationParameter.ActualName = Problem.Visualizer.VisualizationParameter.ActualName;
351    }
352    private void ParameterizeStochasticOperator(IOperator op) {
353      if (op is IStochasticOperator)
354        ((IStochasticOperator)op).RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
355    }
356    private void ParameterizeMoveEvaluators() {
357      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
358        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
359      }
360    }
361    private void ParameterizeMoveMakers() {
362      foreach (IMoveMaker op in Problem.Operators.OfType<IMoveMaker>()) {
363        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
364        if (MoveEvaluator != null)
365          op.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
366      }
367    }
368    private void ParameterizeAnnealingOperators() {
369      foreach (IDiscreteDoubleValueModifier op in annealingOperators) {
370        op.IndexParameter.ActualName = "Iterations";
371        op.StartIndexParameter.Value = new IntValue(0);
372        op.EndIndexParameter.ActualName = MaximumIterationsParameter.Name;
373        op.ValueParameter.ActualName = "Temperature";
374        op.StartValueParameter.ActualName = StartTemperatureParameter.Name;
375        op.EndValueParameter.ActualName = EndTemperatureParameter.Name;
376        ParameterizeStochasticOperator(op);
377      }
378    }
379    private void ParameterizeMoveGenerators() {
380      foreach (IMultiMoveGenerator op in Problem.Operators.OfType<IMultiMoveGenerator>()) {
381        op.SampleSizeParameter.ActualName = InnerIterationsParameter.Name;
382      }
383    }
384    #endregion
385  }
386}
Note: See TracBrowser for help on using the repository browser.