FMTOptimizationParser.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 FMToptimizationparser_Hm_included
#define FMToptimizationparser_Hm_included
 
#include "FMTParser.h"
#include <algorithm>
#include <vector>
#include <map>
#include <string>
#include <queue>
#include "FMTutility.h"
#include <boost/regex.hpp>
#include <limits>
 
 
namespace Core
{
    class FMTOutput;
    class FMTConstraint;
    class FMTTheme;
    class FMTConstants;
    class FMTPerBounds;
    class FMTYields;
}
 
 
namespace Parser
{
    // DocString: FMToptimizationsection
    enum FMToptimizationsection
        {
        objective = 1,
        exclude = 2,
        constraints = 3,
        format = 4,
        none = 5
        };
 
    // DocString: FMTOptimizationParser
    class FMTEXPORT FMTOptimizationParser : public FMTParser
    {
    public:
        // DocString: FMTOptimizationParser()
        FMTOptimizationParser();
        // DocString: FMTOptimizationParser(const FMTOptimizationParser&)
        FMTOptimizationParser(const FMTOptimizationParser& rhs)=default;
        // DocString: FMTOptimizationParser::operator=
        FMTOptimizationParser& operator = (const FMTOptimizationParser& rhs)=default;
        // DocString: FMTOptimizationParser::read
        std::vector<Core::FMTConstraint> read(const std::vector<Core::FMTTheme>& p_themes,
                  const std::vector<Core::FMTAction>& p_actions,
                  const Core::FMTConstants& p_constants,
                  const std::vector<Core::FMTOutput>& p_outputs,
                  const Core::FMTYields& p_yields,
                  std::vector<Core::FMTAction>& p_excluded,
                  const std::string& pm_location);
        // DocString: FMTOptimizationParser::getConstraints
        std::vector<Core::FMTConstraint> getConstraints(const std::string& pm_line,
            const Core::FMTConstants& p_constants, const Core::FMTYields& p_yields,
            const std::vector<Core::FMTOutput>& p_outputs,
            const std::vector<Core::FMTTheme>& p_themes,
            const std::vector<Core::FMTAction>& p_actions);
        // DocString: FMTOptimizationParser::write
        void write(const std::vector<Core::FMTConstraint>& p_constraints,
            const std::string& pm_location) const;
        // DocString: ~FMTOptimizationParser()
        ~FMTOptimizationParser()=default;
    private:
        const static boost::regex m_rxsections;
        const static boost::regex m_rxobjectives;
        const static boost::regex m_rxexclude;
        const static boost::regex m_rxconstraints;
        const static boost::regex m_rxequations;
        const static boost::regex m_m_ENDing;
        const static boost::regex m_rxoutput;
        const static boost::regex m_rxpenalty;
        const static boost::regex m_rxspecialoutput;
        const static boost::regex m_rxspatial;
        const static boost::regex m_rxspecialobjective;
        const static boost::regex m_rxstartwithoperator;
        //std::queue<std::string>m_ineach;
        // DocString: FMTOptimizationParser::_getObjective
        Core::FMTConstraint _getObjective(const std::string& pm_line,
            const Core::FMTConstants& p_constants,
            const Core::FMTYields& p_yields,
            const std::vector<Core::FMTOutput>& p_outputs,
            const std::vector<Core::FMTTheme>& p_themes);
        // DocString: FMTOptimizationParser::_getSection
        FMToptimizationsection _getSection(const std::string& line) const;
        // DocString: FMTOptimizationParser::_setEnding
        bool _setEnding(Core::FMTConstraint& constraint, std::string& line, const Core::FMTConstants& constants);
        // DocString: FMTOptimizationParser::_resumeOutput
        Core::FMTOutput _resumeOutput(const std::map<std::string, double>& nodes,
            const std::vector<Core::FMTOutput>& outputs,
            const std::vector<Core::FMTTheme>& themes,
            const Core::FMTConstants& constants);
        // DocString: FMTOptimizationParser::_getOptline
        std::queue<FMTParser::FMTLineInfo>_getOptline(std::ifstream& stream, const std::vector<Core::FMTTheme>& themes,
                                const Core::FMTConstants& cons, const std::vector<Core::FMTOutput>& outputs);
        // DocString: FMTOptimizationParser::_getEachLines
        std::queue<std::string> _getEachLines(const std::string& line, const Core::FMTConstants& constants, const std::vector<Core::FMTOutput>& outputs, const std::vector<Core::FMTTheme>& themes) const;
        // DocString: FMTOptimizationParser::_getEquation
        std::map<std::string, double>_getEquation(const std::string& pm_line, const Core::FMTConstants& p_constants,
            const Core::FMTYields& p_yields, const std::vector<Core::FMTOutput>& p_outputs,
            size_t p_lhssize = std::numeric_limits<size_t>::max());
        // DocString: FMTOptimizationParser::_getPeriodsBounds
        std::vector<Core::FMTConstraint> _getPeriodsBounds(std::string periodstr, const Core::FMTConstraint& constraint, const Core::FMTConstants& constants) const;
        // DocString: FMTOptimizationParser::_fillBounds
        void _fillBounds(const std::string& operatorvalue, const double& rhs, double& lower, double& upper) const;
        // DocString: FMTOptimizationParser::_getSpatialConstraint
        Core::FMTConstraint _getSpatialConstraint(const Core::FMTConstraint& p_baseconstraint,
            const boost::smatch& p_match, const std::string& pm_line,
            const Core::FMTConstants& p_constants,
            const Core::FMTYields& p_yields,
            const std::vector<Core::FMTAction>& p_actions,
            const std::vector<Core::FMTOutput>& p_outputs,
            const std::vector<Core::FMTTheme>& p_themes);
        // DocString: FMTOptimizationParser::_getReplicateChanges
        std::vector<std::vector<double>>_getReplicateChanges(const std::string& replicateargument);
    };
}
 
#endif