cstrs_immune_system.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_CSTRS_IMMUNE_SYSTEM_H
#define PAGMO_ALGORITHM_CSTRS_IMMUNE_SYSTEM_H

#include <string>

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

namespace pagmo { namespace algorithm {


class __PAGMO_VISIBLE cstrs_immune_system: public base
{
public:

        // Immune system antibody selection method: best antibody, infeasibility
        enum select_method_type {BEST_ANTIBODY = 0, INFEASIBILITY = 1};


        enum inject_method_type {CHAMPION = 0, BEST25 = 1};


        // hamming distance, euclidean distance
        enum distance_method_type {HAMMING = 0, EUCLIDEAN = 1};

        cstrs_immune_system(const base & = jde(1), const base & = sga(), int gen = 1,
                                                select_method_type = BEST_ANTIBODY,
                                                inject_method_type = CHAMPION,
                                                distance_method_type = EUCLIDEAN,
                                                double = 0.5,
                                                double = 0.5,
                                                double = 1./3.,
                                                double = 1e-15, double = 1e-15);
        cstrs_immune_system(const cstrs_immune_system &);
        base_ptr clone() const;

public:
        void evolve(population &) const;
        std::string get_name() const;
        base_ptr get_algorithm() const;
        void set_algorithm(const base &);
        base_ptr get_algorithm_immune() const;
        void set_algorithm_immune(const base &);

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 & m_original_algo;
                ar & m_original_algo_immune;
                ar & const_cast<int &>(m_gen);
                ar & m_select_method;
                ar & m_inject_method;
                ar & m_distance_method;
                ar & const_cast<double &>(m_phi);
                ar & const_cast<double &>(m_gamma);
                ar & const_cast<double &>(m_sigma);
                ar & const_cast<double &>(m_ftol);
                ar & const_cast<double &>(m_xtol);
        }
        base_ptr m_original_algo;
        base_ptr m_original_algo_immune;
        //Number of generations
        const int m_gen;
        // problem associated to population penalties variables
        select_method_type m_select_method;
        inject_method_type m_inject_method;
        distance_method_type m_distance_method;
        // algorithm constants
        const double m_phi;
        const double m_gamma;
        const double m_sigma;
        // tolerance
        const double m_ftol;
        const double m_xtol;
};

}} //namespaces

BOOST_CLASS_EXPORT_KEY(pagmo::algorithm::cstrs_immune_system)

#endif // PAGMO_ALGORITHM_CSTRS_IMMUNE_SYSTEM_H