Added new lesson (6) dedicated to the PSO. Also changed a few things into the PSO-dedicated components (constructors)

eo/tutorial/CMakeLists.txt

@@ -4,6 +4,6 @@
 ### 1) Where must cmake go now ?
 ######################################################################################
 
-SUBDIRS(Lesson1 Lesson2 Lesson3 Lesson4 Lesson5)
+SUBDIRS(Lesson1 Lesson2 Lesson3 Lesson4 Lesson5 Lesson6)
 
 ######################################################################################

eo/tutorial/Lesson6/BinaryPSO.cpp

@@ -0,0 +1,182 @@
+//-----------------------------------------------------------------------------
+// BinaryPSO.cpp
+//-----------------------------------------------------------------------------
+//*
+// An instance of a VERY simple Real-coded binary Particle Swarm Optimization Algorithm
+//
+//-----------------------------------------------------------------------------
+#include <stdexcept>
+#include <iostream>
+#include <sstream>
+
+#include <eo>
+
+// Use functions from namespace std
+using namespace std;
+
+//-----------------------------------------------------------------------------
+typedef eoMinimizingFitness FitT;
+typedef eoBitParticle < FitT > Particle;
+//-----------------------------------------------------------------------------
+
+
+// EVALFUNC
+//-----------------------------------------------------------------------------
+// Just a simple function that takes binary value of a chromosome and sets
+// the fitness
+double binary_value (const Particle & _particle)
+{
+    double sum = 0;
+    for (unsigned i = 0; i < _particle.size(); i++)
+        sum +=_particle[i];
+    return (sum);
+}
+
+
+
+void main_function(int argc, char **argv)
+{
+// PARAMETRES
+ // all parameters are hard-coded!
+ 	const unsigned int SEED = 42;	// seed for random number generator
+ 	
+ 	const unsigned int MAX_GEN=500;
+    const unsigned int VEC_SIZE = 10;
+    const unsigned int POP_SIZE = 20;
+    const unsigned int NEIGHBORHOOD_SIZE= 3;
+
+    const double VELOCITY_INIT_MIN= -1;
+    const double VELOCITY_INIT_MAX= 1;
+    
+    const double VELOCITY_MIN= -1.5;
+    const double VELOCITY_MAX= 1.5;
+    
+    const double INERTIA= 1;
+    const double LEARNING_FACTOR1= 1.7;
+    const double LEARNING_FACTOR2= 2.3;
+
+
+//////////////////////////
+//  RANDOM SEED
+//////////////////////////
+  //reproducible random seed: if you don't change SEED above,
+  // you'll aways get the same result, NOT a random run
+  	rng.reseed(SEED);
+
+   
+/// SWARM
+ 	// population <=> swarm 
+    eoPop<Particle> pop;
+
+/// EVALUATION
+	// Evaluation: from a plain C++ fn to an EvalFunc Object
+    eoEvalFuncPtr<Particle, double, const Particle& > eval(  binary_value );
+
+
+///////////////
+/// TOPOLOGY
+//////////////
+	// ring topology
+    eoRingTopology<Particle> topology(NEIGHBORHOOD_SIZE);
+    
+    
+/////////////////////
+// INITIALIZATION
+////////////////////
+    // position initialization
+    eoUniformGenerator<bool> uGen;
+    eoInitFixedLength < Particle > random (VEC_SIZE, uGen);
+	pop.append (POP_SIZE, random);
+	
+    // velocities initialization component
+    eoUniformGenerator < double >sGen (VELOCITY_INIT_MIN, VELOCITY_INIT_MAX);
+    eoVelocityInitFixedLength < Particle > veloRandom (VEC_SIZE, sGen);
+
+    // first best position initialization component
+    eoFirstIsBestInit < Particle > localInit;
+
+	// Create an eoInitialier that:
+	// 		- performs a first evaluation of the particles
+	//  	- initializes the velocities
+	//  	- the first best positions of each particle
+	// 		- setups the topology
+    eoInitializer <Particle> fullInit(eval,veloRandom,localInit,topology,pop);
+    
+   // Full initialization here to be able to print the initial population
+   // Else: give the "init" component in the eoEasyPSO constructor
+   fullInit();
+    
+/////////////
+// OUTPUT
+////////////
+// sort pop before printing it!
+  	pop.sort();
+  	
+  	// Print (sorted) the initial population (raw printout)
+    cout << "INITIAL POPULATION:" << endl;
+    for (unsigned i = 0; i < pop.size(); ++i)
+         cout <<  "\t best fit=" <<  pop[i] <<  endl;
+
+ 
+///////////////
+/// VELOCITY
+//////////////
+    // Create the bounds for the velocity not go to far away
+    eoRealVectorBounds bnds(VEC_SIZE,VELOCITY_MIN,VELOCITY_MAX);
+
+    // the velocity itself that needs the topology and a few constants
+    eoStandardVelocity <Particle> velocity (topology,INERTIA,LEARNING_FACTOR1,LEARNING_FACTOR2,bnds);
+
+
+///////////////
+/// FLIGHT
+//////////////
+    // Binary flight based on sigmoid function
+    eoSigBinaryFlight <Particle> flight;
+
+
+////////////////////////
+/// STOPPING CRITERIA
+///////////////////////
+    // the algo will run for MAX_GEN iterations
+    eoGenContinue <Particle> genCont (MAX_GEN);
+
+
+// GENERATION
+  /////////////////////////////////////////
+  // the algorithm
+  ////////////////////////////////////////
+  // standard PSO requires
+  // stopping criteria, evaluation,velocity, flight
+  
+    eoEasyPSO<Particle> pso(genCont, eval, velocity, flight);
+
+    // Apply the algo to the swarm - that's it!
+    pso(pop);
+
+// OUTPUT
+  // Print (sorted) intial population
+	 pop.sort();
+	 cout << "FINAL POPULATION:" << endl;
+  	 for (unsigned i = 0; i < pop.size(); ++i)
+        cout <<  "\t best fit=" <<  pop[i] <<  endl;
+
+}
+
+
+// A main that catches the exceptions
+
+int main(int argc, char **argv)
+{	
+    try
+    {
+        main_function(argc, argv);
+    }
+    catch(exception& e)
+    {
+        cout << "Exception: " << e.what() << '\n';
+    }
+
+    return 1;
+}
+//-----------------------------------------------------------------------------

eo/tutorial/Lesson6/CMakeLists.txt

@@ -0,0 +1,58 @@
+
+######################################################################################
+### 1) Include the sources
+######################################################################################
+
+INCLUDE_DIRECTORIES(${EO_SOURCE_DIR}/src)
+
+######################################################################################
+
+
+######################################################################################
+### 2) Specify where CMake can find the libraries
+######################################################################################
+
+IF(NOT WIN32 OR CYGWIN)  
+  LINK_DIRECTORIES(${EO_BINARY_DIR}/lib)
+ENDIF(NOT WIN32 OR CYGWIN)
+
+# especially for Visual Studio
+IF(WIN32 AND NOT CYGWIN)  
+  	LINK_DIRECTORIES(${EO_BINARY_DIR}\\lib\\${CMAKE_BUILD_TYPE})
+ENDIF(WIN32 AND NOT CYGWIN) 
+
+######################################################################################
+
+
+######################################################################################
+### 3) Define your targets
+######################################################################################
+
+ADD_EXECUTABLE(BinaryPSO BinaryPSO.cpp) 
+ADD_EXECUTABLE(RealPSO RealPSO.cpp) 
+
+######################################################################################
+
+
+######################################################################################
+### 4) Optionnal
+######################################################################################
+
+SET(BINARYPSO_VERSION ${GLOBAL_VERSION})
+SET_TARGET_PROPERTIES(BinaryPSO PROPERTIES VERSION "${BINARYPSO_VERSION}")
+
+SET(REALPSO_VERSION ${GLOBAL_VERSION})
+SET_TARGET_PROPERTIES(RealPSO PROPERTIES VERSION "${REALPSO_VERSION}")
+
+######################################################################################
+
+
+######################################################################################
+### 5) Link the librairies for the targets
+######################################################################################
+
+TARGET_LINK_LIBRARIES(BinaryPSO eo eoutils)
+TARGET_LINK_LIBRARIES(RealPSO eo eoutils)
+
+######################################################################################
+

eo/tutorial/Lesson6/Makefile.am

@@ -0,0 +1,19 @@
+
+noinst_PROGRAMS		= BinaryPSO RealPSO
+
+
+SecondBitEA_SOURCES	= BinaryPSO.cpp
+
+SecondRealEA_SOURCES	= RealPSO.cpp
+
+
+noinst_HEADERS		= 
+
+extra_DIST		= Makefile.simple
+
+
+LDADD			= -L$(top_builddir)/src 
+
+LIBS			=  -leoutils -leo
+
+INCLUDES		= -I$(top_srcdir)/src

eo/tutorial/Lesson6/Makefile.simple

@@ -0,0 +1,31 @@
+### This Makefile is part of the tutorial of the EO library
+# Unlike other Makefiles in EO, it is not using the automake/autoconf 
+# so that it stays easy to understant (you are in the tutorial, remember!)
+# MS, Oct. 2002
+
+# if you use this Makefile as a starting point for another application
+# you might need to modify the following
+DIR_EO = ../../src
+
+.SUFFIXES: .cpp
+
+# Warning: $(CXX) in Linux (RedHat and Mandrake at least) is g++
+# However, if you are using this Makefile within xemacs, 
+# and have problems with the interpretation of the output (and its colors)
+# then you should use c++ instead (make CXX=c++ will do)
+
+.cpp: ; $(CXX)  -DPACKAGE=\"eo\" -DVERSION=\"0.9.3\" -I. -I$(DIR_EO) -Wall -g -pg  -o $@  $*.cpp 
+#$(DIR_EO)/utils/libeoutils.a $(DIR_EO)/libeo.a 
+
+.cpp.o: ; $(CXX) -DPACKAGE=\"eo\" -DVERSION=\"0.9.3\" -I. -I$(DIR_EO) -Wall -g -c -pg $*.cpp
+
+PSO = BinaryPSO RealPSO
+
+ALL = $(PSO)
+
+lesson6 : $(PSO)
+
+all : $(ALL)
+
+clean : 
+	@/bin/rm $(ALL) *.o *.sav *.xg *.status *~

eo/tutorial/Lesson6/RealPSO.cpp

@@ -0,0 +1,183 @@
+//-----------------------------------------------------------------------------
+// RealPSO.cpp
+//-----------------------------------------------------------------------------
+//*
+// An instance of a VERY simple Real-coded Particle Swarm Optimization Algorithm
+//
+//-----------------------------------------------------------------------------
+#include <stdexcept>
+#include <iostream>
+#include <sstream>
+
+#include <eo>
+
+// Use functions from namespace std
+using namespace std;
+
+//-----------------------------------------------------------------------------
+typedef eoMinimizingFitness FitT;
+typedef eoRealParticle < FitT > Particle;
+//-----------------------------------------------------------------------------
+
+
+// EVALFUNC
+//-----------------------------------------------------------------------------
+// a simple fitness function that computes the euclidian norm of a real vector
+FitT real_value (const Particle & _particle)
+{
+    double sum = 0;
+    for (unsigned i = 0; i < _particle.size(); i++)
+        sum += pow(_particle[i],2);
+    return (sqrt(sum));
+}
+
+
+
+void main_function(int argc, char **argv)
+{
+// PARAMETRES
+ // all parameters are hard-coded!
+ 	const unsigned int SEED = 42;	// seed for random number generator
+ 	
+ 	const unsigned int MAX_GEN=100;
+    const unsigned int VEC_SIZE = 2;
+    const unsigned int POP_SIZE = 20;
+    const unsigned int NEIGHBORHOOD_SIZE= 5;
+    
+    const double POS_INIT_MIN= -2;
+    const double POS_INIT_MAX= 2;
+    
+    const double VELOCITY_INIT_MIN= -1;
+    const double VELOCITY_INIT_MAX= 1;
+    
+    const double VELOCITY_MIN= -1.5;
+    const double VELOCITY_MAX= 1.5;
+    
+    const double INERTIA= 1;
+    const double LEARNING_FACTOR1= 1.7;
+    const double LEARNING_FACTOR2= 2.3;
+
+//////////////////////////
+//  RANDOM SEED
+//////////////////////////
+  //reproducible random seed: if you don't change SEED above,
+  // you'll aways get the same result, NOT a random run
+  	rng.reseed(SEED);
+
+    
+/// SWARM
+ 	// population <=> swarm 
+    eoPop<Particle> pop;
+
+/// EVALUATION
+	// Evaluation: from a plain C++ fn to an EvalFunc Object
+    eoEvalFuncPtr<Particle, FitT, const Particle& > eval(  real_value );
+
+
+///////////////
+/// TOPOLOGY
+//////////////
+	// linear topology
+    eoLinearTopology<Particle> topology(NEIGHBORHOOD_SIZE);
+    
+    
+/////////////////////
+// INITIALIZATION
+////////////////////
+    // position initialization
+    eoUniformGenerator < double >uGen (POS_INIT_MIN, POS_INIT_MAX);
+    eoInitFixedLength < Particle > random (VEC_SIZE, uGen);
+	pop.append (POP_SIZE, random);
+	
+    // velocities initialization component
+    eoUniformGenerator < double >sGen (VELOCITY_INIT_MIN, VELOCITY_INIT_MAX);
+    eoVelocityInitFixedLength < Particle > veloRandom (VEC_SIZE, sGen);
+
+    // first best position initialization component
+    eoFirstIsBestInit < Particle > localInit;
+
+	// Create an eoInitialier that:
+	// 		- performs a first evaluation of the particles
+	//  	- initializes the velocities
+	//  	- the first best positions of each particle
+	// 		- setups the topology
+    eoInitializer <Particle> fullInit(eval,veloRandom,localInit,topology,pop);
+    
+   // Full initialization here to be able to print the initial population
+   // Else: give the "init" component in the eoEasyPSO constructor
+   fullInit();
+    
+/////////////
+// OUTPUT
+////////////
+// sort pop before printing it!
+  	pop.sort();
+  	
+  	// Print (sorted) the initial population (raw printout)
+    cout << "INITIAL POPULATION:" << endl;
+    for (unsigned i = 0; i < pop.size(); ++i)
+         cout <<  "\t best fit=" <<  pop[i] <<  endl;
+
+ 
+///////////////
+/// VELOCITY
+//////////////
+    // Create the bounds for the velocity not go to far away
+    eoRealVectorBounds bnds(VEC_SIZE,VELOCITY_MIN,VELOCITY_MAX);
+
+    // the velocity itself that needs the topology and a few constants
+    eoStandardVelocity <Particle> velocity (topology,INERTIA,LEARNING_FACTOR1,LEARNING_FACTOR2,bnds);
+
+
+///////////////
+/// FLIGHT
+//////////////
+    // flight
+    eoStandardFlight <Particle> flight;
+
+
+////////////////////////
+/// STOPPING CRITERIA
+///////////////////////
+    // the algo will run for MAX_GEN iterations
+    eoGenContinue <Particle> genCont (MAX_GEN);
+
+
+// GENERATION
+  /////////////////////////////////////////
+  // the algorithm
+  ////////////////////////////////////////
+  // standard PSO requires
+  // stopping criteria, evaluation,velocity, flight
+  
+    eoEasyPSO<Particle> pso(genCont, eval, velocity, flight);
+
+    // Apply the algo to the swarm - that's it!
+    pso(pop);
+
+// OUTPUT
+  // Print (sorted) intial population
+	 pop.sort();
+	 cout << "FINAL POPULATION:" << endl;
+  	 for (unsigned i = 0; i < pop.size(); ++i)
+        cout <<  "\t best fit=" <<  pop[i] <<  endl;
+
+}
+
+
+// A main that catches the exceptions
+
+int main(int argc, char **argv)
+{	
+    try
+    {
+        main_function(argc, argv);
+    }
+    catch(exception& e)
+    {
+        cout << "Exception: " << e.what() << '\n';
+    }
+
+    return 1;
+}
+//-----------------------------------------------------------------------------