FMToperatingareaclusterer.hpp

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#include "FMTlpheuristic.hpp"
#include "FMToperatingareacluster.hpp"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
#include <boost/serialization/vector.hpp>
#include <vector>
 
#ifdef FMTWITHOSI
 
#ifndef FMToperatingareaclusterer_H_INCLUDED
#define FMToperatingareaclusterer_H_INCLUDED
namespace Heuristics
{
// DocString: FMToperatingareaclusterer
class FMTEXPORT FMToperatingareaclusterer : public FMTlpheuristic
    {
    friend class boost::serialization::access;
        template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
        {
            ar & boost::serialization::make_nvp("FMTlpheuristic", boost::serialization::base_object<FMTlpheuristic>(*this));
            ar & BOOST_SERIALIZATION_NVP(clusters);
            ar & BOOST_SERIALIZATION_NVP(numberofsimulationpass);
 
        }
    // DocString: FMToperatingareaclusterer::clusters
    std::vector<FMToperatingareacluster>clusters;
    // DocString: FMToperatingareaclusterer::numberofsimulationpass
    int numberofsimulationpass;
    // DocString: FMToperatingareaclusterer::minimalnumberofclusters
    int minimalnumberofclusters;
    // DocString: FMToperatingareaclusterer::maximalnumberofclusters
    int maximalnumberofclusters;
    // DocString: FMToperatingareaclusterer::totalarea
    double totalarea;
        // DocString: FMToperatingareaclusterer::getallbinaries
        std::map<Core::FMTmask,std::vector<FMToperatingareaclusterbinary>>getallbinaries() const;
        // DocString: FMToperatingareaclusterer::gettotalarea()
        double calculatetotalarea() const;
        // DocString: FMToperatingareaclusterer::gettotalarea
        inline const double& gettotalarea() const
            {
            return totalarea;
            }
        // DocString: FMToperatingareaclusterer::addmaxminobjective
        void addmaxminobjective(const FMToperatingareacluster& cluster, const FMToperatingareaclusterbinary& binary,
            const std::vector<FMToperatingareaclusterbinary>& binaries,
            const int& clusterid);
        // DocString: FMToperatingareaclusterer::buildclustersvariables
        void buildclustersvariables();
         // DocString: FMToperatingareaclusterer::addobjective
        void addobjective();
         // DocString: FMToperatingareaclusterer::addlinksrows
        void addlinksrows();
        // DocString: FMToperatingareaclusterer::addlinksrows
        void addforcingrows();
        // DocString: FMToperatingareaclusterer::addnumberofclusterrows
        void addnumberofclusterrows();
        // DocString: FMToperatingareaclusterer::addareaconstraints
        void addareaconstraints();
       
        // DocString: FMToperatingareaclusterer::setallinteger
        void setallinteger();
        // DocString: FMToperatingareaclusterer::getspreadprobability
        double getspreadprobability(const std::vector<FMToperatingareaclusterbinary>& incluster,const FMToperatingareaclusterbinary& target) const;
        // DocString: FMToperatingareaclusterer::spread
        bool spread(const FMToperatingareacluster& ignition,std::vector<FMToperatingareaclusterbinary>& assigned);
         // DocString: FMToperatingareaclusterer::gettargetedoperatingareasize
        double gettargetedoperatingareasize(const FMToperatingareacluster& target);
        // DocString: FMToperatingareaclusterer::isvalidarea
        bool isvalidarea(const FMToperatingareacluster& cluster,
            const double& area, const size_t& actives) const;
         // DocString: FMToperatingareaclusterer::unboundall
        void unboundall();
         // DocString: FMToperatingareaclusterer::getbinariesvariables
        std::vector<int>getbinariesvariables() const;
    public:
        // DocString: FMToperatingareaclusterer::FMToperatingareaclusterer()
        FMToperatingareaclusterer() = default;
        // DocString: FMToperatingareaclusterer::FMToperatingareaclusterer(const Models::FMTsolverinterface&,const size_t&,const std::vector<FMToperatingareacluster>&)
        FMToperatingareaclusterer(const Models::FMTsolverinterface& interfacetype,
            const size_t& lseed,const std::vector<FMToperatingareacluster>& lclusters,
            int minimalnumberofclusters = -1,int maximalnumberofclusters = -1);
         // DocString: FMToperatingareaclusterer::FMToperatingareaclusterer(const FMToperatingareaclusterer&)
        FMToperatingareaclusterer(const FMToperatingareaclusterer&);
         // DocString: FMToperatingareaclusterer::operator =
        FMToperatingareaclusterer& operator = (const FMToperatingareaclusterer&) = default;
         // DocString: FMToperatingareaclusterer::setnumberofsimulationpass
        void setnumberofsimulationpass(const int& pass);
         // DocString: FMToperatingareaclusterer::~FMToperatingareaclusterer()
        ~FMToperatingareaclusterer() = default;
        // DocString: FMToperatingareaclusterer::getbinariescount
        size_t getbinariescount() const;
        // DocString: FMToperatingareaclusterer::initialsolve
        bool initialsolve() final;
        // DocString: FMToperatingareaclusterer::branchnboundsolve
        bool branchnboundsolve() final;
         // DocString: FMToperatingareaclusterer::getsolution
        std::vector<FMToperatingareacluster>getsolution() const;
        // DocString: FMToperatingareaclusterer::buildproblem
        void buildproblem();
 
    };
}
 
BOOST_CLASS_EXPORT_KEY(Heuristics::FMToperatingareaclusterer)
 
 
#endif
#endif