source: trunk/sources/HeuristicLab.Algorithms.LocalSearch/3.3/LocalSearchMainLoop.cs @ 3715

Last change on this file since 3715 was 3715, checked in by abeham, 12 years ago

#893

  • prevented exception in the algorithms when an operator parameter from the problem is missing
File size: 13.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.LocalSearch {
33  /// <summary>
34  /// An operator which represents a local search.
35  /// </summary>
36  [Item("LocalSearchMainLoop", "An operator which represents the main loop of a best improvement local search (if only a single move is generated in each iteration it is a first improvement local search).")]
37  [StorableClass]
38  public sealed class LocalSearchMainLoop : 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<IntValue> MaximumIterationsParameter {
56      get { return (ValueLookupParameter<IntValue>)Parameters["MaximumIterations"]; }
57    }
58    public ValueLookupParameter<VariableCollection> ResultsParameter {
59      get { return (ValueLookupParameter<VariableCollection>)Parameters["Results"]; }
60    }
61    public ValueLookupParameter<IOperator> MoveGeneratorParameter {
62      get { return (ValueLookupParameter<IOperator>)Parameters["MoveGenerator"]; }
63    }
64    public ValueLookupParameter<IOperator> MoveEvaluatorParameter {
65      get { return (ValueLookupParameter<IOperator>)Parameters["MoveEvaluator"]; }
66    }
67    public ValueLookupParameter<IOperator> MoveMakerParameter {
68      get { return (ValueLookupParameter<IOperator>)Parameters["MoveMaker"]; }
69    }
70    public ValueLookupParameter<IOperator> MoveAnalyzerParameter {
71      get { return (ValueLookupParameter<IOperator>)Parameters["MoveAnalyzer"]; }
72    }
73    public ValueLookupParameter<IOperator> AnalyzerParameter {
74      get { return (ValueLookupParameter<IOperator>)Parameters["Analyzer"]; }
75    }
76
77    private ScopeParameter CurrentScopeParameter {
78      get { return (ScopeParameter)Parameters["CurrentScope"]; }
79    }
80    public IScope CurrentScope {
81      get { return CurrentScopeParameter.ActualValue; }
82    }
83    #endregion
84
85    [StorableConstructor]
86    private LocalSearchMainLoop(bool deserializing) : base() { }
87    public LocalSearchMainLoop()
88      : base() {
89      Initialize();
90    }
91
92    private void Initialize() {
93      #region Create parameters
94      Parameters.Add(new ValueLookupParameter<IRandom>("Random", "A pseudo random number generator."));
95      Parameters.Add(new ValueLookupParameter<BoolValue>("Maximization", "True if the problem is a maximization problem, otherwise false."));
96      Parameters.Add(new LookupParameter<DoubleValue>("Quality", "The value which represents the quality of a solution."));
97      Parameters.Add(new ValueLookupParameter<DoubleValue>("BestKnownQuality", "The best known quality value found so far."));
98      Parameters.Add(new LookupParameter<DoubleValue>("MoveQuality", "The value which represents the quality of a move."));
99      Parameters.Add(new ValueLookupParameter<IntValue>("MaximumIterations", "The maximum number of generations which should be processed."));
100      Parameters.Add(new ValueLookupParameter<VariableCollection>("Results", "The variable collection where results should be stored."));
101
102      Parameters.Add(new ValueLookupParameter<IOperator>("MoveGenerator", "The operator that generates the moves."));
103      Parameters.Add(new ValueLookupParameter<IOperator>("MoveMaker", "The operator that performs a move and updates the quality."));
104      Parameters.Add(new ValueLookupParameter<IOperator>("MoveEvaluator", "The operator that evaluates a move."));
105
106      Parameters.Add(new ValueLookupParameter<IOperator>("MoveAnalyzer", "The operator used to analyze the moves."));
107      Parameters.Add(new ValueLookupParameter<IOperator>("Analyzer", "The operator used to analyze the solution."));
108      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope which represents a population of solutions on which the TS should be applied."));
109      #endregion
110
111      #region Create operators
112      VariableCreator variableCreator = new VariableCreator();
113      SubScopesProcessor subScopesProcessor0 = new SubScopesProcessor();
114      Assigner bestQualityInitializer = new Assigner();
115      Placeholder analyzer1 = new Placeholder();
116      ResultsCollector resultsCollector1 = new ResultsCollector();
117      ResultsCollector resultsCollector2 = new ResultsCollector();
118      SubScopesProcessor mainProcessor = new SubScopesProcessor();
119      Placeholder moveGenerator = new Placeholder();
120      UniformSubScopesProcessor moveEvaluationProcessor = new UniformSubScopesProcessor();
121      Placeholder moveEvaluator = new Placeholder();
122      IntCounter evaluatedMovesCounter = new IntCounter();
123      Placeholder moveAnalyzer = new Placeholder();
124      BestSelector bestSelector = new BestSelector();
125      RightReducer rightReducer = new RightReducer();
126      SubScopesProcessor moveMakingProcessor = new SubScopesProcessor();
127      QualityComparator qualityComparator = new QualityComparator();
128      ConditionalBranch improvesQualityBranch = new ConditionalBranch();
129      Placeholder moveMaker = new Placeholder();
130      Assigner bestQualityUpdater = new Assigner();
131      SubScopesRemover subScopesRemover = new SubScopesRemover();
132      IntCounter iterationsCounter = new IntCounter();
133      Comparator iterationsComparator = new Comparator();
134      SubScopesProcessor subScopesProcessor1 = new SubScopesProcessor();
135      Placeholder analyzer2 = new Placeholder();
136      ResultsCollector resultsCollector3 = new ResultsCollector();
137      ConditionalBranch iterationsTermination = new ConditionalBranch();
138
139      variableCreator.CollectedValues.Add(new ValueParameter<IntValue>("Iterations", new IntValue(0)));
140      variableCreator.CollectedValues.Add(new ValueParameter<DoubleValue>("BestQuality", new DoubleValue(0)));
141      variableCreator.CollectedValues.Add(new ValueParameter<IntValue>("EvaluatedMoves", new IntValue(0)));
142
143      bestQualityInitializer.Name = "Initialize BestQuality";
144      bestQualityInitializer.LeftSideParameter.ActualName = "BestQuality";
145      bestQualityInitializer.RightSideParameter.ActualName = QualityParameter.Name;
146
147      analyzer1.Name = "Analyzer (placeholder)";
148      analyzer1.OperatorParameter.ActualName = AnalyzerParameter.Name;
149
150      resultsCollector1.CopyValue = new BoolValue(false);
151      resultsCollector1.CollectedValues.Add(new LookupParameter<IntValue>("Iterations"));
152      resultsCollector1.CollectedValues.Add(new LookupParameter<DoubleValue>("Best Quality", null, "BestQuality"));
153      resultsCollector1.ResultsParameter.ActualName = ResultsParameter.Name;
154
155      resultsCollector2.CopyValue = new BoolValue(true);
156      resultsCollector2.CollectedValues.Add(new LookupParameter<IntValue>("Evaluated Moves", null, "EvaluatedMoves"));
157      resultsCollector2.ResultsParameter.ActualName = ResultsParameter.Name;
158
159      moveGenerator.Name = "MoveGenerator (placeholder)";
160      moveGenerator.OperatorParameter.ActualName = MoveGeneratorParameter.Name;
161
162      moveEvaluator.Name = "MoveEvaluator (placeholder)";
163      moveEvaluator.OperatorParameter.ActualName = MoveEvaluatorParameter.Name;
164
165      evaluatedMovesCounter.Name = "EvaluatedMoves + 1";
166      evaluatedMovesCounter.ValueParameter.ActualName = "EvaluatedMoves";
167      evaluatedMovesCounter.Increment = new IntValue(1);
168
169      moveAnalyzer.Name = "MoveAnalyzer (placeholder)";
170      moveAnalyzer.OperatorParameter.ActualName = MoveAnalyzerParameter.Name;
171
172      bestSelector.CopySelected = new BoolValue(false);
173      bestSelector.MaximizationParameter.ActualName = MaximizationParameter.Name;
174      bestSelector.NumberOfSelectedSubScopesParameter.Value = new IntValue(1);
175      bestSelector.QualityParameter.ActualName = MoveQualityParameter.Name;
176
177      qualityComparator.LeftSideParameter.ActualName = MoveQualityParameter.Name;
178      qualityComparator.RightSideParameter.ActualName = QualityParameter.Name;
179      qualityComparator.ResultParameter.ActualName = "IsBetter";
180
181      improvesQualityBranch.ConditionParameter.ActualName = "IsBetter";
182
183      moveMaker.Name = "MoveMaker (placeholder)";
184      moveMaker.OperatorParameter.ActualName = MoveMakerParameter.Name;
185
186      bestQualityUpdater.Name = "Update BestQuality";
187      bestQualityUpdater.LeftSideParameter.ActualName = "BestQuality";
188      bestQualityUpdater.RightSideParameter.ActualName = QualityParameter.Name;
189
190      subScopesRemover.RemoveAllSubScopes = true;
191
192      iterationsCounter.Name = "Iterations Counter";
193      iterationsCounter.Increment = new IntValue(1);
194      iterationsCounter.ValueParameter.ActualName = "Iterations";
195
196      iterationsComparator.Name = "Iterations >= MaximumIterations";
197      iterationsComparator.Comparison = new Comparison(ComparisonType.GreaterOrEqual);
198      iterationsComparator.LeftSideParameter.ActualName = "Iterations";
199      iterationsComparator.RightSideParameter.ActualName = MaximumIterationsParameter.Name;
200      iterationsComparator.ResultParameter.ActualName = "Terminate";
201
202      analyzer2.Name = "Analyzer (placeholder)";
203      analyzer2.OperatorParameter.ActualName = AnalyzerParameter.Name;
204
205      resultsCollector3.CopyValue = new BoolValue(true);
206      resultsCollector3.CollectedValues.Add(new LookupParameter<IntValue>("Evaluated Moves", null, "EvaluatedMoves"));
207      resultsCollector3.ResultsParameter.ActualName = ResultsParameter.Name;
208
209      iterationsTermination.Name = "Iterations Termination Condition";
210      iterationsTermination.ConditionParameter.ActualName = "Terminate";
211      #endregion
212
213      #region Create operator graph
214      OperatorGraph.InitialOperator = variableCreator;
215      variableCreator.Successor = subScopesProcessor0;
216      subScopesProcessor0.Operators.Add(bestQualityInitializer);
217      subScopesProcessor0.Successor = resultsCollector1;
218      bestQualityInitializer.Successor = analyzer1;
219      analyzer1.Successor = null;
220      resultsCollector1.Successor = resultsCollector2;
221      resultsCollector2.Successor = mainProcessor;
222      mainProcessor.Operators.Add(moveGenerator);
223      mainProcessor.Successor = iterationsCounter;
224      moveGenerator.Successor = moveEvaluationProcessor;
225      moveEvaluationProcessor.Operator = moveEvaluator;
226      moveEvaluationProcessor.Successor = moveAnalyzer;
227      moveEvaluator.Successor = evaluatedMovesCounter;
228      evaluatedMovesCounter.Successor = null;
229      moveAnalyzer.Successor = bestSelector;
230      bestSelector.Successor = rightReducer;
231      rightReducer.Successor = moveMakingProcessor;
232      moveMakingProcessor.Operators.Add(qualityComparator);
233      moveMakingProcessor.Successor = subScopesRemover;
234      subScopesRemover.Successor = null;
235      qualityComparator.Successor = improvesQualityBranch;
236      improvesQualityBranch.TrueBranch = moveMaker;
237      improvesQualityBranch.FalseBranch = null;
238      improvesQualityBranch.Successor = null;
239      moveMaker.Successor = bestQualityUpdater;
240      bestQualityUpdater.Successor = null;
241      iterationsCounter.Successor = iterationsComparator;
242      iterationsComparator.Successor = subScopesProcessor1;
243      subScopesProcessor1.Operators.Add(analyzer2);
244      subScopesProcessor1.Successor = resultsCollector3;
245      analyzer2.Successor = null;
246      resultsCollector3.Successor = iterationsTermination;
247      iterationsTermination.TrueBranch = null;
248      iterationsTermination.FalseBranch = mainProcessor;
249      #endregion
250    }
251
252    public override IOperation Apply() {
253      if (MoveGeneratorParameter.ActualValue == null || MoveEvaluatorParameter.ActualValue == null || MoveMakerParameter.ActualValue == null)
254        return null;
255      return base.Apply();
256    }
257  }
258}
Note: See TracBrowser for help on using the repository browser.