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 heterogenous collection of mathematical tools,  written in Standard C.
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 
00061 // Windows
00062 #if defined(_MSC_VER)
00063 #include "windows.h"
00064 #undef max
00065 #undef min
00066 #endif
00067 
00068 namespace libevocosm
00069 {
00070     template<typename T> class population;
00071 
00073 
00078     template <typename OrganismType>
00079     class listener
00080     {
00081         public:
00083 
00088             virtual void ping_generation_begin(const vector<OrganismType> & a_population, size_t a_iteration) = 0;
00089 
00091 
00096             virtual void ping_generation_end(const vector<OrganismType> & a_population, size_t a_iteration) = 0;
00097 
00099 
00103             virtual void ping_fitness_test_begin(const OrganismType & a_organism_number) = 0;
00104 
00106 
00110             virtual void ping_fitness_test_end(const OrganismType & a_organism_number) = 0;
00111 
00113 
00121             virtual void report(const std::string & a_text) = 0;
00122 
00124 
00131             virtual void report_error(const std::string & a_text) = 0;
00132 
00134 
00138             virtual void run_complete(const vector<OrganismType> & a_population) = 0;
00139     };
00140 
00142 
00145     template <typename OrganismType>
00146     class null_listener : public listener<OrganismType>
00147     {
00148         public:
00150 
00155             virtual void ping_generation_begin(const vector<OrganismType> & a_population, size_t a_iteration)
00156             {
00157                 // do nothing
00158             }
00159 
00161 
00166             virtual void ping_generation_end(const vector<OrganismType> & a_population, size_t a_iteration)
00167             {
00168                 // do nothing
00169             }
00170 
00172 
00176             virtual void ping_fitness_test_begin(const OrganismType & a_organism_number)
00177             {
00178                 // do nothing
00179             }
00180 
00182 
00186             virtual void ping_fitness_test_end(const OrganismType & a_organism_number)
00187             {
00188                 // do nothing
00189             }
00190 
00192 
00200             virtual void report(const std::string & a_text)
00201             {
00202                 // do nothing
00203             }
00204 
00206 
00213             virtual void report_error(const std::string & a_text)
00214             {
00215                 // do nothing
00216             }
00217 
00219 
00223             virtual void run_complete(const vector<OrganismType> & a_population)
00224             {
00225                 // do nothing
00226             }
00227     };
00228 
00229 }
00230 
00231 #endif

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