FMTModelParameters.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
*/
 
#ifndef FMTmodelparameters_Hm_included
#define FMTmodelparameters_Hm_included
 
#include "FMTExceptionHandler.h"
#include "FMTObject.h"
#include <boost/serialization/export.hpp>
#include <boost/serialization/array.hpp>
#include <boost/serialization/vector.hpp>
#include <array>
#include <vector>
#include <string>
 
namespace Models
{
    // DocString: FMTintmodelparameters
    //
    enum FMTintmodelparameters
    {
        LENGTH = 0,
        SEED = 1, 
        NUMBER_OF_ITERATIONS = 2,
        PRESOLVE_ITERATIONS = 3,
        NUMBER_OF_THREADS = 4,
        MATRIX_TYPE = 5,
        UPDATE = 6,
        MAX_MOVES = 7,
        MAX_ACCEPTED_CYCLE_MOVES = 8, 
        MAX_CYCLE_MOVES = 9, 
        WARM_UP_ITERATIONS = 10,
        MINIMAL_ACCEPTED_MOVES = 11,
        UPDATE_PERIOD_FACTOR = 12,
        SOLUTION_MERGE_ITERATIONS = 13,
        MAX_NON_ACCEPTED_MOVES_FOR_TABOU = 14,
        TABOU_FLUSH = 15,
        MOVE_SIZE_FACTOR = 16,
        LastIntModelParam = 17
    };
    // DocString: FMTdblmodelparameters
    //
    enum FMTdblmodelparameters
    {
        TOLERANCE = 0,
        GOALING_SCHEDULE_WEIGHT = 1,
        INITIAL_ACCEPTANCE_PROBABILITY = 2,
        ANNEALING_RATE = 3,
        LastDblModelParam = 4
    };
    // DocString: FMTboolmodelparameters
    //
    enum FMTboolmodelparameters
    {
        FORCE_PARTIAL_BUILD = 0,
        STRICTLY_POSITIVE = 1,
        POSTSOLVE = 2,
        SHOW_LOCK_IN_SCHEDULES = 3,//Not needed or change parameters in fonctions ... maybe more for task
        PRESOLVE_CAN_REMOVE_STATIC_THEMES =4,//The preSolve will allow the removing of static themes even in use (it can alter the area section).
        DEBUG_MATRIX = 5,//If true, when an error occur in lpmodel initialSolve or resolve, the matrix will be written. 
        SETSOLUTION_THROW = 6, //Fix pour setSolution pour ne pas throw lorsque c'est vrai TODO meilleur def
        QUIET_LOGGING = 7,
        LastBoolModelParam = 8
    };
    // DocString: FMTstrmodelparameters
    //
    enum FMTstrmodelparameters
    {
        SOLVER_COLD_START = 0,/*Cold start parameters located in scenario folder*<  */
        SOLVER_WARM_START = 1,/*Warm start parameters location in scenario folder*<  */
        WORKING_DIRECTORY = 2,/*SA working directory*<  */
        LastStrModelParam = 3
    };
 
 
    // DocString: FMTModelParameters
    class FMTEXPORT FMTModelParameters : public Core::FMTObject
    {
        public:
            // DocString: FMTModelParameters()
            FMTModelParameters();
            // DocString: FMTModelParameters(const FMTModelParameters&)
            FMTModelParameters(const FMTModelParameters& rhs);
            // DocString: FMTModelParameters::operator=(const FMTModelParameters&)
            FMTModelParameters& operator = (const FMTModelParameters& rhs); 
            // DocString: ~FMTModelParameters
            ~FMTModelParameters()=default;
            // DocString: FMTModelParameters(FMTModelParameters&&)
            FMTModelParameters(FMTModelParameters&& rhs)=default;
            // DocString: FMTModelParameters::operator=(FMTModelParameters&& rhs) 
            FMTModelParameters& operator =(FMTModelParameters&& rhs) =default;
            // DocString: FMTModelParameters::swap(FMTModelParameters& rhs)
            void swap(FMTModelParameters& rhs);
            //###Setter
            // DocString: FMTModelParameters::setIntParameter
            bool setIntParameter(FMTintmodelparameters key,const int& value);
            // DocString: FMTModelParameters::setDblParameter
            bool setDblParameter(FMTdblmodelparameters key,const double& value);
            // DocString: FMTModelParameters::setBoolParameter
            bool setBoolParameter(FMTboolmodelparameters key,const bool& value);
            // DocString: FMTModelParameters::setStrParameter
            bool setStrParameter(FMTstrmodelparameters p_key, const std::string& p_value);
            // DocString: FMTModelParameters::setPeriodCompressTime
            bool setPeriodCompressTime(const int& period, const int& value);
            //###Getter
            // DocString: FMTModelParameters::getIntParameter
            int getIntParameter(FMTintmodelparameters key) const;
            // DocString: FMTModelParameters::getDblParameter
            double getDblParameter(FMTdblmodelparameters key) const;
            // DocString: FMTModelParameters::getBoolParameter
            bool getBoolParameter(FMTboolmodelparameters key) const;
            // DocString: FMTModelParameters::getStrParameter
            const std::string& getStrParameter(FMTstrmodelparameters p_key) const;
            // DocString: FMTModelParameters::getPeriodCompressTime
            int getPeriodCompressTime(const int& period)const;
            // DocString: FMTModelParameters::getCompressTime
            std::vector<int> getCompressTime() const;
        private:
            friend class boost::serialization::access;
            // DocString: FMTModelParameters::serialize
            template<class Archive>
            void serialize(Archive& ar, const unsigned int version)
            {
                try {
                    ar& boost::serialization::make_nvp("FMTobject", boost::serialization::base_object<FMTObject>(*this));
                    ar& BOOST_SERIALIZATION_NVP(m_intparameters);
                    ar& BOOST_SERIALIZATION_NVP(m_dblparameters);
                    ar& BOOST_SERIALIZATION_NVP(m_boolparameters);
                    ar& BOOST_SERIALIZATION_NVP(m_compresstime);
                }
                catch (...)
                {
                    _exhandler->printExceptions("", "FMTModelParameters::serialize", __LINE__, __FILE__);
                }
            }
            std::array<int, LastIntModelParam> m_intparameters;
            std::array<double, LastDblModelParam> m_dblparameters;
            std::array<bool, LastBoolModelParam> m_boolparameters;
            std::array<std::string, LastStrModelParam> m_strparameters;
            std::vector<int> m_compresstime;
    };
}
BOOST_CLASS_EXPORT_KEY(Models::FMTModelParameters)
#endif // FMTmodelparameters_Hm_included