1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
/*
Evocosm is a C++ framework for implementing evolutionary algorithms.
Copyright 2011 Scott Robert Ladd. All rights reserved.
Evocosm is user-supported open source software. Its continued development is dependent
on financial support from the community. You can provide funding by visiting the Evocosm
website at:
http://www.coyotegulch.com
You may license Evocosm in one of two fashions:
1) Simplified BSD License (FreeBSD License)
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
THIS SOFTWARE IS PROVIDED BY SCOTT ROBERT LADD ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SCOTT ROBERT LADD OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those of the
authors and should not be interpreted as representing official policies, either expressed
or implied, of Scott Robert Ladd.
2) Closed-Source Proprietary License
If your project is a closed-source or proprietary project, the Simplified BSD License may
not be appropriate or desirable. In such cases, contact the Evocosm copyright holder to
arrange your purchase of an appropriate license.
The author can be contacted at:
scott.ladd@coyotegulch.com
scott.ladd@gmail.com
http:www.coyotegulch.com
*/
#if !defined(LIBEVOCOSM_LISTENER_H)
#define LIBEVOCOSM_LISTENER_H
// Standard C++ Library
#include <string>
#include <iostream>
#include <iomanip>
#include <vector>
// Windows
#if defined(_MSC_VER)
#include "windows.h"
#undef max
#undef min
#endif
namespace libevocosm
{
template<typename T> class population;
//! An abstract interface defining a listener
/*!
Evocosm reports its activities through a listener object derived from this abstract
class. Some events state that a given event has occurred (e.g., the beginning of a new
generation), while others provide text for display.
*/
template <typename OrganismType>
class listener
{
public:
//! Ping that a generation begins
/*!
Ping that processing a generation begins.
\param a_population Population before this generation's evolution
\param a_iteration One-based number of the generation begun
*/
virtual void ping_generation_begin(const std::vector<OrganismType> & a_population, size_t a_iteration) = 0;
//! Ping that a generation ends
/*!
Ping that processing a generation has ended.
\param a_population Population for which processing has ended
\param a_iteration One-based number of the generation ended
*/
virtual void ping_generation_end(const std::vector<OrganismType> & a_population, size_t a_iteration) = 0;
//! Ping that a test run begins
/*!
Ping that fitness testing of an organism begins.
\param a_organism_number One-based number of the organism
*/
virtual void ping_fitness_test_begin(const OrganismType & a_organism_number) = 0;
//! Ping that a test run ends
/*!
Ping that processing a generation has ended.
\param a_organism_number One-based number of the organism
*/
virtual void ping_fitness_test_end(const OrganismType & a_organism_number) = 0;
//! Report non-specific text
/*!
This event provide status text specific to a given type of
evocosm. The base <code>evocosm</code> class does not call this function. The
intention is that this function will be called from classes
derived from <code>evocosm</code> to report progress, statistics, or other
useful information.
\param a_text Application-specific text
*/
virtual void report(const std::string & a_text) = 0;
//! Send error message
/*!
This event provides error text specific to a given type of
evocosm. The base <code>evocosm</code> class does not call this function. The
intention is that this function will be called from classes
derived from <code>evocosm</code> to report problems.
\param a_text Application-specific error text
*/
virtual void report_error(const std::string & a_text) = 0;
//! Evocosm is finished
/*!
Invoked when an evocosm finishes all processing. This way God can
rest on the seventh day.
*/
virtual void run_complete(const std::vector<OrganismType> & a_population) = 0;
};
//! An listener implementation that ignores all events
/*!
This listener ignores anything it hears.
*/
template <typename OrganismType>
class null_listener : public listener<OrganismType>
{
public:
//! Ping that a generation begins
/*!
Ping that processing a generation begins.
\param a_population Population before this generation's evolution
\param a_iteration One-based number of the generation begun
*/
virtual void ping_generation_begin(const std::vector<OrganismType> & a_population, size_t a_iteration)
{
// do nothing
}
//! Ping that a generation ends
/*!
Ping that processing a generation has ended.
\param a_population population for which processing has ended
\param a_iteration One-based number of the generation ended
*/
virtual void ping_generation_end(const std::vector<OrganismType> & a_population, size_t a_iteration)
{
// do nothing
}
//! Ping that a test run begins
/*!
Ping that fitness testing of an organism begins.
\param a_organism_number One-based number of the organism
*/
virtual void ping_fitness_test_begin(const OrganismType & a_organism_number)
{
// do nothing
}
//! Ping that a test run ends
/*!
Ping that processing a generation has ended.
\param a_organism_number One-based number of the organism
*/
virtual void ping_fitness_test_end(const OrganismType & a_organism_number)
{
// do nothing
}
//! Report non-specific text
/*!
This event provide status text specific to a given type of
evocosm. The base <code>evocosm</code> class does not call this function. The
intention is that this function will be called from classes
derived from <code>evocosm</code> to report progress, statistics, or other
useful information.
\param a_text Application-specific text
*/
virtual void report(const std::string & a_text)
{
// do nothing
}
//! Send error message
/*!
This event provides error text specific to a given type of
evocosm. The base <code>evocosm</code> class does not call this function. The
intention is that this function will be called from classes
derived from <code>evocosm</code> to report problems.
\param a_text Application-specific error text
*/
virtual void report_error(const std::string & a_text)
{
// do nothing
}
//! Evocosm is finished
/*!
Invoked when an evocosm finishes all processing. This way God can
rest on the seventh day.
*/
virtual void run_complete(const std::vector<OrganismType> & a_population)
{
// do nothing
}
};
}
#endif
|