migration/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_MIGRATION_BASE_POLICY_H
#define PAGMO_MIGRATION_BASE_POLICY_H

#include <iostream>
#include <string>

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

namespace pagmo {


namespace migration {


enum rate_type
{
        absolute = 0,
        fractional = 1
};


class __PAGMO_VISIBLE base
{
        public:
                base(const double &, rate_type);
                population::size_type get_n_individuals(const population &) const;
                std::string human_readable() const;
                virtual ~base();
        protected:
                virtual std::string human_readable_extra() const;
        protected:

                template <class ForwardIterator, class T>
                static void iota(ForwardIterator first, ForwardIterator last, T value)
                {
                        for (; first != last; ++first, ++value)
                                *first = value;
                }

                double          m_rate;
                rate_type       m_type;
        private:
                friend class boost::serialization::access;
                template <class Archive>
                void serialize(Archive &ar, const unsigned int)
                {
                                ar & m_rate;
                                ar & m_type;
                }
};

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

} }

#endif