Free cookie consent management tool by TermsFeed Policy Generator

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

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

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

  • adapted analyzers
File size: 17.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 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;
35using HeuristicLab.Analysis;
36
37namespace HeuristicLab.Algorithms.LocalSearch {
38  [Item("Local Search", "A local search algorithm.")]
39  [Creatable("Algorithms")]
40  [StorableClass]
41  public sealed class LocalSearch : EngineAlgorithm {
42    #region Problem Properties
43    public override Type ProblemType {
44      get { return typeof(ISingleObjectiveProblem); }
45    }
46    public new ISingleObjectiveProblem Problem {
47      get { return (ISingleObjectiveProblem)base.Problem; }
48      set { base.Problem = value; }
49    }
50    #endregion
51
52    #region Parameter Properties
53    private ValueParameter<IntValue> SeedParameter {
54      get { return (ValueParameter<IntValue>)Parameters["Seed"]; }
55    }
56    private ValueParameter<BoolValue> SetSeedRandomlyParameter {
57      get { return (ValueParameter<BoolValue>)Parameters["SetSeedRandomly"]; }
58    }
59    private ConstrainedValueParameter<IMoveGenerator> MoveGeneratorParameter {
60      get { return (ConstrainedValueParameter<IMoveGenerator>)Parameters["MoveGenerator"]; }
61    }
62    private ConstrainedValueParameter<IMoveMaker> MoveMakerParameter {
63      get { return (ConstrainedValueParameter<IMoveMaker>)Parameters["MoveMaker"]; }
64    }
65    private ConstrainedValueParameter<ISingleObjectiveMoveEvaluator> MoveEvaluatorParameter {
66      get { return (ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>)Parameters["MoveEvaluator"]; }
67    }
68    private ValueParameter<IntValue> MaximumIterationsParameter {
69      get { return (ValueParameter<IntValue>)Parameters["MaximumIterations"]; }
70    }
71    private ValueParameter<IntValue> SampleSizeParameter {
72      get { return (ValueParameter<IntValue>)Parameters["SampleSize"]; }
73    }
74    private ValueParameter<MultiAnalyzer> MoveAnalyzerParameter {
75      get { return (ValueParameter<MultiAnalyzer>)Parameters["MoveAnalyzer"]; }
76    }
77    private ValueParameter<MultiAnalyzer> AnalyzerParameter {
78      get { return (ValueParameter<MultiAnalyzer>)Parameters["Analyzer"]; }
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 IMoveGenerator 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 SampleSize {
108      get { return SampleSizeParameter.Value; }
109      set { SampleSizeParameter.Value = value; }
110    }
111    public MultiAnalyzer MoveAnalyzer {
112      get { return MoveAnalyzerParameter.Value; }
113      set { MoveAnalyzerParameter.Value = value; }
114    }
115    public MultiAnalyzer Analyzer {
116      get { return AnalyzerParameter.Value; }
117      set { AnalyzerParameter.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 LocalSearchMainLoop MainLoop {
126      get { return (LocalSearchMainLoop)SolutionsCreator.Successor; }
127    }
128    private BestAverageWorstQualityAnalyzer moveQualityAnalyzer;
129    #endregion
130
131    [StorableConstructor]
132    private LocalSearch(bool deserializing) : base(deserializing) { }
133    public LocalSearch()
134      : base() {
135      Parameters.Add(new ValueParameter<IntValue>("Seed", "The random seed used to initialize the new pseudo random number generator.", new IntValue(0)));
136      Parameters.Add(new ValueParameter<BoolValue>("SetSeedRandomly", "True if the random seed should be set to a random value, otherwise false.", new BoolValue(true)));
137      Parameters.Add(new ConstrainedValueParameter<IMoveGenerator>("MoveGenerator", "The operator used to generate moves to the neighborhood of the current solution."));
138      Parameters.Add(new ConstrainedValueParameter<IMoveMaker>("MoveMaker", "The operator used to perform a move."));
139      Parameters.Add(new ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>("MoveEvaluator", "The operator used to evaluate a move."));
140      Parameters.Add(new ValueParameter<IntValue>("MaximumIterations", "The maximum number of generations which should be processed.", new IntValue(1000)));
141      Parameters.Add(new ValueParameter<IntValue>("SampleSize", "Number of moves that MultiMoveGenerators should create. This is ignored for Exhaustive- and SingleMoveGenerators.", new IntValue(100)));
142      Parameters.Add(new ValueParameter<MultiAnalyzer>("MoveAnalyzer", "The operator used to analyze the moves.", new MultiAnalyzer()));
143      Parameters.Add(new ValueParameter<MultiAnalyzer>("Analyzer", "The operator used to analyze the solution.", new MultiAnalyzer()));
144     
145      RandomCreator randomCreator = new RandomCreator();
146      SolutionsCreator solutionsCreator = new SolutionsCreator();
147      LocalSearchMainLoop lsMainLoop = new LocalSearchMainLoop();
148      OperatorGraph.InitialOperator = randomCreator;
149
150      randomCreator.RandomParameter.ActualName = "Random";
151      randomCreator.SeedParameter.ActualName = SeedParameter.Name;
152      randomCreator.SeedParameter.Value = null;
153      randomCreator.SetSeedRandomlyParameter.ActualName = SetSeedRandomlyParameter.Name;
154      randomCreator.SetSeedRandomlyParameter.Value = null;
155      randomCreator.Successor = solutionsCreator;
156
157      solutionsCreator.NumberOfSolutions = new IntValue(1);
158      solutionsCreator.Successor = lsMainLoop;
159
160      lsMainLoop.MoveGeneratorParameter.ActualName = MoveGeneratorParameter.Name;
161      lsMainLoop.MoveMakerParameter.ActualName = MoveMakerParameter.Name;
162      lsMainLoop.MoveEvaluatorParameter.ActualName = MoveEvaluatorParameter.Name;
163      lsMainLoop.MaximumIterationsParameter.ActualName = MaximumIterationsParameter.Name;
164      lsMainLoop.RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
165      lsMainLoop.ResultsParameter.ActualName = "Results";
166      lsMainLoop.MoveAnalyzerParameter.ActualName = MoveAnalyzerParameter.Name;
167      lsMainLoop.AnalyzerParameter.ActualName = AnalyzerParameter.Name;
168
169      Initialize();
170    }
171
172    public override IDeepCloneable Clone(Cloner cloner) {
173      LocalSearch clone = (LocalSearch)base.Clone(cloner);
174      clone.Initialize();
175      return clone;
176    }
177
178    public override void Prepare() {
179      if (Problem != null && MoveGenerator != null && MoveMaker != null && MoveEvaluator != null)
180        base.Prepare();
181    }
182
183    #region Events
184    protected override void OnProblemChanged() {
185      ParameterizeStochasticOperator(Problem.SolutionCreator);
186      ParameterizeStochasticOperator(Problem.Evaluator);
187      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
188      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
189        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
190      }
191      ParameterizeSolutionsCreator();
192      ParameterizeMainLoop();
193      ParameterizeMoveEvaluators();
194      ParameterizeMoveMakers();
195      ParameterizeAnalyzers();
196      UpdateMoveGenerator();
197      UpdateMoveParameters();
198      UpdateAnalyzers();
199      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
200      base.OnProblemChanged();
201    }
202    protected override void Problem_SolutionCreatorChanged(object sender, EventArgs e) {
203      ParameterizeStochasticOperator(Problem.SolutionCreator);
204      ParameterizeSolutionsCreator();
205      base.Problem_SolutionCreatorChanged(sender, e);
206    }
207    protected override void Problem_EvaluatorChanged(object sender, EventArgs e) {
208      ParameterizeStochasticOperator(Problem.Evaluator);
209      ParameterizeSolutionsCreator();
210      ParameterizeMainLoop();
211      ParameterizeMoveEvaluators();
212      ParameterizeMoveMakers();
213      ParameterizeAnalyzers();
214      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
215      base.Problem_EvaluatorChanged(sender, e);
216    }
217    protected override void Problem_OperatorsChanged(object sender, EventArgs e) {
218      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
219      // This may seem pointless, but some operators already have the eventhandler registered, others don't
220      // FIXME: Is there another way to solve this problem?
221      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
222        op.MoveQualityParameter.ActualNameChanged -= new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
223        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
224      }
225      UpdateMoveGenerator();
226      UpdateMoveParameters();
227      UpdateAnalyzers();
228      ParameterizeMainLoop();
229      ParameterizeMoveEvaluators();
230      ParameterizeMoveMakers();
231      ParameterizeAnalyzers();
232      base.Problem_OperatorsChanged(sender, e);
233    }
234    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
235      ParameterizeMainLoop();
236      ParameterizeMoveEvaluators();
237      ParameterizeMoveMakers();
238    }
239    private void MoveGeneratorParameter_ValueChanged(object sender, EventArgs e) {
240      UpdateMoveParameters();
241    }
242    private void MoveEvaluatorParameter_ValueChanged(object sender, EventArgs e) {
243      ParameterizeMainLoop();
244      ParameterizeMoveEvaluators();
245      ParameterizeMoveMakers();
246      ParameterizeAnalyzers();
247    }
248    private void MoveEvaluator_MoveQualityParameter_ActualNameChanged(object sender, EventArgs e) {
249      ParameterizeMainLoop();
250      ParameterizeMoveEvaluators();
251      ParameterizeMoveMakers();
252      ParameterizeAnalyzers();
253    }
254    #endregion
255
256    #region Helpers
257    [StorableHook(HookType.AfterDeserialization)]
258    private void Initialize() {
259      InitializeAnalyzers();
260      UpdateAnalyzers();
261      if (Problem != null) {
262        Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
263        foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
264          op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
265        }
266      }
267      MoveGeneratorParameter.ValueChanged += new EventHandler(MoveGeneratorParameter_ValueChanged);
268      MoveEvaluatorParameter.ValueChanged += new EventHandler(MoveEvaluatorParameter_ValueChanged);
269    }
270    private void InitializeAnalyzers() {
271      moveQualityAnalyzer = new BestAverageWorstQualityAnalyzer();
272      ParameterizeAnalyzers();
273    }
274    private void UpdateMoveGenerator() {
275      IMoveGenerator oldMoveGenerator = MoveGenerator;
276      MoveGeneratorParameter.ValidValues.Clear();
277      if (Problem != null) {
278        foreach (IMoveGenerator generator in Problem.Operators.OfType<IMoveGenerator>().OrderBy(x => x.Name))
279          MoveGeneratorParameter.ValidValues.Add(generator);
280      }
281      if (oldMoveGenerator != null) {
282        IMoveGenerator newMoveGenerator = MoveGeneratorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveGenerator.GetType());
283        if (newMoveGenerator != null) MoveGenerator = newMoveGenerator;
284      }
285      if (MoveGenerator == null) {
286        ClearMoveParameters();
287      }
288    }
289    private void UpdateMoveParameters() {
290      IMoveMaker oldMoveMaker = MoveMaker;
291      ISingleObjectiveMoveEvaluator oldMoveEvaluator = MoveEvaluator;
292      ClearMoveParameters();
293      if (MoveGenerator != null) {
294        List<Type> moveTypes = MoveGenerator.GetType().GetInterfaces().Where(x => typeof(IMoveOperator).IsAssignableFrom(x)).ToList();
295        foreach (Type type in moveTypes.ToList()) {
296          if (moveTypes.Any(t => t != type && type.IsAssignableFrom(t)))
297            moveTypes.Remove(type);
298        }
299        foreach (Type type in moveTypes) {
300          var operators = Problem.Operators.Where(x => type.IsAssignableFrom(x.GetType())).OrderBy(x => x.Name);
301          foreach (IMoveMaker moveMaker in operators.OfType<IMoveMaker>())
302            MoveMakerParameter.ValidValues.Add(moveMaker);
303          foreach (ISingleObjectiveMoveEvaluator moveEvaluator in operators.OfType<ISingleObjectiveMoveEvaluator>())
304            MoveEvaluatorParameter.ValidValues.Add(moveEvaluator);
305        }
306        if (oldMoveMaker != null) {
307          IMoveMaker mm = MoveMakerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveMaker.GetType());
308          if (mm != null) MoveMaker = mm;
309        }
310        if (oldMoveEvaluator != null) {
311          ISingleObjectiveMoveEvaluator me = MoveEvaluatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveEvaluator.GetType());
312          if (me != null) MoveEvaluator = me;
313        }
314      }
315    }
316    private void UpdateAnalyzers() {
317      Analyzer.Operators.Clear();
318      MoveAnalyzer.Operators.Clear();
319      MoveAnalyzer.Operators.Add(moveQualityAnalyzer);
320      if (Problem != null) {
321        foreach (IAnalyzer analyzer in Problem.Operators.OfType<IAnalyzer>().OrderBy(x => x.Name))
322          Analyzer.Operators.Add(analyzer);
323      }
324    }
325    private void ClearMoveParameters() {
326      MoveMakerParameter.ValidValues.Clear();
327      MoveEvaluatorParameter.ValidValues.Clear();
328    }
329    private void ParameterizeSolutionsCreator() {
330      SolutionsCreator.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
331      SolutionsCreator.SolutionCreatorParameter.ActualName = Problem.SolutionCreatorParameter.Name;
332    }
333    private void ParameterizeMainLoop() {
334      MainLoop.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
335      MainLoop.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
336      MainLoop.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
337      if (MoveEvaluator != null)
338        MainLoop.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
339    }
340    private void ParameterizeStochasticOperator(IOperator op) {
341      if (op is IStochasticOperator)
342        ((IStochasticOperator)op).RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
343    }
344    private void ParameterizeMoveEvaluators() {
345      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
346        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
347      }
348    }
349    private void ParameterizeMoveMakers() {
350      foreach (IMoveMaker op in Problem.Operators.OfType<IMoveMaker>()) {
351        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
352        if (MoveEvaluator != null)
353          op.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
354      }
355    }
356    private void ParameterizeAnalyzers() {
357      moveQualityAnalyzer.ResultsParameter.ActualName = "Results";
358      if (Problem != null) {
359        moveQualityAnalyzer.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
360        if (MoveEvaluator != null)
361          moveQualityAnalyzer.QualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
362        moveQualityAnalyzer.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
363      }
364    }
365    #endregion
366  }
367}
Note: See TracBrowser for help on using the repository browser.