hypervolume.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_UTIL_HYPERVOLUME_H
#define PAGMO_UTIL_HYPERVOLUME_H

#include <iostream>
#include <vector>
#include <cmath>
#include "../population.h"
#include "hv_algorithm/base.h"

namespace pagmo { namespace util {

// Forward declaration
class hypervolume;

typedef boost::shared_ptr<hypervolume> hypervolume_ptr;


class __PAGMO_VISIBLE hypervolume
{
public:
        hypervolume();
        hypervolume(const hypervolume &);
        hypervolume(const boost::shared_ptr<population>, const bool verify = true);
        hypervolume(const std::vector<fitness_vector> &, const bool verify = true);

        double compute(const fitness_vector &, const hv_algorithm::base_ptr) const;
        double compute(const fitness_vector &) const;

        double exclusive(const unsigned int, const fitness_vector &, const hv_algorithm::base_ptr) const;
        double exclusive(const unsigned int, const fitness_vector &) const;

        unsigned int least_contributor(const fitness_vector &, const hv_algorithm::base_ptr) const;
        unsigned int least_contributor(const fitness_vector &) const;

        unsigned int greatest_contributor(const fitness_vector &, const hv_algorithm::base_ptr) const;
        unsigned int greatest_contributor(const fitness_vector &) const;

        std::vector<double> contributions(const fitness_vector &, const hv_algorithm::base_ptr) const;
        std::vector<double> contributions(const fitness_vector &) const;

        static double get_expected_operations(const unsigned int n, const unsigned int d);

        void set_copy_points(const bool);
        bool get_copy_points();
        void set_verify(const bool);
        bool get_verify();

        fitness_vector get_nadir_point(const double epsilon = 0.0) const;

        hypervolume_ptr clone() const;
        const std::vector<fitness_vector> get_points() const;

private:
        hv_algorithm::base_ptr get_best_compute(const fitness_vector &) const;
        hv_algorithm::base_ptr get_best_exclusive(const unsigned int, const fitness_vector &) const;
        hv_algorithm::base_ptr get_best_contributions(const fitness_vector &) const;
        void verify_after_construct() const;
        void verify_before_compute(const fitness_vector &, const hv_algorithm::base_ptr) const;

        std::vector<fitness_vector> m_points;
        bool m_copy_points;
        bool m_verify;


        friend class boost::serialization::access;
        template <class Archive>
        void serialize(Archive &ar, const unsigned int)
        {
                ar & m_points;
                ar & m_copy_points;
                ar & m_verify;
        }
};

}}

BOOST_CLASS_EXPORT_KEY(pagmo::util::hypervolume)

#endif