source: trunk/sources/HeuristicLab.Algorithms.ParticleSwarmOptimization/3.3/ParticleSwarmOptimization.cs @ 5866

Last change on this file since 5866 was 5866, checked in by epitzer, 11 years ago
  • Remove superfluous placeholders
  • Hide ParticleUpdater
  • Add CurrentVelocityBounds parameter analogous to CurrentInertia
  • Add (Current)VelocityBounds to results
  • Merge VelocityBoundsModifier directly into SwarmUpdater (#852)
File size: 18.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2011 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.Linq;
24using HeuristicLab.Analysis;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Operators;
29using HeuristicLab.Optimization;
30using HeuristicLab.Optimization.Operators;
31using HeuristicLab.Parameters;
32using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
33using HeuristicLab.PluginInfrastructure;
34using HeuristicLab.Random;
35
36namespace HeuristicLab.Algorithms.ParticleSwarmOptimization {
37  [Item("Particle Swarm Optimization", "A particle swarm optimization algorithm based on the description in Pedersen, M.E.H. (2010). PhD thesis. University of Southampton.")]
38  [Creatable("Algorithms")]
39  [StorableClass]
40  public sealed class ParticleSwarmOptimization : HeuristicOptimizationEngineAlgorithm, IStorableContent {
41
42    #region Problem Properties
43    public override Type ProblemType {
44      get { return typeof(ISingleObjectiveHeuristicOptimizationProblem); }
45    }
46    public new ISingleObjectiveHeuristicOptimizationProblem Problem {
47      get { return (ISingleObjectiveHeuristicOptimizationProblem)base.Problem; }
48      set { base.Problem = value; }
49    }
50    public MultiAnalyzer Analyzer {
51      get { return AnalyzerParameter.Value; }
52      set { AnalyzerParameter.Value = value; }
53    }
54    public IDiscreteDoubleValueModifier InertiaUpdater {
55      get { return InertiaUpdaterParameter.Value; }
56      set { InertiaUpdaterParameter.Value = value; }
57    }
58    #endregion
59
60    #region Parameter Properties
61    public IValueParameter<IntValue> SeedParameter {
62      get { return (IValueParameter<IntValue>)Parameters["Seed"]; }
63    }
64    public IValueParameter<BoolValue> SetSeedRandomlyParameter {
65      get { return (IValueParameter<BoolValue>)Parameters["SetSeedRandomly"]; }
66    }
67    public IValueParameter<IntValue> SwarmSizeParameter {
68      get { return (IValueParameter<IntValue>)Parameters["SwarmSize"]; }
69    }
70    public IValueParameter<IntValue> MaxIterationsParameter {
71      get { return (IValueParameter<IntValue>)Parameters["MaxIterations"]; }
72    }
73    public IValueParameter<DoubleValue> InertiaParameter {
74      get { return (IValueParameter<DoubleValue>)Parameters["Inertia"]; }
75    }
76    public IValueParameter<DoubleValue> PersonalBestAttractionParameter {
77      get { return (IValueParameter<DoubleValue>)Parameters["PersonalBestAttraction"]; }
78    }
79    public IValueParameter<DoubleValue> NeighborBestAttractionParameter {
80      get { return (IValueParameter<DoubleValue>)Parameters["NeighborBestAttraction"]; }
81    }
82    public IValueParameter<MultiAnalyzer> AnalyzerParameter {
83      get { return (IValueParameter<MultiAnalyzer>)Parameters["Analyzer"]; }
84    }
85    public ConstrainedValueParameter<IParticleCreator> ParticleCreatorParameter {
86      get { return (ConstrainedValueParameter<IParticleCreator>)Parameters["ParticleCreator"]; }
87    }
88    public ConstrainedValueParameter<IParticleUpdater> ParticleUpdaterParameter {
89      get { return (ConstrainedValueParameter<IParticleUpdater>)Parameters["ParticleUpdater"]; }
90    }
91    public OptionalConstrainedValueParameter<ITopologyInitializer> TopologyInitializerParameter {
92      get { return (OptionalConstrainedValueParameter<ITopologyInitializer>)Parameters["TopologyInitializer"]; }
93    }
94    public OptionalConstrainedValueParameter<ITopologyUpdater> TopologyUpdaterParameter {
95      get { return (OptionalConstrainedValueParameter<ITopologyUpdater>)Parameters["TopologyUpdater"]; }
96    }
97    public OptionalConstrainedValueParameter<IDiscreteDoubleValueModifier> InertiaUpdaterParameter {
98      get { return (OptionalConstrainedValueParameter<IDiscreteDoubleValueModifier>)Parameters["InertiaUpdater"]; }
99    }
100    public ConstrainedValueParameter<ISwarmUpdater> SwarmUpdaterParameter {
101      get { return (ConstrainedValueParameter<ISwarmUpdater>)Parameters["SwarmUpdater"]; }
102
103    }
104    #endregion
105
106    #region Properties
107
108    public string Filename { get; set; }
109
110    [Storable]
111    private BestAverageWorstQualityAnalyzer qualityAnalyzer;
112
113    [Storable]
114    private SolutionsCreator solutionsCreator;
115
116    [Storable]
117    private ParticleSwarmOptimizationMainLoop mainLoop;
118
119    public ITopologyInitializer TopologyInitializer {
120      get { return TopologyInitializerParameter.Value; }
121      set { TopologyInitializerParameter.Value = value; }
122    }
123
124    public ITopologyUpdater TopologyUpdater {
125      get { return TopologyUpdaterParameter.Value; }
126      set { TopologyUpdaterParameter.Value = value; }
127    }
128
129    public IParticleCreator ParticleCreator {
130      get { return ParticleCreatorParameter.Value; }
131      set { ParticleCreatorParameter.Value = value; }
132    }
133
134    public IParticleUpdater ParticleUpdater {
135      get { return ParticleUpdaterParameter.Value; }
136      set { ParticleUpdaterParameter.Value = value; }
137    }
138    #endregion
139
140    [StorableConstructor]
141    private ParticleSwarmOptimization(bool deserializing) : base(deserializing) { }
142    private ParticleSwarmOptimization(ParticleSwarmOptimization original, Cloner cloner)
143      : base(original, cloner) {
144      qualityAnalyzer = cloner.Clone(original.qualityAnalyzer);
145      solutionsCreator = cloner.Clone(original.solutionsCreator);
146      mainLoop = cloner.Clone(original.mainLoop);
147      Initialize();
148    }
149    public ParticleSwarmOptimization()
150      : base() {
151      Parameters.Add(new ValueParameter<IntValue>("Seed", "The random seed used to initialize the new pseudo random number generator.", new IntValue(0)));
152      Parameters.Add(new ValueParameter<BoolValue>("SetSeedRandomly", "True if the random seed should be set to a random value, otherwise false.", new BoolValue(true)));
153      Parameters.Add(new ValueParameter<IntValue>("SwarmSize", "Size of the particle swarm.", new IntValue(10)));
154      Parameters.Add(new ValueParameter<IntValue>("MaxIterations", "Maximal number of iterations.", new IntValue(1000)));
155      Parameters.Add(new ValueParameter<MultiAnalyzer>("Analyzer", "The operator used to analyze each generation.", new MultiAnalyzer()));
156      Parameters.Add(new ValueParameter<DoubleValue>("Inertia", "Inertia weight on a particle's movement (omega).", new DoubleValue(-0.2)));
157      Parameters.Add(new ValueParameter<DoubleValue>("PersonalBestAttraction", "Weight for particle's pull towards its personal best soution (phi_p).", new DoubleValue(-0.01)));
158      Parameters.Add(new ValueParameter<DoubleValue>("NeighborBestAttraction", "Weight for pull towards the neighborhood best solution or global best solution in case of a totally connected topology (phi_g).", new DoubleValue(3.7)));
159      Parameters.Add(new ConstrainedValueParameter<IParticleCreator>("ParticleCreator", "Operator that creates a new particle."));
160      Parameters.Add(new ConstrainedValueParameter<IParticleUpdater>("ParticleUpdater", "Operator that updates a particle."));
161      Parameters.Add(new OptionalConstrainedValueParameter<ITopologyInitializer>("TopologyInitializer", "Creates neighborhood description vectors."));
162      Parameters.Add(new OptionalConstrainedValueParameter<ITopologyUpdater>("TopologyUpdater", "Updates the neighborhood description vectors."));
163      Parameters.Add(new OptionalConstrainedValueParameter<IDiscreteDoubleValueModifier>("InertiaUpdater", "Updates the omega parameter."));
164      Parameters.Add(new ConstrainedValueParameter<ISwarmUpdater>("SwarmUpdater", "Encoding-specific parameter which is provided by the problem. May provide additional encoding-specific parameters, such as velocity bounds for real valued problems"));
165      ParticleUpdaterParameter.Hidden = true;
166
167      RandomCreator randomCreator = new RandomCreator();
168      VariableCreator variableCreator = new VariableCreator();
169      Assigner currentInertiaAssigner = new Assigner();
170      solutionsCreator = new SolutionsCreator();
171      SubScopesCounter subScopesCounter = new SubScopesCounter();
172      Placeholder topologyInitializerPlaceholder = new Placeholder();
173      mainLoop = new ParticleSwarmOptimizationMainLoop();
174
175      OperatorGraph.InitialOperator = randomCreator;
176
177      randomCreator.SetSeedRandomlyParameter.Value = null;
178      randomCreator.SeedParameter.Value = null;
179      randomCreator.Successor = variableCreator;
180
181      variableCreator.CollectedValues.Add(new ValueParameter<IntValue>("CurrentIteration", new IntValue(0)));
182      variableCreator.Successor = currentInertiaAssigner;
183
184      currentInertiaAssigner.Name = "CurrentInertia := Inertia";
185      currentInertiaAssigner.LeftSideParameter.ActualName = "CurrentInertia";
186      currentInertiaAssigner.RightSideParameter.ActualName = "Inertia";
187      currentInertiaAssigner.Successor = solutionsCreator;
188
189      solutionsCreator.NumberOfSolutionsParameter.ActualName = "SwarmSize";
190      ParameterizeSolutionsCreator();
191      solutionsCreator.Successor = subScopesCounter;
192
193      subScopesCounter.Name = "Initialize EvaluatedSolutions";
194      subScopesCounter.ValueParameter.ActualName = "EvaluatedSolutions";
195      subScopesCounter.Successor = topologyInitializerPlaceholder;
196
197      topologyInitializerPlaceholder.Name = "(TopologyInitializer)";
198      topologyInitializerPlaceholder.OperatorParameter.ActualName = "TopologyInitializer";
199      topologyInitializerPlaceholder.Successor = mainLoop;
200
201      mainLoop.AnalyzerParameter.ActualName = AnalyzerParameter.Name;
202      mainLoop.InertiaParameter.ActualName = "CurrentInertia";
203      mainLoop.MaxIterationsParameter.ActualName = MaxIterationsParameter.Name;
204      mainLoop.NeighborBestAttractionParameter.ActualName = NeighborBestAttractionParameter.Name;
205      mainLoop.InertiaUpdaterParameter.ActualName = InertiaUpdaterParameter.Name;
206      mainLoop.ParticleUpdaterParameter.ActualName = ParticleUpdaterParameter.Name;
207      mainLoop.PersonalBestAttractionParameter.ActualName = PersonalBestAttractionParameter.Name;
208      mainLoop.RandomParameter.ActualName = randomCreator.RandomParameter.ActualName;
209      mainLoop.SwarmSizeParameter.ActualName = SwarmSizeParameter.Name;
210      mainLoop.TopologyUpdaterParameter.ActualName = TopologyUpdaterParameter.Name;
211      mainLoop.RandomParameter.ActualName = randomCreator.RandomParameter.ActualName;
212      mainLoop.ResultsParameter.ActualName = "Results";
213
214      InitializeAnalyzers();
215      InitializeParticleCreator();
216      InitializeSwarmUpdater();
217      ParameterizeSolutionsCreator();
218      UpdateAnalyzers();
219      UpdateInertiaUpdater();
220      InitInertiaUpdater();
221      UpdateTopologyInitializer();
222      Initialize();
223      ParameterizeMainLoop();
224    }
225
226    public override IDeepCloneable Clone(Cloner cloner) {
227      return new ParticleSwarmOptimization(this, cloner);
228    }
229
230    [StorableHook(HookType.AfterDeserialization)]
231    private void AfterDeserialization() {
232      Initialize();
233    }
234
235    public override void Prepare() {
236      if (Problem != null && ParticleCreator != null && ParticleUpdater != null) {
237        base.Prepare();
238      }
239    }
240
241    #region Events
242    protected override void OnProblemChanged() {
243      UpdateAnalyzers();
244      ParameterizeAnalyzers();
245      UpdateTopologyParameters();
246      InitializeParticleCreator();
247      InitializeSwarmUpdater();
248      ParameterizeSolutionsCreator();
249      base.OnProblemChanged();
250    }
251
252    void TopologyInitializerParameter_ValueChanged(object sender, EventArgs e) {
253      this.UpdateTopologyParameters();
254    }
255    #endregion
256
257    #region Helpers
258    private void Initialize() {
259      TopologyInitializerParameter.ValueChanged += new EventHandler(TopologyInitializerParameter_ValueChanged);
260    }
261
262    private void InitializeParticleCreator() {
263      if (Problem != null) {
264        IParticleCreator oldParticleCreator = ParticleCreator;
265        ParticleCreatorParameter.ValidValues.Clear();
266        foreach (IParticleCreator Creator in Problem.Operators.OfType<IParticleCreator>().OrderBy(x => x.Name)) {
267          ParticleCreatorParameter.ValidValues.Add(Creator);
268        }
269        if (oldParticleCreator != null) {
270          IParticleCreator creator = ParticleCreatorParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldParticleCreator.GetType());
271          if (creator != null) ParticleCreator = creator;
272        }
273      }
274    }
275
276    private void InitializeAnalyzers() {
277      qualityAnalyzer = new BestAverageWorstQualityAnalyzer();
278      qualityAnalyzer.ResultsParameter.ActualName = "Results";
279      ParameterizeAnalyzers();
280    }
281
282    private void ParameterizeAnalyzers() {
283      if (Problem != null) {
284        qualityAnalyzer.MaximizationParameter.ActualName = Problem.MaximizationParameter.Name;
285        qualityAnalyzer.QualityParameter.ActualName = Problem.Evaluator.QualityParameter.ActualName;
286        qualityAnalyzer.BestKnownQualityParameter.ActualName = Problem.BestKnownQualityParameter.Name;
287      }
288    }
289
290    private void UpdateAnalyzers() {
291      Analyzer.Operators.Clear();
292      if (Problem != null) {
293        foreach (IAnalyzer analyzer in Problem.Operators.OfType<IAnalyzer>())
294          Analyzer.Operators.Add(analyzer);
295      }
296      Analyzer.Operators.Add(qualityAnalyzer);
297    }
298
299    private void InitInertiaUpdater() {
300      foreach (IDiscreteDoubleValueModifier updater in InertiaUpdaterParameter.ValidValues) {
301        updater.EndIndexParameter.ActualName = MaxIterationsParameter.Name;
302        updater.StartIndexParameter.Value = new IntValue(0);
303        updater.IndexParameter.ActualName = "CurrentIteration";
304        updater.ValueParameter.ActualName = "CurrentInertia";
305        updater.StartValueParameter.Value = new DoubleValue(1);
306        updater.EndValueParameter.Value = new DoubleValue(double.Epsilon);
307      }
308    }
309
310    private void UpdateInertiaUpdater() {
311      IDiscreteDoubleValueModifier oldInertiaUpdater = InertiaUpdater;
312      InertiaUpdaterParameter.ValidValues.Clear();
313      foreach (IDiscreteDoubleValueModifier updater in ApplicationManager.Manager.GetInstances<IDiscreteDoubleValueModifier>().OrderBy(x => x.Name)) {
314        InertiaUpdaterParameter.ValidValues.Add(updater);
315      }
316      if (oldInertiaUpdater != null) {
317        IDiscreteDoubleValueModifier updater = InertiaUpdaterParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldInertiaUpdater.GetType());
318        if (updater != null) InertiaUpdaterParameter.Value = updater;
319      }
320    }
321
322    private void UpdateTopologyInitializer() {
323      ITopologyInitializer oldTopologyInitializer = TopologyInitializer;
324      TopologyInitializerParameter.ValidValues.Clear();
325      foreach (ITopologyInitializer topologyInitializer in ApplicationManager.Manager.GetInstances<ITopologyInitializer>().OrderBy(x => x.Name)) {
326        TopologyInitializerParameter.ValidValues.Add(topologyInitializer);
327      }
328      if (oldTopologyInitializer != null && TopologyInitializerParameter.ValidValues.Any(x => x.GetType() == oldTopologyInitializer.GetType()))
329        TopologyInitializer = TopologyInitializerParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldTopologyInitializer.GetType());
330      UpdateTopologyParameters();
331    }
332
333    private void UpdateTopologyParameters() {
334      ITopologyUpdater oldTopologyUpdater = TopologyUpdater;
335      IParticleUpdater oldParticleUpdater = ParticleUpdater;
336      ClearTopologyParameters();
337      if (Problem != null) {
338        if (TopologyInitializer != null) {
339          foreach (ITopologyUpdater topologyUpdater in ApplicationManager.Manager.GetInstances<ITopologyUpdater>())
340            TopologyUpdaterParameter.ValidValues.Add(topologyUpdater);
341          foreach (IParticleUpdater particleUpdater in Problem.Operators.OfType<ILocalParticleUpdater>().OrderBy(x => x.Name))
342            ParticleUpdaterParameter.ValidValues.Add(particleUpdater);
343        } else {
344          foreach (IParticleUpdater particleUpdater in Problem.Operators.OfType<IGlobalParticleUpdater>().OrderBy(x => x.Name))
345            ParticleUpdaterParameter.ValidValues.Add(particleUpdater);
346        }
347        if (oldTopologyUpdater != null) {
348          ITopologyUpdater newTopologyUpdater = TopologyUpdaterParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldParticleUpdater.GetType());
349          if (newTopologyUpdater != null) TopologyUpdater = newTopologyUpdater;
350        }
351        if (oldParticleUpdater != null) {
352          IParticleUpdater newParticleUpdater = ParticleUpdaterParameter.ValidValues.FirstOrDefault(x => x.GetType() == oldParticleUpdater.GetType());
353          if (newParticleUpdater != null) ParticleUpdater = newParticleUpdater;
354        }
355      }
356    }
357
358    private void ClearTopologyParameters() {
359      TopologyUpdaterParameter.ValidValues.Clear();
360      ParticleUpdaterParameter.ValidValues.Clear();
361    }
362
363    private void ParameterizeSolutionsCreator() {
364      if (Problem != null) {
365        solutionsCreator.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
366        solutionsCreator.SolutionCreatorParameter.ActualName = ParticleCreatorParameter.Name;
367      }
368    }
369
370    private void ParameterizeMainLoop() {
371      if (Problem != null) {
372        mainLoop.EvaluatorParameter.ActualName = Problem.EvaluatorParameter.Name;
373      }
374    }
375
376    private void InitializeSwarmUpdater() {
377      if (Problem != null) {
378        ISwarmUpdater updater = Problem.Operators.OfType<ISwarmUpdater>().FirstOrDefault();
379        SwarmUpdaterParameter.ValidValues.Clear();
380        SwarmUpdaterParameter.ValidValues.Add(updater);
381        SwarmUpdaterParameter.Value = updater;
382      }
383    }
384    #endregion
385
386  }
387}
Note: See TracBrowser for help on using the repository browser.