FMTsesmodel.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
*/
 
#ifndef FMTSESM_H_INCLUDED
#define FMTSESM_H_INCLUDED
 
#include "FMTsemodel.hpp"
#include <boost/serialization/vector.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/export.hpp>
 
namespace Models
{
// DocString: FMTsesmodel
class FMTEXPORT FMTsesmodel final: public FMTsemodel
    {
    // DocString: FMTsesmodel::Serialize
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
        {
        ar & boost::serialization::make_nvp("semodel", boost::serialization::base_object<FMTsemodel>(*this));
        }
    virtual void swap_ptr(const std::unique_ptr<FMTmodel>& rhs);
    // DocString: FMTsesmodel()
    FMTsesmodel(const FMTsemodel& rhs);
    public:
        // DocString: FMTsesmodel()
        FMTsesmodel();
        // DocString: ~FMTsesmodel()
        ~FMTsesmodel() = default;
        // DocString: FMTsesmodel(const FMTsesmodel)
        FMTsesmodel(const FMTsesmodel& rhs);
        // DocString: FMTsesmodel(const FMTmodel)
        FMTsesmodel(const FMTmodel& rhs);
        // DocString: FMTsesmodel(const FMTmodel)
        FMTsesmodel(const FMTmodel& rhs, const Spatial::FMTforest& forest);
        // DocString: FMTsesmodel::operator=
        FMTsesmodel& operator = (const FMTsesmodel& rhs);
        // DocString: FMTsesmodel(FMTsesmodel&&)
        FMTsesmodel(FMTsesmodel&& rhs)=default;
        // DocString: FMTsesmodel::operator=(FMTsesmodel&& rhs) 
        FMTsesmodel& operator =(FMTsesmodel&& rhs) =default;
        // DocString: FMTsesmodel::getdisturbancestats
        std::string getdisturbancestats() const;
        // DocString: FMTsesmodel::greedyreferencebuild
        std::map<std::string, double> greedyreferencebuild(const Core::FMTschedule& schedule,
            const size_t& randomiterations,
            unsigned int seed = 0,
            double tolerance = FMT_DBL_TOLERANCE);
        // DocString: FMTsesmodel::clone
        virtual std::unique_ptr<FMTmodel>clone() const;
        // DocString: FMTsesmodel::build
        virtual bool build(std::vector<Core::FMTschedule> schedules=std::vector<Core::FMTschedule>());
        // DocString: FMTsesmodel::solve
        virtual bool solve()
        {
            return true;
        }
        // DocString: FMTsesmodel::presolve
        virtual std::unique_ptr<FMTmodel>presolve(std::vector<Core::FMTactualdevelopment> optionaldevelopments = std::vector<Core::FMTactualdevelopment>()) const;
        // DocString: FMTsesmodel::getcopy
        virtual std::unique_ptr<FMTmodel> getcopy(int period = 0) const;
    };
 
}
 
BOOST_CLASS_EXPORT_KEY(Models::FMTsesmodel)
 
#endif // FMTSESM_H_INCLUDED