Evocosm - A C++ Framework for Evolutionary Computing

Main Index

Created by Scott Robert Ladd at Coyote Gulch Productions.


listener.h
00001 /*
00002     Evocosm is a C++ framework for implementing evolutionary algorithms.
00003 
00004     Copyright 2011 Scott Robert Ladd. All rights reserved.
00005 
00006     Evocosm is user-supported open source software. Its continued development is dependent
00007     on financial support from the community. You can provide funding by visiting the Evocosm
00008     website at:
00009 
00010         http://www.coyotegulch.com
00011 
00012     You may license Evocosm in one of two fashions:
00013 
00014     1) Simplified BSD License (FreeBSD License)
00015 
00016     Redistribution and use in source and binary forms, with or without modification, are
00017     permitted provided that the following conditions are met:
00018 
00019     1.  Redistributions of source code must retain the above copyright notice, this list of
00020         conditions and the following disclaimer.
00021 
00022     2.  Redistributions in binary form must reproduce the above copyright notice, this list
00023         of conditions and the following disclaimer in the documentation and/or other materials
00024         provided with the distribution.
00025 
00026     THIS SOFTWARE IS PROVIDED BY SCOTT ROBERT LADD ``AS IS'' AND ANY EXPRESS OR IMPLIED
00027     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
00028     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SCOTT ROBERT LADD OR
00029     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00030     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00032     ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
00034     ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 
00036     The views and conclusions contained in the software and documentation are those of the
00037     authors and should not be interpreted as representing official policies, either expressed
00038     or implied, of Scott Robert Ladd.
00039 
00040     2) Closed-Source Proprietary License
00041 
00042     If your project is a closed-source or proprietary project, the Simplified BSD License may
00043     not be appropriate or desirable. In such cases, contact the Evocosm copyright holder to
00044     arrange your purchase of an appropriate license.
00045 
00046     The author can be contacted at:
00047 
00048           scott.ladd@coyotegulch.com
00049           scott.ladd@gmail.com
00050           http:www.coyotegulch.com
00051 */
00052 
00053 #if !defined(LIBEVOCOSM_LISTENER_H)
00054 #define LIBEVOCOSM_LISTENER_H
00055 
00056 // Standard C++ Library
00057 #include <string>
00058 #include <iostream>
00059 #include <iomanip>
00060 #include <vector>
00061 
00062 // Windows
00063 #if defined(_MSC_VER)
00064 #include "windows.h"
00065 #undef max
00066 #undef min
00067 #endif
00068 
00069 namespace libevocosm
00070 {
00071     template<typename T> class population;
00072 
00074 
00079     template <typename OrganismType>
00080     class listener
00081     {
00082         public:
00084 
00089             virtual void ping_generation_begin(const std::vector<OrganismType> & a_population, size_t a_iteration) = 0;
00090 
00092 
00097             virtual void ping_generation_end(const std::vector<OrganismType> & a_population, size_t a_iteration) = 0;
00098 
00100 
00104             virtual void ping_fitness_test_begin(const OrganismType & a_organism_number) = 0;
00105 
00107 
00111             virtual void ping_fitness_test_end(const OrganismType & a_organism_number) = 0;
00112 
00114 
00122             virtual void report(const std::string & a_text) = 0;
00123 
00125 
00132             virtual void report_error(const std::string & a_text) = 0;
00133 
00135 
00139             virtual void run_complete(const std::vector<OrganismType> & a_population) = 0;
00140     };
00141 
00143 
00146     template <typename OrganismType>
00147     class null_listener : public listener<OrganismType>
00148     {
00149         public:
00151 
00156             virtual void ping_generation_begin(const std::vector<OrganismType> & a_population, size_t a_iteration)
00157             {
00158                 // do nothing
00159             }
00160 
00162 
00167             virtual void ping_generation_end(const std::vector<OrganismType> & a_population, size_t a_iteration)
00168             {
00169                 // do nothing
00170             }
00171 
00173 
00177             virtual void ping_fitness_test_begin(const OrganismType & a_organism_number)
00178             {
00179                 // do nothing
00180             }
00181 
00183 
00187             virtual void ping_fitness_test_end(const OrganismType & a_organism_number)
00188             {
00189                 // do nothing
00190             }
00191 
00193 
00201             virtual void report(const std::string & a_text)
00202             {
00203                 // do nothing
00204             }
00205 
00207 
00214             virtual void report_error(const std::string & a_text)
00215             {
00216                 // do nothing
00217             }
00218 
00220 
00224             virtual void run_complete(const std::vector<OrganismType> & a_population)
00225             {
00226                 // do nothing
00227             }
00228     };
00229 
00230 }
00231 
00232 #endif

© 1996-2005 Scott Robert Ladd. All rights reserved.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.