FMTOperatingAreaClusterer.h

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.h"
#include "FMTOperatingAreaCluster.h"
#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_Hm_included
#define FMToperatingareaclusterer_Hm_included
namespace Heuristics
{
// DocString: FMTOperatingAreaClusterer
class FMTEXPORT FMTOperatingAreaClusterer : public FMTLpHeuristic
    {
    public:
        // DocString: FMTOperatingAreaClusterer::FMTOperatingAreaClusterer()
        FMTOperatingAreaClusterer() = default;
        // DocString: FMTOperatingAreaClusterer::FMTOperatingAreaClusterer(const Models::FMTSolverInterface&,const size_t&,const std::vector<FMTOperatingAreaCluster>&)
        FMTOperatingAreaClusterer(const Models::FMTSolverInterface& p_interfacetype,
            const size_t& p_seed,const std::vector<FMTOperatingAreaCluster>& p_clusters,
            int p_minimalnumberofclusters = -1,int p_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();
 
    private:
    friend class boost::serialization::access;
        // DocString: FMTOperatingAreaClusterer::serialize
        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::make_nvp("clusters", m_clusters);
            ar & boost::serialization::make_nvp("numberofsimulationpass", m_numberofsimulationpass);
 
        }
    // DocString: FMTOperatingAreaClusterer::m_clusters
    std::vector<FMTOperatingAreaCluster>m_clusters;
    // DocString: FMTOperatingAreaClusterer::m_numberofsimulationpass
    int m_numberofsimulationpass;
    // DocString: FMTOperatingAreaClusterer::m_minimalnumberofclusters
    int m_minimalnumberofclusters;
    // DocString: FMTOperatingAreaClusterer::m_maximalnumberofclusters
    int m_maximalnumberofclusters;
    // DocString: FMTOperatingAreaClusterer::m_totalarea
    double m_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 m_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::_addForcingRows
        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;
    };
}
 
BOOST_CLASS_EXPORT_KEY(Heuristics::FMTOperatingAreaClusterer)
 
 
#endif
#endif