-//! | ... | |
-//! | eoPop< EOT > population( POP_SIZE, popInitializer ); | // creation of a population with POP_SIZE individuals - the popInitializer is a functor to be called for each individual |
-//! | | |
-//! | eoGenContinue< EOT > eaCont( NUM_GEN ); | // number of generations for the evolutionary algorithm |
-//! | eoCheckPoint< EOT > eaCheckpointContinue( eaCont ); | // checkpoint incorporating the continuation criterion - startpoint for adding other checkpoint objects |
-//! | | |
-//! | peoSeqPopEval< EOT > eaPopEval( evalFunction ); | // sequential evaluation functor wrapper - evalFunction represents the actual evaluation functor |
-//! | | |
-//! | eoRankingSelect< EOT > selectionStrategy; | // selection strategy for creating the offspring population - a simple ranking selection in this case |
-//! | eoSelectNumber< EOT > eaSelect( selectionStrategy, POP_SIZE ); | // the number of individuals to be selected for creating the offspring population |
-//! | eoRankingSelect< EOT > selectionStrategy; | // selection strategy for creating the offspring population - a simple ranking selection in this case |
-//! | | |
-//! | eoSGATransform< EOT > transform( crossover, CROSS_RATE, mutation, MUT_RATE ); | // transformation operator - crossover and mutation operators with their associated probabilities |
-//! | peoSeqTransform< EOT > eaTransform( transform ); | // ParadisEO specific sequential operator - a parallel version may be specified in the same manner |
-//! | | |
-//! | eoPlusReplacement< EOT > eaReplace; | // replacement strategy - for integrating the offspring resulting individuals in the initial population |
-//! | | |
-//! | peoEA< EOT > eaAlg( eaCheckpointContinue, eaPopEval, eaSelect, eaTransform, eaReplace ); | // ParadisEO evolutionary algorithm integrating the above defined objects |
-//! | eaAlg( population ); | // specifying the initial population for the algorithm |
-//! | ... | |
-//!
\ No newline at end of file
+//! The source code for this example may be found in the
+//! - include the necessary header files - as we will be using Route objects, we have to include the files
+//! which define the Route type, the initializing functor and the evaluation functions. Furthermore, in order to make use of
+//! transform operators, we require having the headers which define the crossover and the mutation operators.
+//! All these files may be found in the shared directory that we mentioned in the beginning. At this point you
+//! should have something like the following:
+//!
+//!
+//! ##include "route.h"
+//! ##include "route_init.h"
+//! ##include "route_eval.h"
+//!
+//! ##include "order_xover.h"
+//! ##include "city_swap.h"
+//!
+//! In addition we require having the paradiseo header file, in order to use the ParadisEO-PEO features, and a header specific
+//! for our problem, dealing with processing command-line parameters - the param.h header file. The complete picture at this point
+//! with all the required header files is as follows:
+//!
+//!
+//! ##include "route.h"
+//! ##include "route_init.h"
+//! ##include "route_eval.h"
+//!
+//! ##include "order_xover.h"
+//! ##include "city_swap.h"
+//!
+//! ##include "param.h"
+//!
+//! ##include <paradiseo>
+//!
+//! NOTE: the paradiseo header file is in fact a "super-header" - it includes all the esential ParadisEO-PEO header files.
+//! It is at at your choice if you want use the paradiseo header file or to explicitly include different header files,
+//! like the peoEA.h header file, for example.
+//!
+//!
+//! - define problem specific parameters - in our case we have to specify how many individuals we want to have in our population, the number
+//! of generations for the evolutionary algorithm to iterate and the probabilities associated with the crossover and mutation operators.
+//!
+//!
+//! ##include "route.h"
+//! ##include "route_init.h"
+//! ##include "route_eval.h"
+//!
+//! ##include "order_xover.h"
+//! ##include "city_swap.h"
+//!
+//! ##include "param.h"
+//!
+//! ##include <paradiseo>
+//!
+//!
+//! ##define POP_SIZE 10
+//! ##define NUM_GEN 100
+//! ##define CROSS_RATE 1.0
+//! ##define MUT_RATE 0.01
+//!
+//!
+//! - construct the skeleton of a simple ParadisEO-PEO program - the main function including the code for initializing the ParadisEO-PEO
+//! environment, for loading problem data and for shutting down the ParadisEO-PEO environment. From this point on we will make
+//! abstraction of the previous part referring only to the main function.
+//!
+//!
+//! ...
+//!
+//! int main( int __argc, char** __argv ) {
+//!
+//! // initializing the ParadisEO-PEO environment
+//! peo :: init( __argc, __argv );
+//!
+//! // processing the command line specified parameters
+//! loadParameters( __argc, __argv );
+//!
+//!
+//! // EVOLUTIONARY ALGORITHM TO BE DEFINED
+//!
+//!
+//! peo :: run( );
+//! peo :: finalize( );
+//! // shutting down the ParadisEO-PEO environment
+//!
+//! return 0;
+//! }
+//!
+//!
+//! - initialization functors, evaluation function and transform operators - basically we only need to create instances for each of the
+//! enumerated objects, to be passed later as parameters for higher-level components of the evolutionary algorithm.
+//!
+//!
+//! RouteInit route_init; // random init object - creates random Route objects
+//! RouteEval full_eval; // evaluator object - offers a fitness value for a specified Route object
+//!
+//! OrderXover crossover; // crossover operator - creates two offsprings out of two specified parents
+//! CitySwap mutation; // mutation operator - randomly mutates one gene for a specified individual
+//!
+//!
+//! - construct the components of the evolutionary algorithm - each of the components that has to be passed as parameter to the
+//! peoEA constructor has to be defined along with the associated parameters. Except for the requirement to provide the
+//! appropriate objects (for example, a peoPopEval derived object must be specified for the evaluation functor), there is no strict
+//! path to follow. It is your option what elements to mix, depending on your problem - we aimed for simplicity in our example.
+//!
+//!
+//! - an initial population has to be specified; the constructor accepts the specification of an initializing object. Further,
+//! an evaluation object is required - the peoEA constructor requires a peoPopEval derived class.
+//!
+//!
+//!
+//! eoPop< Route > population( POP_SIZE, route_init ); // initial population for the algorithm having POP_SIZE individuals
+//! peoSeqPopEval< Route > eaPopEval( full_eval ); // evaluator object - to be applied at each iteration on the entire population
+//!
+//!
+//! - the evolutionary algorithm continues to iterate till a continuation criterion is not met. For our case we consider
+//! a fixed number of generations. The continuation criterion has to be specified as a checkpoint object, thus requiring
+//! the creation of an eoCheckPoint object in addition.
+//!
+//!
+//!
+//! eoGenContinue< Route > eaCont( NUM_GEN ); // continuation criterion - the algorithm will iterate for NUM_GEN generations
+//! eoCheckPoint< Route > eaCheckpointContinue( eaCont ); // checkpoint object - verify at each iteration if the continuation criterion is met
+//!
+//!
+//! - selection strategy - we are required to specify a selection strategy for extracting individuals out of the parent
+//! population; in addition the number of individuals to be selected has to be specified.
+//!
+//!
+//!
+//! eoRankingSelect< Route > selectionStrategy; // selection strategy - applied at each iteration for selecting parent individuals
+//! eoSelectNumber< Route > eaSelect( selectionStrategy, POP_SIZE ); // selection object - POP_SIZE individuals are selected at each iteration
+//!
+//!
+//! - transformation operators - we have to integrate the crossover and the mutation functors into an object which may be passed
+//! as a parameter when creating the peoEA object. The constructor of peoEA requires a peoTransform derived
+//! object. Associated probabilities have to be specified also.
+//!
+//!
+//!
+//! // transform operator - includes the crossover and the mutation operators with a specified associated rate
+//! eoSGATransform< Route > transform( crossover, CROSS_RATE, mutation, MUT_RATE );
+//! peoSeqTransform< Route > eaTransform( transform ); // ParadisEO transform operator (please remark the peo prefix) - wraps an e EO transform object
+//!
+//!
+//! - replacement strategy - required for defining the way for integrating the resulting offsprings into the initial population.
+//! At your option whether you would like to chose one of the predefined replacement strategies that come with the EO framework
+//! or if you want to define your own.
+//!
+//!
+//!
+//! eoPlusReplacement< Route > eaReplace; // replacement strategy - for replacing the initial population with offspring individuals
+//!
+//!
+//! - evolutionary algorithm - having defined all the previous components, we are ready for instanciating an evolutionary algorithm.
+//! In the end we have to associate a population with the algorithm, which will serve as the initial population, to be iteratively evolved.
+//!
+//!
+//! peoEA< Route > eaAlg( eaCheckpointContinue, eaPopEval, eaSelect, eaTransform, eaReplace );
+//!
+//! eaAlg( population ); // specifying the initial population for the algorithm, to be iteratively evolved
+//!
+//!
+//!
+//!
+//! If you have not missed any of the enumerated points, your program should be like the following:
+//!
+//!