vega.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_VEGA_H
#define PAGMO_ALGORITHM_VEGA_H

#include <string>

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

namespace pagmo { namespace algorithm {


class __PAGMO_VISIBLE vega: public base
{
public:
        struct mutation {
                enum type {GAUSSIAN = 0, RANDOM = 1};

                mutation(mutation::type t, double width) : m_type(t),m_width(width) {}
                type m_type;
                double m_width;
        private:
                friend class boost::serialization::access;
                template <class Archive>
                void serialize(Archive &ar, const unsigned int)
                {
                        ar & m_type;
                        ar & m_width;
                }
        };

        struct crossover {
                enum type {BINOMIAL = 0, EXPONENTIAL = 1};
        };

public:
        // constructors
        vega(int gen  = 1, const double &cr = .95, const double &m = .02, int elitism = 1,
                 mutation::type mut  = mutation::GAUSSIAN, double width = 0.1,
                 crossover::type cro = crossover::EXPONENTIAL);

        base_ptr clone() const;
        std::string get_name() const;

        void evolve(population &) const;

protected:
        std::string human_readable_extra() const;
private:
        friend class boost::serialization::access;
        template <class Archive>
        void serialize(Archive &ar, const unsigned int)
        {
                ar & boost::serialization::base_object<base>(*this);
                ar & const_cast<int &>(m_gen);
                ar & const_cast<double &>(m_cr);
                ar & const_cast<double &>(m_m);
                ar & const_cast<int &>(m_elitism);
                ar & const_cast<mutation &>(m_mut);
                ar & const_cast<crossover::type &>(m_cro);
        }

        //Number of generations
        const int m_gen;
        //Crossover rate
        const double m_cr;
        //Mutation rate
        const double m_m;

        //Elitism (number of generations after which to reinsert the best)
        const int m_elitism;
        //Mutation
        const mutation m_mut;
        //Crossover_type
        const crossover::type m_cro;
};

}} //namespaces

BOOST_CLASS_EXPORT_KEY(pagmo::algorithm::vega)

#endif // PAGMO_ALGORITHM_VEGA_H