FMTlinegraph.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 FMTLINEGRAPH_H
#define FMTLINEGRAPH_H
 
#include "FMTgraph.hpp"
#include <boost/serialization/export.hpp>
 
namespace Spatial
{
    class FMTeventcontainer;
}
 
namespace Graph
{
// DocString: FMTlinegraph
class FMTEXPORT FMTlinegraph : public FMTgraph<FMTbasevertexproperties,FMTbaseedgeproperties>
{
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int version)
    {
        ar & boost::serialization::make_nvp("Graph::FMTgraph<Graph::FMTbasevertexproperties,Graph::FMTbaseedgeproperties>",boost::serialization::base_object<FMTgraph<FMTbasevertexproperties, FMTbaseedgeproperties>>(*this));
 
    }
    // DocString: FMTlinegraph::isanyactionofedge
    bool isanyactionofedge(const FMTbaseedgeproperties& edgeproperty,const std::unordered_set<int>& actions) const;
    // DocString: FMTlinegraph::isanyvertexusage
    bool isanyvertexusage(const FMTbasevertexproperties& vertexproperty, const Core::FMToutputsource& source, const Core::FMTyields& yields) const;
    public:
        // DocString: FMTlinegraph()
        FMTlinegraph();
        // DocString: ~FMTlinegraph()
        ~FMTlinegraph()=default;
        // DocString: FMTlinegraph(const FMTgraphbuild)
        FMTlinegraph(const FMTgraphbuild lbuildtype);
        // DocString: FMTlinegraph(const FMTlinegraph&)
        FMTlinegraph(const FMTlinegraph& rhs);
        // DocString: FMTlinegraph(const FMTgraph<FMTbasevertexproperties, FMTbaseedgeproperties>&)
        FMTlinegraph(const FMTgraph<FMTbasevertexproperties, FMTbaseedgeproperties>& rhs);
        // DocString: FMTlinegraph::operator=
        FMTlinegraph& operator = (const FMTlinegraph& rhs);
        // DocString: FMTlinegraph::operator=
        FMTlinegraph& operator = (const FMTgraph<FMTbasevertexproperties,FMTbaseedgeproperties>& rhs);
        // DocString: FMTlinegraph::newperiod
        //void newperiod();
        // DocString: FMTlinegraph::setaction
        void setaction( FMTvertex_descriptor active,const int& actionID,
                        const std::vector<Core::FMTdevelopmentpath>& paths);
        // DocString: FMTlinegraph::operate
        size_t operate( const Core::FMTaction& action, const int& action_id, const Core::FMTtransition& transition, 
                                                        const Core::FMTyields& ylds, const std::vector<Core::FMTtheme>& themes);
        // DocString: FMTlinegraph::grow
        void grow();
        // DocString: FMTlinegraph::getactivevertex
        FMTvertex_descriptor getactivevertex() const;
        // DocString: FMTlinegraph::getlastactionid
        int getlastactionid(const int& period)const;
        // DocString: FMTlinegraph::getperiodactionids
        std::vector<int> getperiodactionids(const int& period)const;
        // DocString: FMTlinegraph::getperiodpredictors
        std::vector<FMTpredictor>getperiodpredictors(const int& period, const Models::FMTmodel& model, const std::vector<std::string>& yieldnames,bool periodonevalues =false,bool withGCBMid = true) const;
        // DocString: FMTlinegraph::getinedgeactionid
        int getinedgeactionid(const FMTvertex_descriptor& vdesc)const;
        // DocString: FMTlinegraph::getperiodstartdev
        const Core::FMTdevelopment& getperiodstartdev(const int& period) const;
        // DocString: FMTlinegraph::getperiodstopdev
        const Core::FMTdevelopment& getperiodstopdev(const int& period) const;
        // DocString: FMTlinegraph::randomoperate
        int randomoperate(const std::vector<int>& operables, const Models::FMTmodel& model,
                                            FMTvertex_descriptor& front_vertex, std::default_random_engine& generator,
                                            const Core::FMTdevelopment& active_development,bool dontchoosegrow=false);
        // DocString: FMTlinegraph::randombuildperiod
        std::vector<int> randombuildperiod(const Models::FMTmodel& model,std::default_random_engine& generator,
                                    boost::unordered_map<Core::FMTdevelopment, std::vector<int>>& operability,
                                    bool dontchoosegrow=false);
        // DocString: FMTlinegraph::clearfromperiod
        FMTgraphstats clearfromperiod(const int& period,bool updatedevelopments=false);
        // DocString: FMTlinegraph::partialcopy
        FMTlinegraph partialcopy(const int& period) const;
        // DocString: FMTlinegraph::getactions
        std::vector<std::vector<bool>>getactions(const Models::FMTmodel& model,const int& fromperiod,
            std::map<Core::FMTdevelopment, std::vector<bool>>& operability) const;
        // DocString: FMTlinegraph::getbasedevelopment
        const Core::FMTdevelopment& getbasedevelopment() const;
        // DocString: FMTlinegraph::getbasehash
        size_t getbasehash(const Core::FMTmask& dynamicmask) const;
        // DocString:FMTlinegraph::getbasestr
        std::string getbasestr(const Core::FMTmask& dynamicmask) const;
        // DocString: FMTlinegraph::getbasemask
        Core::FMTmask getbasemask(const Core::FMTmask& dynamicmask) const;
        // DocString: FMTlinegraph::getbasemask
        size_t getedgeshash(const int& maximalperiod,bool& gotthewhole) const;
        // DocString: FMTlinegraph::getedgesstr
        std::string getedgesstr(const int& maximalperiod, bool& gotthewhole) const;
        // DocString: FMTlinegraph::filledgesmask
        void filledgesmask(Core::FMTmask& mask, const int& maximalperiod) const;
        // DocString: FMTlinegraph::stringforconstraint
        bool stringforconstraint(std::string& value, const int& stop, const Core::FMTmask& dynamicmask) const;
        // DocString: FMTlinegraph::hashforconstraint
        bool hashforconstraint(size_t& hashvalue,const int& stop,const Core::FMTmask& dynamicmask) const;
        // DocString: FMTlinegraph::isonlygrow
        bool isonlygrow(int period=0) const;
        // DocString:FMTlinegraph::addfromevents
        //void addfromevents(const Spatial::FMTcoordinate& localisation,const Models::FMTmodel& model, Spatial::FMTeventcontainer& events) const;
        // DocString: FMTlinegraph::ismovable
        bool ismovable(const std::vector<const Core::FMTaction*>& actions,
            const Core::FMTyields& yields, const int& period, boost::unordered_map<Core::FMTdevelopment, bool>*operability =nullptr) const;
        // DocString:  FMTlinegraph::operator==
        bool operator == (const FMTlinegraph& rhs) const;
        // DocString:  FMTlinegraph::clearnodecache
        void clearnodecache();
        // DocString:  FMTlinegraph::anyusageof
        std::vector<int> anyusageof(Core::FMToutputnode output_node, const Models::FMTmodel& model, const int& startingperiod) const;
        
        
};
}
 
BOOST_CLASS_EXPORT_KEY(Graph::FMTlinegraph)
 
#endif // FMTLINEGRAPH_H