C:/dev/de/differentialevolution/listener.hpp

/*
 * Copyright (c) 2011 Adrian Michel
 * http://www.amichel.com
 *
 * Permission to use, copy, modify, distribute and sell this 
 * software and its documentation for any purpose is hereby 
 * granted without fee, provided that both the above copyright 
 * notice and this permission notice appear in all copies and in 
 * the supporting documentation. 
 *  
 * This library is distributed in the hope that it will be 
 * useful. However, Adrian Michel makes no representations about
 * the suitability of this software for any purpose.  It is 
 * provided "as is" without any express or implied warranty. 
 * 
 * Should you find this library useful, please email 
 * info@amichel.com with a link or other reference 
 * to your work. 
*/

#ifndef DE_LISTENER_HPP_INCLUDED
#define DE_LISTENER_HPP_INCLUDED

// MS compatible compilers support #pragma once

#if defined(_MSC_VER) && (_MSC_VER >= 1020)
#pragma once
#endif

namespace de
{

class listener
{
public:
        virtual ~listener() {}

        virtual void start() = 0;
        virtual void end() = 0;
        virtual void error() = 0;
        virtual void startGeneration( size_t genCount ) = 0;
        virtual void endGeneration( size_t genCount, individual_ptr bestIndGen, individual_ptr bestInd ) = 0;
        virtual void startSelection( size_t genCount ) = 0;
        virtual void endSelection( size_t genCount ) = 0;
        virtual void startProcessors( size_t genCount ) = 0;
        virtual void endProcessors( size_t genCount ) = 0;
};

typedef boost::shared_ptr< listener > listener_ptr;

class null_listener : public listener
{
public:
        virtual void start(){}
        virtual void end(){}
        virtual void error(){}
        virtual void startGeneration( size_t genCount ){}
        virtual void endGeneration( size_t genCount, individual_ptr bestIndGen, individual_ptr bestInd ){}
        virtual void startSelection( size_t genCount ){}
        virtual void endSelection( size_t genCount ){}
        virtual void startProcessors( size_t genCount ){}
        virtual void endProcessors( size_t genCount ){}
};

}

#endif //DE_LISTENER_HPP_INCLUDED