Free cookie consent management tool by TermsFeed Policy Generator

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

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

added best known quality in chart #923

File size: 15.2 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 HeuristicLab.Analysis;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Operators;
27using HeuristicLab.Optimization.Operators;
28using HeuristicLab.Parameters;
29using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
30using HeuristicLab.Selection;
31
32namespace HeuristicLab.Algorithms.SimulatedAnnealing {
33  /// <summary>
34  /// An operator which represents a simulated annealing.
35  /// </summary>
36  [Item("SimulatedAnnealingMainLoop", "An operator which represents the main loop of a simulated annealing algorithm.")]
37  [StorableClass]
38  public sealed class SimulatedAnnealingMainLoop : AlgorithmOperator {
39    #region Parameter properties
40    public ValueLookupParameter<IRandom> RandomParameter {
41      get { return (ValueLookupParameter<IRandom>)Parameters["Random"]; }
42    }
43    public ValueLookupParameter<BoolValue> MaximizationParameter {
44      get { return (ValueLookupParameter<BoolValue>)Parameters["Maximization"]; }
45    }
46    public LookupParameter<DoubleValue> QualityParameter {
47      get { return (LookupParameter<DoubleValue>)Parameters["Quality"]; }
48    }
49    public ValueLookupParameter<DoubleValue> BestKnownQualityParameter {
50      get { return (ValueLookupParameter<DoubleValue>)Parameters["BestKnownQuality"]; }
51    }
52    public LookupParameter<DoubleValue> MoveQualityParameter {
53      get { return (LookupParameter<DoubleValue>)Parameters["MoveQuality"]; }
54    }
55    public ValueLookupParameter<DoubleValue> StartTemperatureParameter {
56      get { return (ValueLookupParameter<DoubleValue>)Parameters["StartTemperature"]; }
57    }
58    public ValueLookupParameter<DoubleValue> EndTemperatureParameter {
59      get { return (ValueLookupParameter<DoubleValue>)Parameters["EndTemperature"]; }
60    }
61    public ValueLookupParameter<IntValue> InnerIterationsParameter {
62      get { return (ValueLookupParameter<IntValue>)Parameters["InnerIterations"]; }
63    }
64    public ValueLookupParameter<IntValue> MaximumIterationsParameter {
65      get { return (ValueLookupParameter<IntValue>)Parameters["MaximumIterations"]; }
66    }
67    public ValueLookupParameter<IOperator> MoveGeneratorParameter {
68      get { return (ValueLookupParameter<IOperator>)Parameters["MoveGenerator"]; }
69    }
70    public ValueLookupParameter<IOperator> MoveEvaluatorParameter {
71      get { return (ValueLookupParameter<IOperator>)Parameters["MoveEvaluator"]; }
72    }
73    public ValueLookupParameter<IOperator> MoveMakerParameter {
74      get { return (ValueLookupParameter<IOperator>)Parameters["MoveMaker"]; }
75    }
76    public ValueLookupParameter<IOperator> AnnealingOperatorParameter {
77      get { return (ValueLookupParameter<IOperator>)Parameters["AnnealingOperator"]; }
78    }
79    public ValueLookupParameter<IOperator> VisualizerParameter {
80      get { return (ValueLookupParameter<IOperator>)Parameters["Visualizer"]; }
81    }
82    public LookupParameter<IItem> VisualizationParameter {
83      get { return (LookupParameter<IItem>)Parameters["Visualization"]; }
84    }
85    public ValueLookupParameter<VariableCollection> ResultsParameter {
86      get { return (ValueLookupParameter<VariableCollection>)Parameters["Results"]; }
87    }
88    #endregion
89
90    [StorableConstructor]
91    private SimulatedAnnealingMainLoop(bool deserializing) : base() { }
92    public SimulatedAnnealingMainLoop()
93      : base() {
94      Initialize();
95    }
96
97    private void Initialize() {
98      #region Create parameters
99      Parameters.Add(new ValueLookupParameter<IRandom>("Random", "A pseudo random number generator."));
100      Parameters.Add(new ValueLookupParameter<BoolValue>("Maximization", "True if the problem is a maximization problem, otherwise false."));
101      Parameters.Add(new LookupParameter<DoubleValue>("Quality", "The value which represents the quality of a solution."));
102      Parameters.Add(new ValueLookupParameter<DoubleValue>("BestKnownQuality", "The best known quality value found so far."));
103      Parameters.Add(new LookupParameter<DoubleValue>("MoveQuality", "The value which represents the quality of a move."));
104      Parameters.Add(new ValueLookupParameter<DoubleValue>("StartTemperature", "The initial temperature."));
105      Parameters.Add(new ValueLookupParameter<DoubleValue>("EndTemperature", "The end temperature."));
106      Parameters.Add(new ValueLookupParameter<IntValue>("InnerIterations", "The amount of inner iterations (number of moves before temperature is adjusted again)."));
107      Parameters.Add(new ValueLookupParameter<IntValue>("MaximumIterations", "The maximum number of iterations which should be processed."));
108     
109      Parameters.Add(new ValueLookupParameter<IOperator>("MoveGenerator", "The operator that generates the moves."));
110      Parameters.Add(new ValueLookupParameter<IOperator>("MoveEvaluator", "The operator that evaluates a move."));
111      Parameters.Add(new ValueLookupParameter<IOperator>("MoveMaker", "The operator that performs a move and updates the quality."));
112      Parameters.Add(new ValueLookupParameter<IOperator>("AnnealingOperator", "The operator that modifies the temperature."));
113
114      Parameters.Add(new ValueLookupParameter<IOperator>("Visualizer", "The operator used to visualize solutions."));
115      Parameters.Add(new LookupParameter<IItem>("Visualization", "The item which represents the visualization of solutions."));
116      Parameters.Add(new ValueLookupParameter<VariableCollection>("Results", "The variable collection where results should be stored."));
117      #endregion
118
119      #region Create operators
120      VariableCreator variableCreator = new VariableCreator();
121      BestQualityMemorizer bestQualityMemorizer1 = new BestQualityMemorizer();
122      BestQualityMemorizer bestQualityMemorizer2 = new BestQualityMemorizer();
123      QualityDifferenceCalculator qualityDifferenceCalculator1 = new QualityDifferenceCalculator();
124      Placeholder visualizer1 = new Placeholder();
125      SubScopesProcessor sssp = new SubScopesProcessor();
126      ResultsCollector resultsCollector = new ResultsCollector();
127      Placeholder annealingOperator = new Placeholder();
128      UniformSubScopesProcessor mainProcessor = new UniformSubScopesProcessor();
129      DataTableValuesCollector valuesCollector = new DataTableValuesCollector();
130      Placeholder moveGenerator = new Placeholder();
131      UniformSubScopesProcessor moveEvaluationProcessor = new UniformSubScopesProcessor();
132      Placeholder moveEvaluator = new Placeholder();
133      ProbabilisticQualityComparator qualityComparator = new ProbabilisticQualityComparator();
134      ConditionalBranch improvesQualityBranch = new ConditionalBranch();
135      Placeholder moveMaker = new Placeholder();
136      SubScopesRemover subScopesRemover = new SubScopesRemover();
137      IntCounter iterationsCounter = new IntCounter();
138      Comparator iterationsComparator = new Comparator();
139      BestQualityMemorizer bestQualityMemorizer3 = new BestQualityMemorizer();
140      BestQualityMemorizer bestQualityMemorizer4 = new BestQualityMemorizer();
141      QualityDifferenceCalculator qualityDifferenceCalculator2 = new QualityDifferenceCalculator();
142      Placeholder visualizer2 = new Placeholder();
143      ConditionalBranch iterationsTermination = new ConditionalBranch();
144     
145      variableCreator.CollectedValues.Add(new ValueParameter<IntValue>("Iterations", new IntValue(0)));
146      variableCreator.CollectedValues.Add(new ValueParameter<DataTable>("Qualities", new DataTable("Qualities")));
147      variableCreator.CollectedValues.Add(new ValueParameter<DoubleValue>("Temperature", new DoubleValue(double.MaxValue)));
148
149      bestQualityMemorizer1.BestQualityParameter.ActualName = "BestQuality";
150      bestQualityMemorizer1.MaximizationParameter.ActualName = MaximizationParameter.Name;
151      bestQualityMemorizer1.QualityParameter.ActualName = QualityParameter.Name;
152
153      bestQualityMemorizer2.BestQualityParameter.ActualName = BestKnownQualityParameter.Name;
154      bestQualityMemorizer2.MaximizationParameter.ActualName = MaximizationParameter.Name;
155      bestQualityMemorizer2.QualityParameter.ActualName = QualityParameter.Name;
156
157      qualityDifferenceCalculator1.AbsoluteDifferenceParameter.ActualName = "AbsoluteDifferenceBestKnownToBest";
158      qualityDifferenceCalculator1.FirstQualityParameter.ActualName = BestKnownQualityParameter.Name;
159      qualityDifferenceCalculator1.RelativeDifferenceParameter.ActualName = "RelativeDifferenceBestKnownToBest";
160      qualityDifferenceCalculator1.SecondQualityParameter.ActualName = "BestQuality";
161
162      visualizer1.Name = "Visualizer (placeholder)";
163      visualizer1.OperatorParameter.ActualName = VisualizerParameter.Name;
164
165      resultsCollector.CollectedValues.Add(new LookupParameter<IntValue>("Iterations"));
166      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>(QualityParameter.Name));
167      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Best Quality") { ActualName = "BestQuality" });
168      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Best Known Quality", null, BestKnownQualityParameter.Name));
169      resultsCollector.CollectedValues.Add(new LookupParameter<DataTable>("Qualities"));
170      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Temperature"));
171      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Absolute Difference of Best Known Quality to Best Quality", null, "AbsoluteDifferenceBestKnownToBest"));
172      resultsCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Relative Difference of Best Known Quality to Best Quality", null, "RelativeDifferenceBestKnownToBest"));
173      resultsCollector.CollectedValues.Add(new LookupParameter<IItem>("Solution Visualization", null, VisualizationParameter.Name));
174     
175      annealingOperator.Name = "Annealing operator (placeholder)";
176      annealingOperator.OperatorParameter.ActualName = AnnealingOperatorParameter.Name;
177
178      valuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Quality", null, QualityParameter.Name));
179      valuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Best Quality", null, "BestQuality"));
180      valuesCollector.CollectedValues.Add(new LookupParameter<DoubleValue>("Best Known Quality", null, BestKnownQualityParameter.Name));
181      valuesCollector.DataTableParameter.ActualName = "Qualities";
182
183      moveGenerator.Name = "Move generator (placeholder)";
184      moveGenerator.OperatorParameter.ActualName = MoveGeneratorParameter.Name;
185
186      moveEvaluator.Name = "Move evaluator (placeholder)";
187      moveEvaluator.OperatorParameter.ActualName = MoveEvaluatorParameter.Name;
188
189      qualityComparator.LeftSideParameter.ActualName = MoveQualityParameter.Name;
190      qualityComparator.RightSideParameter.ActualName = QualityParameter.Name;
191      qualityComparator.ResultParameter.ActualName = "IsBetter";
192      qualityComparator.DampeningParameter.ActualName = "Temperature";
193
194      improvesQualityBranch.ConditionParameter.ActualName = "IsBetter";
195
196      moveMaker.Name = "Move maker (placeholder)";
197      moveMaker.OperatorParameter.ActualName = MoveMakerParameter.Name;
198
199      subScopesRemover.RemoveAllSubScopes = true;
200
201      iterationsCounter.Name = "Increment Iterations";
202      iterationsCounter.Increment = new IntValue(1);
203      iterationsCounter.ValueParameter.ActualName = "Iterations";
204
205      iterationsComparator.Name = "Iterations >= MaximumIterations";
206      iterationsComparator.LeftSideParameter.ActualName = "Iterations";
207      iterationsComparator.RightSideParameter.ActualName = MaximumIterationsParameter.Name;
208      iterationsComparator.ResultParameter.ActualName = "Terminate";
209      iterationsComparator.Comparison.Value = ComparisonType.GreaterOrEqual;
210
211      bestQualityMemorizer3.BestQualityParameter.ActualName = "BestQuality";
212      bestQualityMemorizer3.MaximizationParameter.ActualName = MaximizationParameter.Name;
213      bestQualityMemorizer3.QualityParameter.ActualName = QualityParameter.Name;
214
215      bestQualityMemorizer4.BestQualityParameter.ActualName = BestKnownQualityParameter.Name;
216      bestQualityMemorizer4.MaximizationParameter.ActualName = MaximizationParameter.Name;
217      bestQualityMemorizer4.QualityParameter.ActualName = QualityParameter.Name;
218
219      qualityDifferenceCalculator2.AbsoluteDifferenceParameter.ActualName = "AbsoluteDifferenceBestKnownToBest";
220      qualityDifferenceCalculator2.FirstQualityParameter.ActualName = BestKnownQualityParameter.Name;
221      qualityDifferenceCalculator2.RelativeDifferenceParameter.ActualName = "RelativeDifferenceBestKnownToBest";
222      qualityDifferenceCalculator2.SecondQualityParameter.ActualName = "BestQuality";
223
224      visualizer2.Name = "Visualizer (placeholder)";
225      visualizer2.OperatorParameter.ActualName = VisualizerParameter.Name;
226
227      iterationsTermination.Name = "Iterations termination condition";
228      iterationsTermination.ConditionParameter.ActualName = "Terminate";
229      #endregion
230
231      #region Create operator graph
232      OperatorGraph.InitialOperator = variableCreator;
233      variableCreator.Successor = bestQualityMemorizer1;
234      bestQualityMemorizer1.Successor = bestQualityMemorizer2;
235      bestQualityMemorizer2.Successor = qualityDifferenceCalculator1;
236      qualityDifferenceCalculator1.Successor = visualizer1;
237      visualizer1.Successor = sssp;
238      sssp.Operators.Add(resultsCollector);
239      resultsCollector.Successor = null;
240      sssp.Successor = annealingOperator;
241      annealingOperator.Successor = mainProcessor;
242      mainProcessor.Operator = valuesCollector;
243      mainProcessor.Successor = iterationsCounter;
244      valuesCollector.Successor = moveGenerator;
245      moveGenerator.Successor = moveEvaluationProcessor;
246      moveEvaluationProcessor.Operator = moveEvaluator;
247      moveEvaluationProcessor.Successor = subScopesRemover;
248      moveEvaluator.Successor = qualityComparator;
249      qualityComparator.Successor = improvesQualityBranch;
250      improvesQualityBranch.TrueBranch = moveMaker;
251      iterationsCounter.Successor = iterationsComparator;
252      iterationsComparator.Successor = bestQualityMemorizer3;
253      bestQualityMemorizer3.Successor = bestQualityMemorizer4;
254      bestQualityMemorizer4.Successor = qualityDifferenceCalculator2;
255      qualityDifferenceCalculator2.Successor = visualizer2;
256      visualizer2.Successor = iterationsTermination;
257      iterationsTermination.TrueBranch = null;
258      iterationsTermination.FalseBranch = annealingOperator;
259      #endregion
260    }
261  }
262}
Note: See TracBrowser for help on using the repository browser.