algorithm/base.h

/*****************************************************************************
 *   Copyright (C) 2004-2015 The PaGMO development team,                     *
 *   Advanced Concepts Team (ACT), European Space Agency (ESA)               *
 *                                                                           *
 *   https://github.com/esa/pagmo                                            *
 *                                                                           *
 *   act@esa.int                                                             *
 *                                                                           *
 *   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.               *
 *****************************************************************************/

#ifndef PAGMO_ALGORITHM_BASE_H
#define PAGMO_ALGORITHM_BASE_H

#include <iostream>
#include <string>
#include <typeinfo>
#include <boost/shared_ptr.hpp>

#include "../config.h"
#include "../population.h"
#include "../rng.h"
#include "../serialization.h"

namespace pagmo
{

namespace algorithm {

class base;

typedef boost::shared_ptr<base> base_ptr;


class __PAGMO_VISIBLE base
{    
        public:
                base();

                virtual void evolve(population &p) const = 0;

                virtual base_ptr clone() const = 0;
                virtual ~base();
                std::string human_readable() const;
                virtual std::string get_name() const;
                virtual std::string human_readable_extra() const;
                void set_screen_output(const bool p);
                bool get_screen_output() const;

                void reset_rngs(const unsigned int) const;

        protected:
                bool m_screen_output;
                mutable rng_double      m_drng;
                mutable rng_uint32      m_urng;
        private:
                friend class boost::serialization::access;
                template <class Archive>
                void serialize(Archive &ar, const unsigned int)
                {
                        ar & m_drng;
                        ar & m_urng; 
                        ar & m_screen_output;
                }
        protected:
                mutable unsigned int m_fevals;
};

std::ostream __PAGMO_VISIBLE_FUNC &operator<<(std::ostream &, const base &);

}
}

BOOST_SERIALIZATION_ASSUME_ABSTRACT(pagmo::algorithm::base)

#endif