/usr/include/libevocosm/evocommon.h is in libevocosm-dev 3.1.0-3.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | //---------------------------------------------------------------------
// Algorithmic Conjurings @ http://www.coyotegulch.com
// Evocosm -- An Object-Oriented Framework for Evolutionary Algorithms
//
// evocommon.h
//---------------------------------------------------------------------
//
// Copyright 1996-2005 Scott Robert Ladd
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the
// Free Software Foundation, Inc.
// 59 Temple Place - Suite 330
// Boston, MA 02111-1307, USA.
//
//-----------------------------------------------------------------------
//
// For more information on this software package, please visit
// Scott's web site, Coyote Gulch Productions, at:
//
// http://www.coyotegulch.com
//
//-----------------------------------------------------------------------
#if !defined(LIBEVOCOSM_EVOGLOBAL_H)
#define LIBEVOCOSM_EVOGLOBAL_H
// Standard C++ Library
#include <string>
#include <iostream>
#include <iomanip>
// libcoyotl
#include "libcoyotl/mtwister.h"
namespace libevocosm
{
//! Elements shared by all classes in Evocosm
/*!
All Evocosm classes are derived from this class, a singleton for shared
attributes.
*/
class globals
{
protected:
//! Static function to allow use of g_random function pointer in random_shuffle
static size_t rand_index(size_t n)
{
return g_random.get_rand_index(n);
}
//! A shared random number generator
static libcoyotl::mtwister g_random;
//! Version number
static std::string g_version;
public:
//! Set the seed for the random number generator
static void set_random_seed(uint32_t a_seed)
{
g_random.init(a_seed);
}
//! Set the seed for the random number generator
static uint32_t get_seed()
{
return g_random.get_seed();
}
//! Get version number
static std::string version()
{
return g_version;
}
};
//! 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.
*/
class listener
{
public:
//! Ping that a generation begins
/*!
Ping that processing a generation begins.
\param a_generation_number One-based number of the generation begun
*/
virtual void ping_generation_begin(size_t a_generation_number) = 0;
//! Ping that a generation ends
/*!
Ping that processing a generation has ended.
\param a_generation_number One-based number of the generation ended
*/
virtual void ping_generation_end(size_t a_generation_number) = 0;
//! Ping that a population begins
/*!
Ping that processing a population begins.
\param a_population_number One-based number of the population begun
*/
virtual void ping_population_begin(size_t a_population_number) = 0;
//! Ping that a population ends
/*!
Ping that processing a population has ended.
\param a_population_number One-based number of the population ended
*/
virtual void ping_population_end(size_t a_population_number) = 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(size_t 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(size_t 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() = 0;
//! Yield
/*!
Evocosm periodically invokes this function to allow other processes
to run. In most cases, this will be some sort of platform-specific
sleep function, such as usleep.
*/
virtual void yield() = 0;
};
//! An listener implementation that ignores all events
/*!
This listener ignores anything it hears.
*/
class null_listener : public listener
{
public:
//! Ping that a generation begins
/*!
Ping that processing a generation begins.
\param a_generation_number One-based number of the generation begun
*/
virtual void ping_generation_begin(size_t a_generation_number)
{
// do nothing
}
//! Ping that a generation ends
/*!
Ping that processing a generation has ended.
\param a_generation_number One-based number of the generation ended
*/
virtual void ping_generation_end(size_t a_generation_number)
{
// do nothing
}
//! Ping that a population begins
/*!
Ping that processing a population begins.
\param a_population_number One-based number of the population begun
*/
virtual void ping_population_begin(size_t a_population_number)
{
// do nothing
}
//! Ping that a population ends
/*!
Ping that processing a population has ended.
\param a_population_number One-based number of the population ended
*/
virtual void ping_population_end(size_t a_population_number)
{
// 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(size_t 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(size_t 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()
{
// do nothing
}
//! Yield
/*!
Evocosm periodically invokes this function to allow other processes
to run. In most cases, this will be some sort of platform-specific
sleep function, such as usleep.
*/
virtual void yield()
{
// do nothing
}
};
//! An listener implementation that ignores all events
/*!
This listener displays information about events to stdout
(standard ouput).
*/
class listener_stdout : public listener
{
public:
//! Ping that a generation begins
/*!
Ping that processing a generation begins.
\param a_generation_number One-based number of the generation begun
*/
virtual void ping_generation_begin(size_t a_generation_number)
{
std::cout << "------------------------------------------------------------\ngeneration "
<< a_generation_number << " begins" << std::endl;
}
//! Ping that a generation ends
/*!
Ping that processing a generation has ended.
\param a_generation_number One-based number of the generation ended
*/
virtual void ping_generation_end(size_t a_generation_number)
{
// nada
}
//! Ping that a population begins
/*!
Ping that processing a population begins.
\param a_population_number One-based number of the population begun
*/
virtual void ping_population_begin(size_t a_population_number)
{
std::cout << "\npopulation " << std::setw(2) << a_population_number << ": " << std::flush;
}
//! Ping that a population ends
/*!
Ping that processing a population has ended.
\param a_population_number One-based number of the population ended
*/
virtual void ping_population_end(size_t a_population_number)
{
// nada
}
//! 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(size_t a_organism_number)
{
// nada
}
//! 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(size_t a_organism_number)
{
std::cout << "." << std::flush;
}
//! 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)
{
std::cout << a_text;
}
//! 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)
{
std::cerr << a_text;
}
//! Evocosm is finished
/*!
Invoked when an evocosm finishes all processing. This way God can
rest on the seventh day.
*/
virtual void run_complete()
{
// nada
}
//! Yield
/*!
Evocosm periodically invokes this function to allow other processes
to run. In most cases, this will be some sort of platform-specific
sleep function, such as usleep.
*/
virtual void yield()
{
usleep(50000);
}
};
}
#endif
|