Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PSO/HeuristicLab.Algorithms.ParticleSwarmOptimization/3.3/ParticleUpdater.cs @ 5606

Last change on this file since 5606 was 5410, checked in by mkofler, 14 years ago

#852: Realized code cleanup as described in the reviewer comments by Andreas Beham.

File size: 5.7 KB
RevLine 
[3742]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
[5034]22using HeuristicLab.Common;
[4068]23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Encodings.RealVectorEncoding;
[3682]26using HeuristicLab.Operators;
27using HeuristicLab.Parameters;
[5033]28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
[3682]29
30namespace HeuristicLab.Algorithms.ParticleSwarmOptimization {
[5034]31
32  [StorableClass]
[5209]33  public abstract class ParticleUpdater : SingleSuccessorOperator, IParticleUpdater {
[5033]34
[3682]35    #region Parameter properties
[5410]36    public ILookupParameter<IRandom> RandomParameter {
37      get { return (ILookupParameter<IRandom>)Parameters["Random"]; }
[3682]38    }
[5410]39    public ILookupParameter<RealVector> PointParameter {
40      get { return (ILookupParameter<RealVector>)Parameters["Point"]; }
[3682]41    }
[5410]42    public ILookupParameter<RealVector> VelocityParameter {
43      get { return (ILookupParameter<RealVector>)Parameters["Velocity"]; }
[3682]44    }
[5410]45    public ILookupParameter<RealVector> PersonalBestPointParameter {
46      get { return (ILookupParameter<RealVector>)Parameters["PersonalBestPoint"]; }
[3682]47    }
[5410]48    public ILookupParameter<RealVector> BestNeighborPointParameter {
49      get { return (ILookupParameter<RealVector>)Parameters["BestNeighborPoint"]; }
[5209]50    }
[5410]51    public ILookupParameter<RealVector> BestPointParameter {
52      get { return (ILookupParameter<RealVector>)Parameters["BestPoint"]; }
[3682]53    }
[5410]54    public ILookupParameter<DoubleMatrix> BoundsParameter {
55      get { return (ILookupParameter<DoubleMatrix>)Parameters["Bounds"]; }
[5033]56    }
[5410]57    public ILookupParameter<DoubleMatrix> VelocityBoundsParameter {
58      get { return (ILookupParameter<DoubleMatrix>)Parameters["VelocityBounds"]; }
[5033]59    }
[5410]60    public ILookupParameter<DoubleValue> OmegaParameter {
61      get { return (ILookupParameter<DoubleValue>)Parameters["Omega"]; }
[5033]62    }
[5410]63    public ILookupParameter<DoubleValue> Phi_PParameter {
64      get { return (ILookupParameter<DoubleValue>)Parameters["Phi_P"]; }
[5033]65    }
[5410]66    public ILookupParameter<DoubleValue> Phi_GParameter {
67      get { return (ILookupParameter<DoubleValue>)Parameters["Phi_G"]; }
[5033]68    }
69    #endregion
[3719]70
[5033]71    #region Parameter Values
72    public IRandom Random {
73      get { return RandomParameter.ActualValue; }
[3719]74    }
[5033]75    public RealVector Point {
[5034]76      get { return PointParameter.ActualValue; }
77      set { PointParameter.ActualValue = value; }
[5033]78    }
79    public RealVector Velocity {
80      get { return VelocityParameter.ActualValue; }
81      set { VelocityParameter.ActualValue = value; }
82    }
83    public RealVector PersonalBestPoint {
84      get { return PersonalBestPointParameter.ActualValue; }
85    }
86    public RealVector BestPoint {
87      get { return BestPointParameter.ActualValue; }
88    }
[5209]89    public RealVector BestNeighborPoint {
90      get { return BestNeighborPointParameter.ActualValue; }
91    }
[5033]92    public DoubleMatrix Bounds {
[5034]93      get { return BoundsParameter.ActualValue; }
[5033]94    }
95    public DoubleMatrix VelocityBounds {
96      get { return VelocityBoundsParameter.ActualValue; }
97    }
[5410]98
99    public DoubleValue Omega {
100      get { return OmegaParameter.ActualValue; }
[5033]101    }
[5410]102    public DoubleValue Phi_P {
103      get { return Phi_PParameter.ActualValue; }
[5033]104    }
[5410]105    public DoubleValue Phi_G {
106      get { return Phi_GParameter.ActualValue; }
[5033]107    }
[3682]108    #endregion
109
[5209]110    public override bool CanChangeName {
111      get { return false; }
112    }
113
[5033]114    #region Construction & Cloning
115
116    [StorableConstructor]
117    protected ParticleUpdater(bool deserializing) : base(deserializing) { }
118    protected ParticleUpdater(ParticleUpdater original, Cloner cloner)
119      : base(original, cloner) {
120    }
121
[3682]122    public ParticleUpdater()
123      : base() {
[5033]124      Parameters.Add(new LookupParameter<IRandom>("Random", "Random number generator."));
125      Parameters.Add(new LookupParameter<RealVector>("Point", "Particle's current position"));
126      Parameters.Add(new LookupParameter<RealVector>("Velocity", "Particle's current velocity."));
127      Parameters.Add(new LookupParameter<RealVector>("PersonalBestPoint", "Particle's personal best position"));
128      Parameters.Add(new LookupParameter<RealVector>("BestPoint", "Global best position"));
[5209]129      Parameters.Add(new LookupParameter<RealVector>("BestNeighborPoint", "Best neighboring position"));
[5033]130      Parameters.Add(new LookupParameter<DoubleMatrix>("Bounds", "The lower and upper bounds for each dimension of the position vector for the current problem."));
131      Parameters.Add(new LookupParameter<DoubleMatrix>("VelocityBounds", "Upper and lower bounds for the particle's velocity vector."));
132      Parameters.Add(new LookupParameter<DoubleValue>("Omega", "The weight for the particle's velocity vector."));
133      Parameters.Add(new LookupParameter<DoubleValue>("Phi_P", "The weight for the particle's personal best position."));
134      Parameters.Add(new LookupParameter<DoubleValue>("Phi_G", "The weight for the global best position."));
[3682]135    }
136
[5033]137    #endregion
[3682]138  }
139}
Note: See TracBrowser for help on using the repository browser.