FMTYieldModelRandom.h

Go to the documentation of this file.

/*
Copyright (c) 2024 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTyieldmodelRando_Hm_included
#define FMTyieldmodelRando_Hm_included
 
#include "FMTYieldModel.h"
#include <random>
#include <string>
#include <vector>
#include <unordered_map>
 
// DocString: FMTYieldModelRandom
namespace Core
{
    class FMTYieldModelRandom :
        public FMTYieldModel
    {
    public:
        // DocString: FMTYieldModelRandom::FMTYieldModelRandom(const boost::property_tree::ptree&,const std::string&)
        FMTYieldModelRandom(const boost::property_tree::ptree& p_jsonProps, const std::vector<std::string>& p_distribution);
        // DocString: FMTYieldModelRandom::clearRandomYieldsCache
        void clearRandomYieldsCache() override;
        // DocString: FMTYieldModelRandom::predict
        const std::vector<double>predict(const Core::FMTYieldRequest& p_request) const;
        // DocString: FMTYieldModelRandom::preSolve
         std::unique_ptr<FMTYieldModel> preSolve(const FMTMaskFilter& p_filter,
            const std::vector<FMTTheme>& p_newThemes) const;
        // DocString: FMTYieldModelRandom::postSolve
        std::unique_ptr<FMTYieldModel> postSolve(const FMTMaskFilter& p_filter,
            const std::vector<FMTTheme>& p_baseThemes) const;
        // DocString: FMTYieldModelRandom::clone
        std::unique_ptr<FMTYieldModel>clone() const;
        // DocString: FMTYieldModelRandom:: getModelType
        static std::string getModelType();
        // DocString: FMTYieldModelRandom::setModel
        virtual void setModel(Models::FMTModel* p_modelPtr);
    private:
        // DocString: FMTYieldModelRandom::_getNormalizedYields
        std::vector<size_t> _getNormalizedYields(const std::vector<std::string>& p_yields,const Core::FMTYieldRequest& p_request) const;
        // DocString: FMTYieldModelRandom::getYield
        double _getRandomIndex(const std::vector<size_t>& p_distribution) const;
        // DocString: FMTYieldModelRandom::getYield
        void _updateGeneratorAndSeed(const Core::FMTYieldRequest& p_request) const;
        // DocString: FMTYieldModelRandom::m_cache
        mutable std::unordered_map<int,double>m_cache;
        // DocString: FMTYieldModelRandom::m_useCache
        bool m_useCache;
    };
}
 
 
#endif