FMTPatchRules.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 FMTPATCHRULES_m_included
#define FMTPATCHRULES_m_included
 
#include <vector>
#include <set>
#include "FMTObject.h"
 
namespace Core {
    class FMTConstraint;
    class FMTAction;
}
 
 
namespace Spatial
 
{
    class FMTEventContainer;
    class FMTEvent;
    class FMTSpatialGraphs;
    // DocString: FMTPatchRules
    class FMTPatchRules : public Core::FMTObject
    {
    public:
        // DocString: FMTPatchRules()
        FMTPatchRules()=default;
        // DocString: FMTPatchRules(const FMTPatchRules)
        FMTPatchRules(const FMTPatchRules& rhs) = default;
        // DocString: FMTPatchRules::operator=
        FMTPatchRules& operator = (const FMTPatchRules& rhs)=default;
        // DocString: FMTPatchRules::getRules
        static std::vector<FMTPatchRules> 
            getRules(const std::vector<Core::FMTConstraint>& p_constraints,
                    const std::vector<Core::FMTAction>& p_actions);
        // DocString: FMTPatchRules::evaluate
        double evaluate(const FMTEventContainer& p_events, 
                const FMTSpatialGraphs& p_SpatialGraphs) const;
        // DocString: FMTPatchRules::fillTooSmallEvents
        void fillTooSmallEvents(
            std::vector<std::set<FMTEvent>::iterator>& p_SmallEvents,
            FMTEventContainer& p_events) const;
        // DocString: FMTPatchRules::fillTooBigEvents
        void fillTooBigEvents(std::vector<std::set<FMTEvent>::iterator>& p_BigEvents,
            FMTEventContainer& p_events) const;
        // DocString: FMTPatchRules::fillDispersionEvents
        void fillDispersionEvents(std::vector<std::set<FMTEvent>::iterator>& p_Dispersion,
                    FMTEventContainer& p_events, const FMTSpatialGraphs& p_SpatialGraphs) const;
    private:
        // DocString: FMTPatchRules(const std::vector<Core::FMTConstraint>&,const std::vector<Core::FMTAction>&,int)
        FMTPatchRules(const std::vector<Core::FMTConstraint>& p_constraints,
            const std::vector<Core::FMTAction>& p_actions, int p_Id);
        // DocString: FMTPatchRules::_buildPatchRules
        void _buildPatchRules(const std::vector<Core::FMTConstraint>& p_constraints,
            const std::vector<Core::FMTAction>& p_actions, int p_Id);
        // DocString: FMTPatchRules::_getOrderedRules
        static std::vector<std::pair<std::vector<int>,
                        std::pair<int,int>>> _getOrderedRules(const std::vector<Core::FMTConstraint>& p_constraints,
                        const std::vector<Core::FMTAction>& p_actions);
        // DocString: FMTPatchRules::_getBounds
        template <typename U>
        static void _getBounds(double p_lower, double p_upper,
            U& p_NewLower, U& p_NewUpper);
        // DocString: FMTPatchRules::_tooSmall
        bool _tooSmall(const FMTEvent& p_event, size_t& p_cost) const;
        // DocString: FMTPatchRules::_tooBig
        bool _tooBig(const FMTEvent& p_event, size_t& p_cost) const;
        // DocString: FMTPatchRules::_isTooClose
        bool _isTooClose(const FMTEvent& p_event, const FMTEventContainer& p_events, size_t& p_cost) const;
        // DocString: FMTPatchRules::_isSizeUsed
        bool _isSizeUsed() const;
        // DocString: FMTPatchRules::_isAdjacencyUsed
        bool _isAdjacencyUsed() const;
        // DocString: FMTPatchRules::_hasMinimalAdjacency
        bool _hasMinimalAdjacency() const;
        // DocString: FMTPatchRules::_hasMaximalAdjacency
        bool _hasMaximalAdjacency() const;
        // DocString: FMTPatchRules::_isGroupUsed
        bool _isGroupUsed() const;
        // DocString: FMTPatchRules::_evaluateSize
        double _evaluateSize(const FMTEventContainer& p_events) const;
        // DocString: FMTPatchRules::_evaluateAdjacency
        double _evaluateAdjacency(const FMTEventContainer& p_events) const;
        // DocString: FMTPatchRules::_evaluateGroup
        double _evaluateGroup(const FMTEventContainer& p_events,
            const FMTSpatialGraphs& p_SpatialGraphs) const;
        
    
        size_t m_GreenUp;
        size_t m_MinimalAdjacency;
        size_t m_MaximalAdjacency;
        size_t m_MinimalSize;
        size_t m_MaximalSize;
        size_t m_NeighborSize;
        int m_GroupGreenUp;
        int m_MinimalGroupDistance;
        int m_MaximalGroupDistance;
        std::vector<int>m_ActionTargets;
        int m_GroupTheme;
        int m_RulesId;
        int m_MinimalPeriod;
        int m_MaximalPeriod;
    };
 
 
 
}
#endif