diff --git a/eo/src/PO.h b/eo/src/PO.h index 530f2948..9e0d9487 100644 --- a/eo/src/PO.h +++ b/eo/src/PO.h @@ -30,7 +30,7 @@ #include //----------------------------------------------------------------------------- -/** PO inheriting from EO is specially designed for PSO particle.POs have got a fitness, +/** PO inheriting from EO is specially designed for particle swarm optimization particle.POs have got a fitness, which at the same time needs to be only an object with the operation less than (<) defined. A best fitness also belongs to the particle.Fitness says how good is the particle for a current iteration whereas the best fitness can be saved for diff --git a/eo/src/eoBinaryFlight.h b/eo/src/eoBinaryFlight.h index 6c95d4d3..425959e0 100644 --- a/eo/src/eoBinaryFlight.h +++ b/eo/src/eoBinaryFlight.h @@ -31,7 +31,7 @@ -/** Abstract class for binary flight. Positions are updated but are expected to be binary. +/** Abstract class for binary flight of particle swarms. Positions are updated but are expected to be binary. * A function must be used to decide, according to continuous velocities, of the * new positions (0,1 ... ?) */ diff --git a/eo/src/eoBitParticle.h b/eo/src/eoBitParticle.h index c319abe9..9e21b541 100644 --- a/eo/src/eoBitParticle.h +++ b/eo/src/eoBitParticle.h @@ -29,7 +29,7 @@ #include -/** eoBitParticle: Implementation of a bit-coded particle. +/** eoBitParticle: Implementation of a bit-coded particle (swarm optimization). * Positions and best positions are 0 or 1 but the velocity is a vector of double. */ template < class FitT> class eoBitParticle: public eoVectorParticle diff --git a/eo/src/eoConstrictedVariableWeightVelocity.h b/eo/src/eoConstrictedVariableWeightVelocity.h index 24c7c3b6..76a000ff 100644 --- a/eo/src/eoConstrictedVariableWeightVelocity.h +++ b/eo/src/eoConstrictedVariableWeightVelocity.h @@ -35,7 +35,7 @@ -/** Inertia variable weighted based velocity performer + constriction. Derivated from abstract eoVelocity, +/** Inertia variable + constriction velocity for particle swarm optimization. Derivated from abstract eoVelocity, * At step t: v(t+1)= K * ( w*v(t) + c1*r1* (xbest(t)-x(t)) + c2*r2* (gbest(t) - x(t))) * w is updated each time the velocity performer is called and K is fixed * (ci given and Ri chosen at random in [0;1]). diff --git a/eo/src/eoConstrictedVelocity.h b/eo/src/eoConstrictedVelocity.h index 904ea8d5..baac496b 100644 --- a/eo/src/eoConstrictedVelocity.h +++ b/eo/src/eoConstrictedVelocity.h @@ -34,7 +34,7 @@ //----------------------------------------------------------------------------- -/** Constricted velocity performer. Derivated from abstract eoVelocity, +/** Constricted velocity performer for particle swarm optimization. Derivated from abstract eoVelocity, * At step t+1 : v(t+1)= C * [ v(t) + c1*r1 * (xbest(t)-x(t)) + c2*r2 * (gbest(t) - x(t)) ] * C is fixed for all the particles and all the generations. * Default C = 2 * k / abs(2 - P - sqrt (P*(P-4))) diff --git a/eo/src/eoFlight.h b/eo/src/eoFlight.h index 78969050..18b550f9 100644 --- a/eo/src/eoFlight.h +++ b/eo/src/eoFlight.h @@ -30,7 +30,7 @@ #include //----------------------------------------------------------------------------- -/** Abstract class for PSO flight. +/** Abstract class for particle swarm optimization flight. * All the flights must derivated from eoFlight. */ diff --git a/eo/src/eoGaussRealWeightUp.h b/eo/src/eoGaussRealWeightUp.h index 05d33e1c..bffcb62d 100644 --- a/eo/src/eoGaussRealWeightUp.h +++ b/eo/src/eoGaussRealWeightUp.h @@ -32,7 +32,8 @@ /** - * Update an inertia weight by assigning it a Gaussian randomized value. + * Update an inertia weight by assigning it a Gaussian randomized value + * (used for the velocity in particle swarm optimization). */ class eoGaussRealWeightUp:public eoWeightUpdater { diff --git a/eo/src/eoLinearDecreasingWeightUp.h b/eo/src/eoLinearDecreasingWeightUp.h index d06bda8f..eb1af0be 100644 --- a/eo/src/eoLinearDecreasingWeightUp.h +++ b/eo/src/eoLinearDecreasingWeightUp.h @@ -31,7 +31,7 @@ /** - * Linear (inertia) weight updater. Update a weight according to: + * Linear (inertia) weight updater for particle swarm optimization. Update a weight according to: * w(t)=(w(0)-w(Nt))*(Nt -t)/Nt + w(Nt) where * t is the current generation/event * Nt is the total number of generations/event diff --git a/eo/src/eoLinearTopology.h b/eo/src/eoLinearTopology.h index ccae6dd9..a6417c25 100644 --- a/eo/src/eoLinearTopology.h +++ b/eo/src/eoLinearTopology.h @@ -34,7 +34,7 @@ /** - * One of the local best strategies. Each particle has a fixed number of neighbours, ans + * One of the local best strategies for particle swarm optimization. Each particle has a fixed number of neighbours, ans * the neighborhood is social. * The topology is never modified during the flight. */ diff --git a/eo/src/eoRandomRealWeightUp.h b/eo/src/eoRandomRealWeightUp.h index a2987df3..ff7db755 100644 --- a/eo/src/eoRandomRealWeightUp.h +++ b/eo/src/eoRandomRealWeightUp.h @@ -31,7 +31,9 @@ //----------------------------------------------------------------------------- /** - * Update an inertia weight by assigning it an (uniform) random value. + * Update an inertia weight by assigning it an (uniform) random value. + * The weight is a basic feature to evaluate the velocity of a particle in + * swarm optimization. */ class eoRandomRealWeightUp:public eoWeightUpdater { diff --git a/eo/src/eoRealParticle.h b/eo/src/eoRealParticle.h index cbf8a35d..96642c23 100644 --- a/eo/src/eoRealParticle.h +++ b/eo/src/eoRealParticle.h @@ -29,7 +29,8 @@ #include -/** eoRealParticle: Implementation of a real-coded particle. Positions, velocities and best positions are real-coded. +/** eoRealParticle: Implementation of a real-coded particle for + * particle swarm optimization. Positions, velocities and best positions are real-coded. */ template < class FitT> class eoRealParticle: public eoVectorParticle diff --git a/eo/src/eoSigBinaryFlight.h b/eo/src/eoSigBinaryFlight.h index d507e538..957bda1c 100644 --- a/eo/src/eoSigBinaryFlight.h +++ b/eo/src/eoSigBinaryFlight.h @@ -32,7 +32,7 @@ /** - * Binary flight based on the sigmoid function. Velocities are expected to be "double" + * Binary flight for particle swarm optimization based on the sigmoid function. Velocities are expected to be "double" * Consider Pi to be the i-th position of a particle and Vi to be the i-th velocity of the same particle : * if rand[0;1] < sig(Vi) (Vi <=> double) * Pi=1 diff --git a/eo/src/eoStandardFlight.h b/eo/src/eoStandardFlight.h index 31a0dad2..3d41c59d 100644 --- a/eo/src/eoStandardFlight.h +++ b/eo/src/eoStandardFlight.h @@ -31,7 +31,7 @@ -/** Standard PSO flight. Derivated from abstract eoFlight, +/** Standard flight for particle swarm optimization. Derivated from abstract eoFlight, * just adds the velocities to the current position of the particle * and invalidates its fitness */ diff --git a/eo/src/eoStandardVelocity.h b/eo/src/eoStandardVelocity.h index 70d60f24..493925a5 100644 --- a/eo/src/eoStandardVelocity.h +++ b/eo/src/eoStandardVelocity.h @@ -35,7 +35,7 @@ //----------------------------------------------------------------------------- -/** Standard PSO velocity performer. Derivated from abstract eoVelocity, +/** Standard velocity performer for particle swarm optimization. Derivated from abstract eoVelocity, * At step t: v(t+1)= v(t) + c1*r1* ( xbest(t)-x(t) ) + c2*r2* ( gbest(t) - x(t) ) * (ci given and Ri chosen at random in [0;1]). */ diff --git a/eo/src/eoStarTopology.h b/eo/src/eoStarTopology.h index 441f1f7b..58e223f2 100644 --- a/eo/src/eoStarTopology.h +++ b/eo/src/eoStarTopology.h @@ -32,7 +32,7 @@ /** - * Topology dedicated to "globest best" strategy. + * Topology dedicated to "globest best" strategy for particle swarm optimization. * All the particles of the swarm belong to the same and only social neighborhood. * The global best is stored as a protected member and updated by using the "updateNeighborhood" method. */ diff --git a/eo/src/eoVariableInertiaWeightedVelocity.h b/eo/src/eoVariableInertiaWeightedVelocity.h index 8e4c161d..e00fb316 100644 --- a/eo/src/eoVariableInertiaWeightedVelocity.h +++ b/eo/src/eoVariableInertiaWeightedVelocity.h @@ -35,7 +35,7 @@ -/** Inertia variable weighted based velocity performer. Derivated from abstract eoVelocity, +/** Inertia variable weight based velocity for particle swarm optimization. Derivated from abstract eoVelocity, * At step t: v(t+1)= w*v(t) + c1*r1* ( xbest(t)-x(t) ) + c2*r2* ( gbest(t) - x(t) ) * w is updated each time the velocity performer is called. * (ci given and Ri chosen at random in [0;1]). diff --git a/eo/src/eoVectorParticle.h b/eo/src/eoVectorParticle.h index f0a123e4..2bd0d87a 100644 --- a/eo/src/eoVectorParticle.h +++ b/eo/src/eoVectorParticle.h @@ -28,7 +28,7 @@ #include /** - * Main class for particle representation. The positions, velocities and the best positions + * Main class for particle representation of particle swarm optimization. The positions, velocities and the best positions * associated to the particle are stored as vectors. Inheriting from PO and std::vector, * tree templates arguments are required: the fitness type (which is also the type of the * particle's best fitness), the position type and the velocity type. diff --git a/eo/src/eoVelocity.h b/eo/src/eoVelocity.h index 02160d95..7b656dea 100644 --- a/eo/src/eoVelocity.h +++ b/eo/src/eoVelocity.h @@ -32,7 +32,7 @@ //----------------------------------------------------------------------------- /** - * Abstract class for PSO velocities calculation. + * Abstract class for velocities calculation (particle swarm optimization). * All the velocities must derivated from eoVelocity. */ template < class POT > class eoVelocity:public eoBF < POT &,unsigned , void > diff --git a/eo/src/eoVelocityInit.h b/eo/src/eoVelocityInit.h index dfa931dd..de98d3d9 100644 --- a/eo/src/eoVelocityInit.h +++ b/eo/src/eoVelocityInit.h @@ -32,7 +32,7 @@ #include #include -/** Abstract class for PSO velocities initilization.*/ +/** Abstract class for velocities initilization of particle swarm optimization.*/ template < class POT > class eoVelocityInit:public eoInit < POT > { public: diff --git a/eo/src/eoWeightUpdater.h b/eo/src/eoWeightUpdater.h index 7f6cb792..6adfd5f4 100644 --- a/eo/src/eoWeightUpdater.h +++ b/eo/src/eoWeightUpdater.h @@ -30,7 +30,8 @@ //----------------------------------------------------------------------------- /** - * Abstract class for (inertia) weight updater. Used inside classes extending eoVelocity. + * Abstract class for (inertia) weight updater (particle swarm optimization). + * Used inside classes extending eoVelocity. */ template < class WeightType > class eoWeightUpdater: public eoUF < WeightType &, void > {};