FMToperatingareacluster.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
*/
 
#ifdef FMTWITHOSI
 
#ifndef FMToperatingareacluster_H_INCLUDED
#define FMToperatingareacluster_H_INCLUDED
 
#include "FMToperatingareaclusterbinary.hpp"
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
#include <vector>
 
namespace Heuristics
{
    // DocString: FMToperatingareacluster
    class FMTEXPORT FMToperatingareacluster
    {
        friend class boost::serialization::access;
        // DocString: FMToperatingareacluster:serialize
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & BOOST_SERIALIZATION_NVP(maxvar);
            ar & BOOST_SERIALIZATION_NVP(minvar);
            ar & BOOST_SERIALIZATION_NVP(minimalarea);
            ar & BOOST_SERIALIZATION_NVP(maximalarea);
            ar & BOOST_SERIALIZATION_NVP(binaries);
            ar & BOOST_SERIALIZATION_NVP(centroid);
        }
        // DocString: FMToperatingareacluster::maxvar
        int maxvar;
        // DocString: FMToperatingareacluster::minvar
        int minvar;
        // DocString: FMToperatingareacluster::minimalarea
        double minimalarea;
        // DocString: FMToperatingareacluster::maximalarea
        double maximalarea;
        // DocString: FMToperatingareacluster::binaries
        std::vector<FMToperatingareaclusterbinary>binaries;
        // DocString: FMToperatingareacluster::centroid
        FMToperatingareaclusterbinary centroid;
    public:
        // DocString: FMToperatingareacluster::FMToperatingareacluster()
        FMToperatingareacluster() = default;
        // DocString: FMToperatingareacluster::FMToperatingareacluster(const FMToperatingareaclusterbinary&,const std::vector<FMToperatingareaclusterbinary>&)
        FMToperatingareacluster(const FMToperatingareaclusterbinary& localcentroid,
                                const std::vector<FMToperatingareaclusterbinary>& neighborsbinaries);
        // DocString: FMToperatingareacluster::FMToperatingareacluster(const FMToperatingareacluster&,const double&,const double&)
        FMToperatingareacluster(const FMToperatingareacluster& basecluster,
                                const double& lminimalarea,
                                const double& lmaximalarea);
        // DocString: FMToperatingareacluster::FMToperatingareacluster(const FMToperatingareacluster&)
        FMToperatingareacluster(const FMToperatingareacluster&) = default;
        // DocString: FMToperatingareacluster::operator=
        FMToperatingareacluster& operator = (const FMToperatingareacluster&) = default;
        // DocString: FMToperatingareacluster::~FMToperatingareacluster()
        ~FMToperatingareacluster() = default;
        // DocString: FMToperatingareacluster::getbinary
        const FMToperatingareaclusterbinary& getbinary(const Core::FMTmask& mask) const;
        // DocString: FMToperatingareacluster::getcentroid
        inline FMToperatingareaclusterbinary getcentroid() const
            {
            return centroid;
            }
        // DocString: FMToperatingareacluster::getbinaries
        inline std::vector<FMToperatingareaclusterbinary> getbinaries() const
            {
            return binaries;
            }
        // DocString: FMToperatingareacluster::getmaximalobjectivevariable
        inline int getmaximalobjectivevariable() const
            {
            return maxvar;
            }
        // DocString: FMToperatingareacluster::getminimalobjectivevariable
        inline int getminimalobjectivevariable() const
            {
            return minvar;
            }
        // DocString: FMToperatingareacluster::getminimalarea
        double getminimalarea() const;
        // DocString: FMToperatingareacluster::getmaximalarea
        double getmaximalarea() const;
        // DocString: FMToperatingareacluster::getmaximalstats
        double getmaximalstats() const;
        // DocString: FMToperatingareacluster::getrealminimalarea
        inline double getrealminimalarea() const
            {
            return minimalarea;
            }
        // DocString: FMToperatingareacluster::getrealmaximalarea
        inline double getrealmaximalarea() const
            {
            return maximalarea;
            }
        // DocString: FMToperatingareacluster::gettotalpotentialarea
        double gettotalpotentialarea() const;
        // DocString: FMToperatingareacluster::isvalidarea
        bool isvalidarea(const double& area) const;
        // DocString: FMToperatingareacluster::setmaximalobjectivevariable
        void setmaximalobjectivevariable(const int& lmaxvar);
        // DocString: FMToperatingareacluster::setminimalobjectivevariable
        void setminimalobjectivevariable(const int& lminvar);
        // DocString: FMToperatingareacluster::setminimalarea
        void setminimalarea(const double& newminimalarea);
        // DocString: FMToperatingareacluster::setmaximalarea
        void setmaximalarea(const double& newmaximalarea);
        // DocString: FMToperatingareacluster::isvalidareabounds
        bool isvalidareabounds() const;
        // DocString: FMToperatingareacluster::getfilteredcluster
        FMToperatingareacluster getfilteredcluster(const Core::FMTmask& filtermask) const;
        // DocString: FMToperatingareacluster::getallmasks
        std::vector<Core::FMTmask>getallmasks() const;
    };
}
 
BOOST_CLASS_EXPORT_KEY(Heuristics::FMToperatingareacluster)
#endif
#endif