Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Algorithms.TabuSearch/3.3/TabuSearch.cs @ 3280

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

Continued work on algorithm batch processing (#947).
File size: 19.7 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.TabuSearch {
35  [Item("Tabu Search", "A tabu search algorithm.")]
36  [Creatable("Algorithms")]
37  [StorableClass]
38  public sealed class TabuSearch : 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<IMoveGenerator> MoveGeneratorParameter {
57      get { return (ConstrainedValueParameter<IMoveGenerator>)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<ITabuChecker> TabuMoveEvaluatorParameter {
66      get { return (ConstrainedValueParameter<ITabuChecker>)Parameters["TabuMoveEvaluator"]; }
67    }
68    private ConstrainedValueParameter<ITabuMaker> TabuMoveMakerParameter {
69      get { return (ConstrainedValueParameter<ITabuMaker>)Parameters["TabuMoveMaker"]; }
70    }
71    private ValueParameter<IntValue> TabuTenureParameter {
72      get { return (ValueParameter<IntValue>)Parameters["TabuTenure"]; }
73    }
74    private ValueParameter<IntValue> MaximumIterationsParameter {
75      get { return (ValueParameter<IntValue>)Parameters["MaximumIterations"]; }
76    }
77    private ValueParameter<IntValue> SampleSizeParameter {
78      get { return (ValueParameter<IntValue>)Parameters["SampleSize"]; }
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 ITabuChecker TabuMoveEvaluator {
104      get { return TabuMoveEvaluatorParameter.Value; }
105      set { TabuMoveEvaluatorParameter.Value = value; }
106    }
107    public ITabuMaker TabuMoveMaker {
108      get { return TabuMoveMakerParameter.Value; }
109      set { TabuMoveMakerParameter.Value = value; }
110    }
111    public IntValue TabuTenure {
112      get { return TabuTenureParameter.Value; }
113      set { TabuTenureParameter.Value = value; }
114    }
115    public IntValue MaximumIterations {
116      get { return MaximumIterationsParameter.Value; }
117      set { MaximumIterationsParameter.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 TabuSearchMainLoop MainLoop {
126      get { return (TabuSearchMainLoop)SolutionsCreator.Successor; }
127    }
128    #endregion
129
130    public TabuSearch()
131      : base() {
132      Parameters.Add(new ValueParameter<IntValue>("Seed", "The random seed used to initialize the new pseudo random number generator.", new IntValue(0)));
133      Parameters.Add(new ValueParameter<BoolValue>("SetSeedRandomly", "True if the random seed should be set to a random value, otherwise false.", new BoolValue(true)));
134      Parameters.Add(new ConstrainedValueParameter<IMoveGenerator>("MoveGenerator", "The operator used to generate moves to the neighborhood of the current solution."));
135      Parameters.Add(new ConstrainedValueParameter<IMoveMaker>("MoveMaker", "The operator used to perform a move."));
136      Parameters.Add(new ConstrainedValueParameter<ISingleObjectiveMoveEvaluator>("MoveEvaluator", "The operator used to evaluate a move."));
137      Parameters.Add(new ConstrainedValueParameter<ITabuChecker>("TabuMoveEvaluator", "The operator to evaluate whether a move is tabu or not."));
138      Parameters.Add(new ConstrainedValueParameter<ITabuMaker>("TabuMoveMaker", "The operator used to insert attributes of a move into the tabu list."));
139      Parameters.Add(new ValueParameter<IntValue>("TabuTenure", "The length of the tabu list.", new IntValue(10)));
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", "The neighborhood size for stochastic sampling move generators", new IntValue(20)));
142
143      RandomCreator randomCreator = new RandomCreator();
144      SolutionsCreator solutionsCreator = new SolutionsCreator();
145      TabuSearchMainLoop tsMainLoop = new TabuSearchMainLoop();
146      OperatorGraph.InitialOperator = randomCreator;
147
148      randomCreator.RandomParameter.ActualName = "Random";
149      randomCreator.SeedParameter.ActualName = SeedParameter.Name;
150      randomCreator.SeedParameter.Value = null;
151      randomCreator.SetSeedRandomlyParameter.ActualName = SetSeedRandomlyParameter.Name;
152      randomCreator.SetSeedRandomlyParameter.Value = null;
153      randomCreator.Successor = solutionsCreator;
154
155      solutionsCreator.NumberOfSolutions = new IntValue(1);
156      solutionsCreator.Successor = tsMainLoop;
157
158      tsMainLoop.MoveGeneratorParameter.ActualName = MoveGeneratorParameter.Name;
159      tsMainLoop.MoveMakerParameter.ActualName = MoveMakerParameter.Name;
160      tsMainLoop.MoveEvaluatorParameter.ActualName = MoveEvaluatorParameter.Name;
161      tsMainLoop.TabuMoveEvaluatorParameter.ActualName = TabuMoveEvaluatorParameter.Name;
162      tsMainLoop.TabuMoveMakerParameter.ActualName = TabuMoveMakerParameter.Name;
163      tsMainLoop.MaximumIterationsParameter.ActualName = MaximumIterationsParameter.Name;
164      tsMainLoop.RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
165      tsMainLoop.ResultsParameter.ActualName = "Results";
166
167      Initialize();
168    }
169    [StorableConstructor]
170    private TabuSearch(bool deserializing) : base(deserializing) { }
171
172    public override IDeepCloneable Clone(Cloner cloner) {
173      TabuSearch clone = (TabuSearch)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          TabuMoveEvaluator != null && TabuMoveMaker != null)
181        base.Prepare();
182    }
183
184    #region Events
185    protected override void OnProblemChanged() {
186      ParameterizeStochasticOperator(Problem.SolutionCreator);
187      ParameterizeStochasticOperator(Problem.Evaluator);
188      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
189      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
190        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
191      }
192      foreach (ITabuChecker op in Problem.Operators.OfType<ITabuChecker>()) {
193        op.MoveTabuParameter.ActualNameChanged += new EventHandler(TabuMoveEvaluator_MoveTabuParameter_ActualNameChanged);
194      }
195      ParameterizeSolutionsCreator();
196      ParameterizeMainLoop();
197      UpdateMoveGenerator();
198      UpdateMoveParameters();
199      ParameterizeMoveGenerators();
200      ParameterizeMoveEvaluator();
201      ParameterizeMoveMaker();
202      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
203      base.OnProblemChanged();
204    }
205    protected override void Problem_SolutionCreatorChanged(object sender, EventArgs e) {
206      ParameterizeStochasticOperator(Problem.SolutionCreator);
207      ParameterizeSolutionsCreator();
208      base.Problem_SolutionCreatorChanged(sender, e);
209    }
210    protected override void Problem_EvaluatorChanged(object sender, EventArgs e) {
211      ParameterizeStochasticOperator(Problem.Evaluator);
212      ParameterizeSolutionsCreator();
213      ParameterizeMainLoop();
214      ParameterizeMoveEvaluator();
215      ParameterizeMoveMaker();
216      Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
217      base.Problem_EvaluatorChanged(sender, e);
218    }
219    protected override void Problem_VisualizerChanged(object sender, EventArgs e) {
220      ParameterizeStochasticOperator(Problem.Visualizer);
221      ParameterizeMainLoop();
222      if (Problem.Visualizer != null) Problem.Visualizer.VisualizationParameter.ActualNameChanged += new EventHandler(Visualizer_VisualizationParameter_ActualNameChanged);
223      base.Problem_VisualizerChanged(sender, e);
224    }
225    protected override void Problem_OperatorsChanged(object sender, EventArgs e) {
226      foreach (IOperator op in Problem.Operators) ParameterizeStochasticOperator(op);
227      // This may seem pointless, but some operators already have the eventhandler registered, others don't
228      // FIXME: Is there another way to solve this problem?
229      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
230        op.MoveQualityParameter.ActualNameChanged -= new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
231        op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
232      }
233      foreach (ITabuChecker op in Problem.Operators.OfType<ITabuChecker>()) {
234        op.MoveTabuParameter.ActualNameChanged -= new EventHandler(TabuMoveEvaluator_MoveTabuParameter_ActualNameChanged);
235        op.MoveTabuParameter.ActualNameChanged += new EventHandler(TabuMoveEvaluator_MoveTabuParameter_ActualNameChanged);
236      }
237      UpdateMoveGenerator();
238      UpdateMoveParameters();
239      ParameterizeMainLoop();
240      ParameterizeMoveGenerators();
241      ParameterizeMoveEvaluator();
242      ParameterizeMoveMaker();
243      base.Problem_OperatorsChanged(sender, e);
244    }
245    private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
246      ParameterizeMainLoop();
247      ParameterizeMoveEvaluator();
248      ParameterizeMoveMaker();
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      ParameterizeMoveEvaluator();
256      ParameterizeMoveMaker();
257    }
258    private void MoveEvaluator_MoveQualityParameter_ActualNameChanged(object sender, EventArgs e) {
259      ParameterizeMainLoop();
260      ParameterizeMoveEvaluator();
261      ParameterizeMoveMaker();
262    }
263    private void TabuMoveEvaluatorParameter_ValueChanged(object sender, EventArgs e) {
264      ParameterizeMainLoop();
265    }
266    private void TabuMoveEvaluator_MoveTabuParameter_ActualNameChanged(object sender, EventArgs e) {
267      ParameterizeMainLoop();
268    }
269    private void Visualizer_VisualizationParameter_ActualNameChanged(object sender, EventArgs e) {
270      ParameterizeMainLoop();
271    }
272    private void SampleSizeParameter_NameChanged(object sender, EventArgs e) {
273      ParameterizeMoveGenerators();
274    }
275    #endregion
276
277    #region Helpers
278    [StorableHook(HookType.AfterDeserialization)]
279    private void Initialize() {
280      if (Problem != null) {
281        Problem.Evaluator.QualityParameter.ActualNameChanged += new EventHandler(Evaluator_QualityParameter_ActualNameChanged);
282        foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
283          op.MoveQualityParameter.ActualNameChanged += new EventHandler(MoveEvaluator_MoveQualityParameter_ActualNameChanged);
284        }
285        if (Problem.Visualizer != null) Problem.Visualizer.VisualizationParameter.ActualNameChanged += new EventHandler(Visualizer_VisualizationParameter_ActualNameChanged);
286      }
287      MoveGeneratorParameter.ValueChanged += new EventHandler(MoveGeneratorParameter_ValueChanged);
288      MoveEvaluatorParameter.ValueChanged += new EventHandler(MoveEvaluatorParameter_ValueChanged);
289      TabuMoveEvaluatorParameter.ValueChanged += new EventHandler(TabuMoveEvaluatorParameter_ValueChanged);
290      SampleSizeParameter.NameChanged += new EventHandler(SampleSizeParameter_NameChanged);
291    }
292    private void UpdateMoveGenerator() {
293      IMoveGenerator oldMoveGenerator = MoveGenerator;
294      MoveGeneratorParameter.ValidValues.Clear();
295      if (Problem != null) {
296        foreach (IMoveGenerator generator in Problem.Operators.OfType<IMoveGenerator>().OrderBy(x => x.Name)) {
297          MoveGeneratorParameter.ValidValues.Add(generator);
298        }
299      }
300      if (oldMoveGenerator != null && MoveGeneratorParameter.ValidValues.Any(x => x.GetType() == oldMoveGenerator.GetType()))
301        MoveGenerator = MoveGeneratorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveGenerator.GetType());
302      if (MoveGenerator == null) {
303        ClearMoveParameters();
304      }
305    }
306    private void UpdateMoveParameters() {
307      IMoveMaker oldMoveMaker = MoveMaker;
308      ISingleObjectiveMoveEvaluator oldMoveEvaluator = MoveEvaluator;
309      ITabuChecker oldTabuMoveEvaluator = TabuMoveEvaluator;
310      ITabuMaker oldTabuMoveMaker = TabuMoveMaker;
311      ClearMoveParameters();
312      if (MoveGenerator != null) {
313        List<Type> moveTypes = MoveGenerator.GetType().GetInterfaces().Where(x => typeof(IMoveOperator).IsAssignableFrom(x)).ToList();
314        foreach (Type type in moveTypes.ToList()) {
315          if (moveTypes.Any(t => t != type && type.IsAssignableFrom(t)))
316            moveTypes.Remove(type);
317        }
318        foreach (Type type in moveTypes) {
319          var operators = Problem.Operators.Where(x => type.IsAssignableFrom(x.GetType())).OrderBy(x => x.Name);
320          foreach (IMoveMaker moveMaker in operators.OfType<IMoveMaker>())
321            MoveMakerParameter.ValidValues.Add(moveMaker);
322          foreach (ISingleObjectiveMoveEvaluator moveEvaluator in operators.OfType<ISingleObjectiveMoveEvaluator>())
323            MoveEvaluatorParameter.ValidValues.Add(moveEvaluator);
324          foreach (ITabuChecker tabuMoveEvaluator in operators.OfType<ITabuChecker>())
325            TabuMoveEvaluatorParameter.ValidValues.Add(tabuMoveEvaluator);
326          foreach (ITabuMaker tabuMoveMaker in operators.OfType<ITabuMaker>())
327            TabuMoveMakerParameter.ValidValues.Add(tabuMoveMaker);
328        }
329        if (oldMoveMaker != null) {
330          IMoveMaker mm = MoveMakerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveMaker.GetType());
331          if (mm != null) MoveMaker = mm;
332        }
333        if (oldMoveEvaluator != null) {
334          ISingleObjectiveMoveEvaluator me = MoveEvaluatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldMoveEvaluator.GetType());
335          if (me != null) MoveEvaluator = me;
336        }
337        if (oldTabuMoveMaker != null) {
338          ITabuMaker tmm = TabuMoveMakerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldTabuMoveMaker.GetType());
339          if (tmm != null) TabuMoveMaker = tmm;
340        }
341        if (oldTabuMoveEvaluator != null) {
342          ITabuChecker tme = TabuMoveEvaluatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldTabuMoveEvaluator.GetType());
343          if (tme != null) TabuMoveEvaluator = tme;
344        }
345      }
346    }
347    private void ClearMoveParameters() {
348      MoveMakerParameter.ValidValues.Clear();
349      MoveEvaluatorParameter.ValidValues.Clear();
350      TabuMoveEvaluatorParameter.ValidValues.Clear();
351      TabuMoveMakerParameter.ValidValues.Clear();
352    }
353    private void ParameterizeSolutionsCreator() {
354      SolutionsCreator.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
355      SolutionsCreator.SolutionCreatorParameter.ActualName = Problem.SolutionCreatorParameter.Name;
356    }
357    private void ParameterizeMainLoop() {
358      MainLoop.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
359      MainLoop.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
360      MainLoop.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
361      if (MoveEvaluator != null)
362        MainLoop.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
363      if (TabuMoveEvaluator != null)
364        MainLoop.MoveTabuParameter.ActualName = TabuMoveEvaluator.MoveTabuParameter.ActualName;
365      MainLoop.VisualizerParameter.ActualName = Problem.VisualizerParameter.Name;
366      if (Problem.Visualizer != null)
367        MainLoop.VisualizationParameter.ActualName = Problem.Visualizer.VisualizationParameter.ActualName;
368    }
369    private void ParameterizeStochasticOperator(IOperator op) {
370      if (op is IStochasticOperator)
371        ((IStochasticOperator)op).RandomParameter.ActualName = RandomCreator.RandomParameter.ActualName;
372    }
373    private void ParameterizeMoveGenerators() {
374      if (Problem != null) {
375        foreach (IMultiMoveGenerator generator in Problem.Operators.OfType<IMultiMoveGenerator>())
376          generator.SampleSizeParameter.ActualName = SampleSizeParameter.Name;
377      }
378    }
379    private void ParameterizeMoveEvaluator() {
380      foreach (ISingleObjectiveMoveEvaluator op in Problem.Operators.OfType<ISingleObjectiveMoveEvaluator>()) {
381        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
382      }
383    }
384    private void ParameterizeMoveMaker() {
385      foreach (IMoveMaker op in Problem.Operators.OfType<IMoveMaker>()) {
386        op.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
387        if (MoveEvaluator != null)
388          op.MoveQualityParameter.ActualName = MoveEvaluator.MoveQualityParameter.ActualName;
389      }
390    }
391    #endregion
392  }
393}
Note: See TracBrowser for help on using the repository browser.