FMTSolutionTracker.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 FMTSOLUTIONTRACKER_H
#define FMTSOLUTIONTRACKER_H
 
 
#include <map>
#include <vector>
#include <string>
#include <memory>
#include "FMTObject.h"
 
namespace Graph
{
    class FMTLineGraph;
}
 
namespace Core
{
    class FMTConstraint;
}
 
 
namespace Spatial
    {
    class FMTGraphInfo;
    // DocString: FMTSolutionTracker
    class FMTSolutionTracker: public Core::FMTObject
        {
        public:
            // DocString: FMTSolutionTracker(const std::vector<size_t>&,const std::vector<std::vector<size_t>>&,size_t)
            FMTSolutionTracker(const std::vector<size_t>& p_solution,
                const std::vector<std::vector<size_t>>&p_ConstraintsFamilies,
                size_t p_NumberOfFamilies);
            // DocString: FMTSolutionTracker()
            FMTSolutionTracker();
            // DocString: FMTSolutionTracker(const FMTSolutionTracker)
            FMTSolutionTracker(const FMTSolutionTracker& p_rhs) = default;
            // DocString: FMTSolutionTracker::operator=
            FMTSolutionTracker& operator=(const FMTSolutionTracker& p_rhs) = default;
            // DocString: ~FMTSolutionTracker()
            ~FMTSolutionTracker() = default;
            // DocString: FMTSolutionTracker::addToSolution
            void addToSolution(size_t p_family,
                std::map<Graph::FMTLineGraph, FMTGraphInfo>::const_iterator p_NewGraph,
                size_t p_LastGraphId);
            // DocString: FMTSolutionTracker::removeFromSolution
            void removeFromSolution(size_t p_family,
                std::map<Graph::FMTLineGraph, FMTGraphInfo>::const_iterator p_OldGraph);
            // DocString: FMTSolutionTracker::getConstraintsValues
            const std::vector<double>& getConstraintsValues(size_t p_Constraint)const;
            // DocString: FMTSolutionTracker::getNumberOfCells
            size_t getNumberOfCells(size_t p_GraphId) const;
            // DocString: FMTSolutionTracker::size
            size_t size() const;
            // DocString: FMTSolutionTracker::swap
            void swap(FMTSolutionTracker& p_tracker);
            // DocString: FMTSolutionTracker::getNonSpatialCellsCount
            size_t getNonSpatialCellsCount() const;
            // DocString: FMTSolutionTracker::setConstraintValues
            void setConstraintValues(const std::vector<std::vector<double>>& p_constraintValues,
                                const std::vector<std::vector<size_t>>& p_ConstraintsFamilies,
                                    size_t p_NumberOfFamilies);
            // DocString: FMTSolutionTracker::enableTracking
            bool enableTracking();
            // DocString: FMTSolutionTracker::disableTracking
            void disableTracking();
            // DocString: FMTSolutionTracker::isTrackingEnable
            bool isTrackingEnable() const;
        private:
            std::vector<std::vector<double>>m_LastConstraintsEvaluation;
            std::vector<size_t>m_Solution;
            std::vector<std::vector<size_t>>m_ConstraintsFamilies;
            const static size_t m_SOLUTION_RESIZE_FACTOR = 2;
            // DocString: FMTSolutionTracker::_modifySolution
            void _modifySolution(size_t p_family,
                                std::map<Graph::FMTLineGraph, FMTGraphInfo>::const_iterator p_It,
                                double p_sense);
            // DocString: FMTSolutionTracker::_buildConstraintsFamilies
            void _buildConstraintsFamilies(const std::vector<std::vector<size_t>>& p_ConstraintsFamilies,
                                            size_t p_NumberOfFamilies);
        };
}
 
 
#endif