FMTPredictor.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 FMTPREDICTOR_H
#define FMTPREDICTOR_H
 
 
#include <vector>
#include <string>
#include <map>
#include "FMTutility.h"
 
 
 
namespace Core
{
    class FMTYields;
    class FMTAction;
}
 
namespace Graph
{
    class FMTBaseVertexProperties;
    class FMTBaseEdgeProperties;
    // DocString: FMTPredictor
    class FMTEXPORT FMTPredictor
    {
    public:
        // DocString: FMTPredictor()
        FMTPredictor();
        // DocString: ~FMTPredictor()
        ~FMTPredictor() = default;
        // DocString: FMTPredictor(...)
        FMTPredictor(const std::vector<Core::FMTAction>& actions, const std::vector<std::string>& yieldnames,const Core::FMTYields& yields,
            const FMTBaseVertexProperties& source, const FMTBaseVertexProperties& target, const std::vector<const FMTBaseEdgeProperties*>& edges, const std::vector<int>& gaps,bool withGCBMid = true);
        // DocString: FMTPredictor(const FMTPredictor&)
        FMTPredictor(const FMTPredictor& rhs);
        // DocString: FMTPredictor::operator=
        FMTPredictor& operator = (const FMTPredictor& rhs);
        // DocString: FMTPredictor::operator==
        bool operator==(const FMTPredictor& rhs) const;
        // DocString: FMTPredictor::operator<
        bool operator<(const FMTPredictor& rhs) const;
        // DocString: FMTPredictor::getPredictors
        std::vector<double>getPredictors() const;
        // DocString: FMTPredictor::getDistance
        double getDistance(size_t actId) const;
        // DocString: FMTPredictor::getDisturbance
        double getDisturbance(size_t actId) const;
        // DocString: FMTPredictor::getSourceAge
        double getSourceAge() const;
        // DocString: FMTPredictor::getSourceYields
        std::vector<double> getSourceYields() const;
        // DocString: FMTPredictor::getTargetAge
        double getTargetAge() const;
        // DocString: FMTPredictor::getTargetYields
        std::vector<double> getTargetYields() const;
        // DocString: FMTPredictor::getPredictorNames
        std::vector<std::string>getPredictorNames(const std::vector<std::string>& yieldnames)const;
    private:
        const FMTBaseVertexProperties* m_source_vertex;
        const FMTBaseVertexProperties* m_target_vertex;
        std::vector<double>m_source_yields;
        std::vector<double>m_target_yields;
        std::vector<int>m_periodgaps;
        std::vector<int>m_sourceactions;
        // DocString: FMTPredictor::_getYields
        std::vector<double>_getYields(const FMTBaseVertexProperties& vertex, const Core::FMTYields& yields, const std::vector<std::string>& yieldnames) const;
    };
}
 
#endif // predictor